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