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