Geant4  10.00.p01
G4PhysicalVolumeStore.hh
Go to the documentation of this file.
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 //
27 // $Id: G4PhysicalVolumeStore.hh 66872 2013-01-15 01:25:57Z japost $
28 //
29 // class G4PhysicalVolume
30 //
31 // Class description:
32 //
33 // Container for all solids, with functionality derived from
34 // std::vector<T>. The class is a `singleton', in that only
35 // one can exist, and access is provided via the static method
36 // G4PhysicalVolumeStore::GetInstance()
37 //
38 // All solids should be registered with G4PhysicalVolumeStore, and removed on
39 // their destruction. Intended principally for UI browser. The underlying
40 // container initially has a capacity of 100.
41 //
42 // If much additional functionality is added, should consider containment
43 // instead of inheritance for std::vector<T>
44 //
45 // Member data:
46 //
47 // static G4PhysicalVolumeStore*
48 // - Ptr to the single G4PhysicalVolumeStore.
49 
50 // History:
51 // 18.04.01 G.Cosmo Migrated to STL vector
52 // 25.07.95 P.Kent Initial version
53 // --------------------------------------------------------------------
54 #ifndef G4PHYSICALVOLUMESTORE_HH
55 #define G4PHYSICALVOLUMESTORE_HH
56 
57 #include <vector>
58 
59 #include "G4VPhysicalVolume.hh"
60 #include "G4VStoreNotifier.hh"
61 
62 class G4PhysicalVolumeStore : public std::vector<G4VPhysicalVolume*>
63 {
64  public: // with description
65 
66  static void Register(G4VPhysicalVolume* pSolid);
67  // Add the volume to the collection.
68  static void DeRegister(G4VPhysicalVolume* pSolid);
69  // Remove the volume from the collection.
71  // Get a ptr to the unique G4PhysicalVolumeStore, creating it if necessary.
72  static void SetNotifier(G4VStoreNotifier* pNotifier);
73  // Assign a notifier for allocation/deallocation of the physical volumes.
74  static void Clean();
75  // Delete all physical volumes from the store. Mother logical volumes
76  // are automatically notified and have their daughters de-registered.
77 
79  G4bool verbose=true) const;
80  // Return the pointer of the first volume in the collection having
81  // that name.
82 
83  virtual ~G4PhysicalVolumeStore();
84  // Destructor: takes care to delete allocated physical volumes.
85 
86  protected:
87 
89 
90  private:
91 
95 };
96 
97 #endif
static G4PhysicalVolumeStore * fgInstance
static G4ThreadLocal G4VStoreNotifier * fgNotifier
G4String name
Definition: TRTMaterials.hh:40
static void Register(G4VPhysicalVolume *pSolid)
static G4ThreadLocal G4bool locked
#define G4ThreadLocal
Definition: tls.hh:52
static void DeRegister(G4VPhysicalVolume *pSolid)
static G4PhysicalVolumeStore * GetInstance()
bool G4bool
Definition: G4Types.hh:79
static void SetNotifier(G4VStoreNotifier *pNotifier)
G4VPhysicalVolume * GetVolume(const G4String &name, G4bool verbose=true) const