ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4PhysicalVolumeStore.hh
Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4PhysicalVolumeStore.hh
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 // G4PhysicalVolumeStore
27 //
28 // Class description:
29 //
30 // Container for all solids, 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 // G4PhysicalVolumeStore::GetInstance()
34 //
35 // All solids should be registered with G4PhysicalVolumeStore, and removed on
36 // their destruction. Intended principally for UI browser. The underlying
37 // container initially has a capacity of 100.
38 //
39 // If much additional functionality is added, should consider containment
40 // instead of inheritance for std::vector<T>
41 //
42 // Member data:
43 //
44 // static G4PhysicalVolumeStore*
45 // - Ptr to the single G4PhysicalVolumeStore.
46 
47 // 18.04.01, G.Cosmo - Migrated to STL vector
48 // 25.07.95, P.Kent - Initial version
49 // --------------------------------------------------------------------
50 #ifndef G4PHYSICALVOLUMESTORE_HH
51 #define G4PHYSICALVOLUMESTORE_HH
52 
53 #include <vector>
54 
55 #include "G4VPhysicalVolume.hh"
56 #include "G4VStoreNotifier.hh"
57 
58 class G4PhysicalVolumeStore : public std::vector<G4VPhysicalVolume*>
59 {
60  public: // with description
61 
62  static void Register(G4VPhysicalVolume* pSolid);
63  // Add the volume to the collection.
64  static void DeRegister(G4VPhysicalVolume* pSolid);
65  // Remove the volume from the collection.
67  // Get a ptr to the unique G4PhysicalVolumeStore, creating it if necessary.
68  static void SetNotifier(G4VStoreNotifier* pNotifier);
69  // Assign a notifier for allocation/deallocation of the physical volumes.
70  static void Clean();
71  // Delete all physical volumes from the store. Mother logical volumes
72  // are automatically notified and have their daughters de-registered.
73 
75  G4bool verbose = true) const;
76  // Return the pointer of the first volume in the collection having
77  // that name.
78 
79  virtual ~G4PhysicalVolumeStore();
80  // Destructor: takes care to delete allocated physical volumes.
81 
82  protected:
83 
85 
86  private:
87 
91 };
92 
93 #endif