| 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 // G4AssemblyStore << 26 //
>> 27 // class G4AssemblyStore
27 // 28 //
28 // Class description: 29 // Class description:
29 // 30 //
30 // Container for all assemblies, with function 31 // Container for all assemblies, with functionality derived from
31 // std::vector<T>. The class is a `singleton', 32 // std::vector<T>. The class is a `singleton', in that only
32 // one can exist, and access is provided via t 33 // one can exist, and access is provided via the static method
33 // G4AssemblyStore::GetInstance(). 34 // G4AssemblyStore::GetInstance().
34 // 35 //
35 // All assemblies should be registered with G4 36 // All assemblies should be registered with G4AssemblyStore, and removed on
36 // their destruction. The underlying container 37 // their destruction. The underlying container initially has a capacity of 20.
37 // 38 //
38 // If much additional functionality is added, 39 // If much additional functionality is added, should consider containment
39 // instead of inheritance for std::vector<T>. << 40 // instead of inheritance for std::vector<T>
>> 41 //
>> 42 // Member data:
>> 43 //
>> 44 // static G4AssemblyStore*
>> 45 // - Pointer to the single G4AssemblyStore
40 46
41 // 9.10.2018 G.Cosmo - Initial version << 47 // History:
>> 48 // 9.10.18 G.Cosmo Initial version
42 // ------------------------------------------- 49 // --------------------------------------------------------------------
43 #ifndef G4ASSEMBLYSTORE_HH 50 #ifndef G4ASSEMBLYSTORE_HH
44 #define G4ASSEMBLYSTORE_HH 51 #define G4ASSEMBLYSTORE_HH
45 52
46 #include <vector> 53 #include <vector>
47 #include "G4Types.hh" 54 #include "G4Types.hh"
48 #include "G4String.hh" 55 #include "G4String.hh"
49 #include "G4VStoreNotifier.hh" 56 #include "G4VStoreNotifier.hh"
50 57
51 class G4AssemblyVolume; 58 class G4AssemblyVolume;
52 59
53 class G4AssemblyStore : public std::vector<G4A 60 class G4AssemblyStore : public std::vector<G4AssemblyVolume*>
54 { 61 {
55 public: << 62 public: // with description
56 63
57 static void Register(G4AssemblyVolume* pAs 64 static void Register(G4AssemblyVolume* pAssembly);
58 // Add the assembly to the collection. 65 // Add the assembly to the collection.
59 static void DeRegister(G4AssemblyVolume* p 66 static void DeRegister(G4AssemblyVolume* pAssembly);
60 // Remove the assembly from the collecti 67 // Remove the assembly from the collection.
61 static G4AssemblyStore* GetInstance(); 68 static G4AssemblyStore* GetInstance();
62 // Get a ptr to the unique G4AssemblySto 69 // Get a ptr to the unique G4AssemblyStore, creating it if necessary.
63 static void SetNotifier(G4VStoreNotifier* 70 static void SetNotifier(G4VStoreNotifier* pNotifier);
64 // Assign a notifier for allocation/deal 71 // Assign a notifier for allocation/deallocation of assemblies.
65 static void Clean(); 72 static void Clean();
66 // Delete all assemblies from the store. 73 // Delete all assemblies from the store.
67 74
68 G4AssemblyVolume* GetAssembly(unsigned int << 75 G4AssemblyVolume* GetAssembly(unsigned int Id, G4bool verbose=true) const;
69 // Returns an assembly through its Id nu 76 // Returns an assembly through its Id number specification.
70 77
71 protected: 78 protected:
72 79
73 G4AssemblyStore(); 80 G4AssemblyStore();
74 // Protected singleton constructor. 81 // Protected singleton constructor.
75 virtual ~G4AssemblyStore(); 82 virtual ~G4AssemblyStore();
76 // Destructor: takes care to delete allo 83 // Destructor: takes care to delete allocated assemblies.
77 84
78 private: 85 private:
79 86
80 static G4AssemblyStore* fgInstance; 87 static G4AssemblyStore* fgInstance;
81 static G4ThreadLocal G4VStoreNotifier* fgN 88 static G4ThreadLocal G4VStoreNotifier* fgNotifier;
82 static G4ThreadLocal G4bool locked; 89 static G4ThreadLocal G4bool locked;
83 }; 90 };
84 91
85 #endif 92 #endif
86 93