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