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