ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4LogicalVolumeStore.hh
Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4LogicalVolumeStore.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 // G4LogicalVolumeStore
27 //
28 // Class description:
29 //
30 // Container for all LogicalVolumes, 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 function
33 // G4LogicalVolumeStore::GetInstance()
34 //
35 // All LogicalVolumes should be registered with G4LogicalVolumeStore,
36 // and removed on their destruction. Intended principally for UI browser.
37 // The underlying 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 G4LogicalVolumeStore* fgInstance
45 // - Ptr to the single G4LogicalVolumeStore.
46 
47 // 18.04.01 - G.Cosmo, Migrated to STL vector
48 // 10.07.95 - P.Kent, Initial version
49 // --------------------------------------------------------------------
50 #ifndef G4LOGICALVOLUMESTORE_HH
51 #define G4LOGICALVOLUMESTORE_HH
52 
53 #include <vector>
54 
55 #include "G4LogicalVolume.hh"
56 #include "G4VStoreNotifier.hh"
57 
58 class G4LogicalVolumeStore : public std::vector<G4LogicalVolume*>
59 {
60  public: // with description
61 
62  static void Register(G4LogicalVolume* pVolume);
63  // Add the logical volume to the collection.
64  static void DeRegister(G4LogicalVolume* pVolume);
65  // Remove the logical volume from the collection.
67  // Get a ptr to the unique G4LogicalVolumeStore, creating it if necessary.
68  static void SetNotifier(G4VStoreNotifier* pNotifier);
69  // Assign a notifier for allocation/deallocation of the logical volumes.
70  static void Clean();
71  // Delete all volumes from the store.
72 
73  G4LogicalVolume* GetVolume(const G4String& name, G4bool verbose=true) const;
74  // Return the pointer of the first volume in the collection having
75  // that name.
76 
77  virtual ~G4LogicalVolumeStore();
78  // Destructor: takes care to delete allocated logical volumes.
79 
80  protected:
81 
83 
84  private:
85 
89 };
90 
91 #endif