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