| Geant4 Cross Reference |
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 // G4LogicalVolumeStore
27 //
28 // Class description:
29 //
30 // Container for all logical volumes, with functionality derived from
31 // std::vector<T>. The class is a 'singleton', in that only
32 // one can exist, and access is provided via the static function
33 // G4LogicalVolumeStore::GetInstance()
34 //
35 // All logical volumes should be registered with G4LogicalVolumeStore,
36 // and removed on their destruction.
37 // The underlying container initially has a capacity of 100.
38 // A map indexed by volume names is also recorded for fast search;
39 // pointers to volumes with same name are stored in buckets.
40 //
41 // If much additional functionality is added, should consider containment
42 // instead of inheritance for std::vector<T>.
43
44 // 10.07.95, P.Kent, G.Cosmo - Initial version
45 // --------------------------------------------------------------------
46 #ifndef G4LOGICALVOLUMESTORE_HH
47 #define G4LOGICALVOLUMESTORE_HH 1
48
49 #include <vector>
50 #include <map>
51
52 #include "G4LogicalVolume.hh"
53 #include "G4VStoreNotifier.hh"
54
55 class G4LogicalVolumeStore : public std::vector<G4LogicalVolume*>
56 {
57 public:
58
59 static void Register(G4LogicalVolume* pVolume);
60 // Add the logical volume to the collection.
61 static void DeRegister(G4LogicalVolume* pVolume);
62 // Remove the logical volume from the collection.
63 static G4LogicalVolumeStore* GetInstance();
64 // Get a ptr to the unique G4LogicalVolumeStore, creating it if necessary.
65 static void SetNotifier(G4VStoreNotifier* pNotifier);
66 // Assign a notifier for allocation/deallocation of the logical volumes.
67 static void Clean();
68 // Delete all volumes from the store.
69
70 G4LogicalVolume* GetVolume(const G4String& name, G4bool verbose=true,
71 G4bool reverseSearch=false) const;
72 // Return the pointer of the first or last volume in the collection having
73 // that name. Uses the internal map for fast search and warns if
74 // a volume in the collection is not unique or not found.
75
76 inline G4bool IsMapValid() const { return mvalid; }
77 inline void SetMapValid(G4bool val) { mvalid = val; }
78 // Accessor to assess validity of the internal map.
79 inline const std::map<G4String,
80 std::vector<G4LogicalVolume*> >& GetMap() const { return bmap; }
81 // Return the internal map.
82 void UpdateMap();
83 // Bring contents of internal map up to date and resets validity flag.
84
85 virtual ~G4LogicalVolumeStore();
86 // Destructor: takes care to delete allocated logical volumes.
87
88 G4LogicalVolumeStore(const G4LogicalVolumeStore&) = delete;
89 G4LogicalVolumeStore& operator=(const G4LogicalVolumeStore&) = delete;
90 // Forbidden copy constructor and assignment operator
91
92 protected:
93
94 G4LogicalVolumeStore();
95
96 private:
97
98 static G4LogicalVolumeStore* fgInstance;
99 static G4ThreadLocal G4VStoreNotifier* fgNotifier;
100 static G4ThreadLocal G4bool locked;
101
102 std::map<G4String, std::vector<G4LogicalVolume*> > bmap;
103 G4bool mvalid = false; // Flag to indicate if map is up to date or not
104 };
105
106 #endif
107