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