source: trunk/examples/advanced/radiation_monitor/detector/include/RadmonDetectorLayout.hh @ 1288

Last change on this file since 1288 was 807, checked in by garnier, 16 years ago

update
File size: 9.2 KB
Line 
1//
2// ********************************************************************
3// * License and Disclaimer                                           *
4// *                                                                  *
5// * The  Geant4 software  is  copyright of the Copyright Holders  of *
6// * the Geant4 Collaboration.  It is provided  under  the terms  and *
7// * conditions of the Geant4 Software License,  included in the file *
8// * LICENSE and available at  http://cern.ch/geant4/license .  These *
9// * include a list of copyright holders.                             *
10// *                                                                  *
11// * Neither the authors of this software system, nor their employing *
12// * institutes,nor the agencies providing financial support for this *
13// * work  make  any representation or  warranty, express or implied, *
14// * regarding  this  software system or assume any liability for its *
15// * use.  Please see the license in the file  LICENSE  and URL above *
16// * for the full disclaimer and the limitation of liability.         *
17// *                                                                  *
18// * This  code  implementation is the result of  the  scientific and *
19// * technical work of the GEANT4 collaboration.                      *
20// * By using,  copying,  modifying or  distributing the software (or *
21// * any work based  on the software)  you  agree  to acknowledge its *
22// * use  in  resulting  scientific  publications,  and indicate your *
23// * acceptance of all terms of the Geant4 Software license.          *
24// ********************************************************************
25//
26//
27// File name:     RadmonDetectorLayout.hh
28// Creation date: Sep 2005
29// Main author:   Riccardo Capra <capra@ge.infn.it>
30//
31// Id:            $Id: RadmonDetectorLayout.hh,v 1.4.2.2 2006/06/29 16:10:37 gunter Exp $
32// Tag:           $Name: geant4-09-01-patch-02 $
33//
34// Description:   Class to keep track of the configured detector layout
35//
36
37#ifndef   RADMONDETECTORLAYOUT_HH
38 #define  RADMONDETECTORLAYOUT_HH
39 
40 // Include files
41 #include "RadmonVDetectorLayout.hh"
42
43 #include "RadmonDetectorEnvironmentLayout.hh"
44 #include "RadmonDetectorMultilayersLayoutCollection.hh"
45 #include "RadmonDetectorMultilayerPlacementsLayoutCollection.hh"
46 
47 class RadmonDetectorLayout : public RadmonVDetectorLayout
48 {
49  public:
50                                                RadmonDetectorLayout();
51                                               ~RadmonDetectorLayout();
52
53   virtual void                                 EnableEnvironment(void);
54   virtual void                                 DisableEnvironment(void);
55   virtual G4bool                               IsEnabledEnvironment(void) const;
56
57   virtual void                                 SetEnvironmentType(const G4String & type);
58   virtual const G4String &                     GetEnvironmentType() const;
59   virtual G4int                                GetEnvironmentNAttributes(void) const;
60   virtual const G4String &                     GetEnvironmentAttributeName(G4int index) const;
61   virtual void                                 SetEnvironmentAttribute(const G4String & attributeName, const G4String & attributeValue);
62   virtual const G4String                       GetEnvironmentAttribute(const G4String & attributeName, const G4String & defaultAttributeValue) const;
63   virtual void                                 ClearEnvironmentAttribute(const G4String & attributeName);
64
65   virtual void                                 CreateMultilayer(const G4String & multilayerLabel);
66   virtual void                                 RemoveMultilayer(const G4String & multilayerLabel);
67   virtual void                                 SetMultilayerWidth(const G4String & multilayerLabel, G4double width);
68   virtual G4double                             GetMultilayerWidth(const G4String & multilayerLabel) const;
69   virtual void                                 SetMultilayerHeight(const G4String & multilayerLabel, G4double height);
70   virtual G4double                             GetMultilayerHeight(const G4String & multilayerLabel) const;
71   virtual G4double                             GetMultilayerTotalThickness(const G4String & multilayerLabel) const;
72
73   virtual void                                 AppendLayerToMultilayer(const G4String & multilayerLabel, const G4String & layerLabel);
74   virtual void                                 RemoveLayerFromMultilayer(const G4String & multilayerLabel, const G4String & layerLabel);
75   virtual void                                 RemoveAllLayersFromMultilayer(const G4String & multilayerLabel);
76   virtual G4int                                GetMultilayerNLayers(const G4String & multilayerLabel) const;
77   virtual const G4String &                     GetMultilayerLayerLabel(const G4String & multilayerLabel, G4int index) const;
78
79   virtual void                                 SetLayerThickness(const G4String & multilayerLabel, const G4String & layerLabel, G4double thickness);
80   virtual G4double                             GetLayerThickness(const G4String & multilayerLabel, const G4String & layerLabel) const;
81   virtual void                                 SetLayerType(const G4String & multilayerLabel, const G4String & layerLabel, const G4String & type);
82   virtual const G4String &                     GetLayerType(const G4String & multilayerLabel, const G4String & layerLabel) const;
83
84   virtual G4int                                GetLayerNAttributes(const G4String & multilayerLabel, const G4String & layerLabel) const;
85   virtual const G4String &                     GetLayerAttributeName(const G4String & multilayerLabel, const G4String & layerLabel, G4int index) const;
86   virtual void                                 SetLayerAttribute(const G4String & multilayerLabel, const G4String & layerLabel, const G4String & attributeName, const G4String & attributeValue);
87   virtual const G4String                       GetLayerAttribute(const G4String & multilayerLabel, const G4String & layerLabel, const G4String & attributeName, const G4String & defaultAttributeValue) const;
88   virtual void                                 ClearLayerAttribute(const G4String & multilayerLabel, const G4String & layerLabel, const G4String & attributeName);
89
90   virtual void                                 CreatePlacement(const G4String & placementLabel, const G4String & multilayerName);
91   virtual G4int                                GetNPlacements() const;
92   virtual const G4String &                     GetPlacementLabel(G4int index) const;
93   virtual void                                 RemovePlacement(const G4String & placementLabel);
94
95   virtual const G4String &                     GetPlacementMultilayerType(const G4String & placementLabel) const;
96   virtual void                                 SetPlacementPosition(const G4String & placementLabel, const G4ThreeVector & position);
97   virtual const G4ThreeVector &                GetPlacementPosition(const G4String & placementLabel) const;
98   virtual void                                 SetPlacementPosition(const G4String & placementLabel, const G4String & originLabel, const G4ThreeVector & offset);
99   virtual void                                 SetPlacementRotation(const G4String & placementLabel, const G4RotationMatrix & rotation);
100   virtual const G4RotationMatrix &             GetPlacementRotation(const G4String & placementLabel) const;
101   virtual void                                 SetPlacementRotation(const G4String & placementLabel, const G4String & originLabel, const G4RotationMatrix & relativeRotation);
102
103   virtual void                                 DumpLayout(std::ostream & out) const;
104
105   virtual G4bool                               Load(std::istream & in);
106   virtual G4bool                               Save(std::ostream & out) const;
107
108
109  private:
110   inline bool                                  IsPlaced(const G4String & multilayerLabel);
111   inline RadmonDetectorMultilayerLayout *      FindMultilayer(const G4String & multilayerLabel);
112   inline const RadmonDetectorMultilayerLayout *FindMultilayer(const G4String & multilayerLabel) const;
113   inline RadmonDetectorMultilayerPlacementLayout * FindPlacement(const G4String & placementLabel);
114   inline const RadmonDetectorMultilayerPlacementLayout *FindPlacement(const G4String & placementLabel) const;
115   inline RadmonDetectorLayerLayout *           FindLayer(const G4String & multilayerLabel, const G4String & layerLabel);
116   inline const RadmonDetectorLayerLayout *     FindLayer(const G4String & multilayerLabel, const G4String & layerLabel) const;
117
118   inline G4String &                            GetNullStr() const;
119   inline G4ThreeVector &                       GetNullPosition() const;
120   inline G4RotationMatrix &                    GetNullRotationMatrix() const;
121
122  // Hidden constructors and operators
123                                                RadmonDetectorLayout(const RadmonDetectorLayout & copy);
124   RadmonDetectorLayout &                       operator=(const RadmonDetectorLayout & copy);
125
126  // Private attributes
127   RadmonDetectorMultilayerPlacementsLayoutCollection multilayerPlacementsCollection;
128   RadmonDetectorMultilayersLayoutCollection    multilayersCollection;
129   RadmonDetectorEnvironmentLayout              environment;
130 };
131#endif /* RADMONDETECTORLAYOUT_HH */
Note: See TracBrowser for help on using the repository browser.