| Geant4 Cross Reference |
>> 1 // This code implementation is the intellectual property of
>> 2 // the GEANT4 collaboration.
1 // 3 //
2 // ******************************************* << 4 // By copying, distributing or modifying the Program (or any work
3 // * License and Disclaimer << 5 // based on the Program) you indicate your acceptance of this statement,
4 // * << 6 // and all its terms.
5 // * The Geant4 software is copyright of th << 7 //
6 // * the Geant4 Collaboration. It is provided << 8 // $Id: G4LogicalVolumeStore.hh,v 1.2.2.1 1999/12/07 20:48:09 gunter Exp $
7 // * conditions of the Geant4 Software License << 9 // GEANT4 tag $Name: geant4-01-00 $
8 // * LICENSE and available at http://cern.ch/ << 10 //
9 // * include a list of copyright holders. << 11 // class G4LogicalVolumeStore
10 // * << 12 //
11 // * Neither the authors of this software syst << 13 // Container for all LogicalVolumes, with functionality derived from
12 // * institutes,nor the agencies providing fin << 14 // G4RWTPtrOrderedVector<T>. The class is `singleton', in that only
13 // * work make any representation or warran << 15 // one can exist, and access is facillitated via G4LogicalVolumeStore::GetInstance()
14 // * regarding this software system or assum << 16 //
15 // * use. Please see the license in the file << 17 // All LogicalVolumes should be registered with G4LogicalVolumeStore, and removed on their
16 // * for the full disclaimer and the limitatio << 18 // destruction. Intended principally for UI browser. The underlying
17 // * << 19 // container initially has a capacity of 100.
18 // * This code implementation is the result <<
19 // * technical work of the GEANT4 collaboratio <<
20 // * By using, copying, modifying or distri <<
21 // * any work based on the software) you ag <<
22 // * use in resulting scientific publicati <<
23 // * acceptance of all terms of the Geant4 Sof <<
24 // ******************************************* <<
25 // <<
26 // G4LogicalVolumeStore <<
27 // <<
28 // Class description: <<
29 // <<
30 // Container for all logical volumes, with fun <<
31 // std::vector<T>. The class is a 'singleton', <<
32 // one can exist, and access is provided via t <<
33 // G4LogicalVolumeStore::GetInstance() <<
34 // <<
35 // All logical volumes should be registered wi <<
36 // and removed on their destruction. <<
37 // The underlying container initially has a ca <<
38 // A map indexed by volume names is also recor <<
39 // pointers to volumes with same name are stor <<
40 // 20 //
41 // If much additional functionality is added, 21 // If much additional functionality is added, should consider containment
42 // instead of inheritance for std::vector<T>. << 22 // instead of inheritance for G4RWTPtrOrderedVector<T>
>> 23 //
>> 24 // Class member functions:
>> 25 //
>> 26 // static void Register(G4LogicalVolume* pVolume)
>> 27 // Add the logical volume to the collection
>> 28 // static void DeRegister(G4LogicalVolume* pVolume)
>> 29 // REmove the logical volume from the collection
>> 30 // static G4LogicalVolumeStore* GetInstance()
>> 31 // Get a ptr to the unique G4LogicalVolumeStore, creting it if necessary
>> 32 //
>> 33 // Member functions:
>> 34 //
>> 35 // [as per RWTPtrOrderedvector]
>> 36 //
>> 37 // NOTE: Constructor is protected - creation and subsequent access is via
>> 38 // GetInstance
>> 39 //
>> 40 // Member data:
>> 41 //
>> 42 // static G4LogicalVolumeStore* fgInstance
>> 43 // Ptr to the single G4LogicalVolumeStore
>> 44 //
>> 45 // History:
>> 46 // 10.07.95 P.Kent Initial version
43 47
44 // 10.07.95, P.Kent, G.Cosmo - Initial version << 48 #ifndef G4VLOGICALVOLUMESTORE_HH
45 // ------------------------------------------- << 49 #define G4VLOGICALVOLUMESTORE_HH
46 #ifndef G4LOGICALVOLUMESTORE_HH <<
47 #define G4LOGICALVOLUMESTORE_HH 1 <<
48 50
49 #include <vector> << 51 #include "g4rw/tpordvec.h"
50 #include <map> <<
51 52
52 #include "G4LogicalVolume.hh" 53 #include "G4LogicalVolume.hh"
53 #include "G4VStoreNotifier.hh" <<
54 54
55 class G4LogicalVolumeStore : public std::vecto << 55 class G4LogicalVolumeStore : public G4RWTPtrOrderedVector<G4LogicalVolume>
56 { 56 {
57 public: 57 public:
58 <<
59 static void Register(G4LogicalVolume* pVol 58 static void Register(G4LogicalVolume* pVolume);
60 // Add the logical volume to the collect <<
61 static void DeRegister(G4LogicalVolume* pV 59 static void DeRegister(G4LogicalVolume* pVolume);
62 // Remove the logical volume from the co <<
63 static G4LogicalVolumeStore* GetInstance() 60 static G4LogicalVolumeStore* GetInstance();
64 // Get a ptr to the unique G4LogicalVolu <<
65 static void SetNotifier(G4VStoreNotifier* <<
66 // Assign a notifier for allocation/deal <<
67 static void Clean(); <<
68 // Delete all volumes from the store. <<
69 <<
70 G4LogicalVolume* GetVolume(const G4String& <<
71 G4bool reverseSearch=false) <<
72 // Return the pointer of the first or la <<
73 // that name. Uses the internal map for <<
74 // a volume in the collection is not uni <<
75 <<
76 inline G4bool IsMapValid() const { return <<
77 inline void SetMapValid(G4bool val) { mva <<
78 // Accessor to assess validity of the in <<
79 inline const std::map<G4String, <<
80 std::vector<G4LogicalVolume*> >& G <<
81 // Return the internal map. <<
82 void UpdateMap(); <<
83 // Bring contents of internal map up to <<
84 <<
85 virtual ~G4LogicalVolumeStore(); 61 virtual ~G4LogicalVolumeStore();
86 // Destructor: takes care to delete allo <<
87 <<
88 G4LogicalVolumeStore(const G4LogicalVolume <<
89 G4LogicalVolumeStore& operator=(const G4Lo <<
90 // Forbidden copy constructor and assign <<
91 <<
92 protected: 62 protected:
93 <<
94 G4LogicalVolumeStore(); 63 G4LogicalVolumeStore();
95 <<
96 private: 64 private:
97 <<
98 static G4LogicalVolumeStore* fgInstance; 65 static G4LogicalVolumeStore* fgInstance;
99 static G4ThreadLocal G4VStoreNotifier* fgN <<
100 static G4ThreadLocal G4bool locked; <<
101 <<
102 std::map<G4String, std::vector<G4LogicalVo <<
103 G4bool mvalid = false; // Flag to indicat <<
104 }; 66 };
105 67
106 #endif 68 #endif
107 69