| 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 // G4RegionStore << 26 //
>> 27 // $Id: G4RegionStore.hh 103096 2017-03-15 15:21:33Z gcosmo $
>> 28 //
>> 29 // class G4RegionStore
27 // 30 //
28 // Class description: 31 // Class description:
29 // 32 //
30 // Container for all regions, with functionali << 33 // Container for all regiong, 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 // G4RegionStore::GetInstance(). 36 // G4RegionStore::GetInstance().
34 // 37 //
35 // All regions should be registered with G4Reg 38 // All regions should be registered with G4RegionStore, and removed on their
36 // destruction. The underlying container initi 39 // destruction. The underlying container initially has a capacity of 20.
37 // A map indexed by volume names is also recor <<
38 // pointers to regions with same name are stor <<
39 // 40 //
40 // If much additional functionality is added, 41 // If much additional functionality is added, should consider containment
41 // instead of inheritance for std::vector<T>. << 42 // instead of inheritance for std::vector<T>
>> 43 //
>> 44 // Member data:
>> 45 //
>> 46 // static G4RegionStore*
>> 47 // - Pointer to the single G4RegionStore
42 48
43 // 18.09.02, G.Cosmo - Initial version << 49 // History:
>> 50 // 18.09.02 G.Cosmo Initial version
44 // ------------------------------------------- 51 // --------------------------------------------------------------------
45 #ifndef G4REGIONSTORE_HH 52 #ifndef G4REGIONSTORE_HH
46 #define G4REGIONSTORE_HH 1 << 53 #define G4REGIONSTORE_HH
47 54
48 #include <vector> 55 #include <vector>
49 #include <map> <<
50 <<
51 #include "G4Types.hh" 56 #include "G4Types.hh"
52 #include "G4String.hh" 57 #include "G4String.hh"
53 #include "G4VStoreNotifier.hh" 58 #include "G4VStoreNotifier.hh"
54 59
55 class G4Region; 60 class G4Region;
56 class G4VPhysicalVolume; 61 class G4VPhysicalVolume;
57 62
58 class G4RegionStore : public std::vector<G4Reg 63 class G4RegionStore : public std::vector<G4Region*>
59 { 64 {
60 public: << 65 public: // with description
61 66
62 static void Register(G4Region* pRegion); 67 static void Register(G4Region* pRegion);
63 // Add the region to the collection. 68 // Add the region to the collection.
64 static void DeRegister(G4Region* pRegion); 69 static void DeRegister(G4Region* pRegion);
65 // Remove the region from the collection 70 // Remove the region from the collection.
66 static G4RegionStore* GetInstance(); 71 static G4RegionStore* GetInstance();
67 // Get a ptr to the unique G4RegionStore 72 // Get a ptr to the unique G4RegionStore, creating it if necessary.
68 static void SetNotifier(G4VStoreNotifier* 73 static void SetNotifier(G4VStoreNotifier* pNotifier);
69 // Assign a notifier for allocation/deal 74 // Assign a notifier for allocation/deallocation of regions.
70 static void Clean(); 75 static void Clean();
71 // Delete all regions from the store exc 76 // Delete all regions from the store except for the world region.
72 77
73 G4bool IsModified() const; 78 G4bool IsModified() const;
74 // Loops through all regions to verify i 79 // Loops through all regions to verify if a region has been
75 // modified. It returns TRUE if just one 80 // modified. It returns TRUE if just one region is modified.
76 void ResetRegionModified(); 81 void ResetRegionModified();
77 // Loops through all regions to reset fl 82 // Loops through all regions to reset flag for modification
78 // to FALSE. Used by the run manager to 83 // to FALSE. Used by the run manager to notify that the
79 // physics table has been updated. 84 // physics table has been updated.
80 85
81 void UpdateMaterialList(G4VPhysicalVolume* << 86 void UpdateMaterialList(G4VPhysicalVolume* currentWorld=0);
82 // Forces recomputation of material list 87 // Forces recomputation of material lists in all regions
83 // in the store. 88 // in the store.
84 89
85 G4Region* GetRegion(const G4String& name, << 90 G4Region* GetRegion(const G4String& name, G4bool verbose=true) const;
86 // Returns a region through its name spe << 91 // Returns a region through its name specification.
87 // map for fast search and warns if a re <<
88 // unique or not found. <<
89 <<
90 inline G4bool IsMapValid() const { return <<
91 inline void SetMapValid(G4bool val) { mva <<
92 // Accessor to assess validity of the in <<
93 inline const std::map<G4String, <<
94 std::vector<G4Region*> >& GetMap() <<
95 // Return the internal map. <<
96 void UpdateMap(); <<
97 // Bring contents of internal map up to <<
98 92
99 G4Region* FindOrCreateRegion(const G4Strin 93 G4Region* FindOrCreateRegion(const G4String& name);
100 // Returns a region through its name spe 94 // Returns a region through its name specification, if it exists.
101 // If it does not exist it will allocate 95 // If it does not exist it will allocate one delegating ownership
102 // to the client. 96 // to the client.
103 97
>> 98 public: // without description
>> 99
104 void SetWorldVolume(); 100 void SetWorldVolume();
105 // Set a world volume pointer to a regio 101 // Set a world volume pointer to a region that belongs to it.
106 // Scan over all world volumes. 102 // Scan over all world volumes.
107 // This method should be exclusively use 103 // This method should be exclusively used by G4RunManagerKernel.
108 104
109 virtual ~G4RegionStore(); <<
110 // Destructor: takes care to delete allo <<
111 <<
112 G4RegionStore(const G4RegionStore&) = dele <<
113 G4RegionStore& operator=(const G4RegionSto <<
114 // Forbidden copy constructor and assign <<
115 <<
116 protected: 105 protected:
117 106
118 G4RegionStore(); 107 G4RegionStore();
119 // Protected singleton constructor. 108 // Protected singleton constructor.
>> 109 virtual ~G4RegionStore();
>> 110 // Destructor: takes care to delete allocated regions.
120 111
121 private: 112 private:
122 113
123 static G4RegionStore* fgInstance; 114 static G4RegionStore* fgInstance;
124 static G4ThreadLocal G4VStoreNotifier* fgN 115 static G4ThreadLocal G4VStoreNotifier* fgNotifier;
125 static G4ThreadLocal G4bool locked; 116 static G4ThreadLocal G4bool locked;
126 <<
127 std::map<G4String, std::vector<G4Region*> <<
128 G4bool mvalid = false; // Flag to indicat <<
129 }; 117 };
130 118
131 #endif 119 #endif
132 120