[831] | 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: G4LogicalVolumeStore.hh,v 1.13 2007/04/10 10:13:50 gcosmo Exp $ |
---|
[1058] | 28 | // GEANT4 tag $Name: geant4-09-02-ref-02 $ |
---|
[831] | 29 | // |
---|
| 30 | // class G4LogicalVolumeStore |
---|
| 31 | // |
---|
| 32 | // Class description: |
---|
| 33 | // |
---|
| 34 | // Container for all LogicalVolumes, with functionality derived from |
---|
| 35 | // std::vector<T>. The class is a `singleton', in that only |
---|
| 36 | // one can exist, and access is provided via the static function |
---|
| 37 | // G4LogicalVolumeStore::GetInstance() |
---|
| 38 | // |
---|
| 39 | // All LogicalVolumes should be registered with G4LogicalVolumeStore, |
---|
| 40 | // and removed on their destruction. Intended principally for UI browser. |
---|
| 41 | // The underlying container initially has a capacity of 100. |
---|
| 42 | // |
---|
| 43 | // If much additional functionality is added, should consider containment |
---|
| 44 | // instead of inheritance for std::vector<T>. |
---|
| 45 | // |
---|
| 46 | // Member data: |
---|
| 47 | // |
---|
| 48 | // static G4LogicalVolumeStore* fgInstance |
---|
| 49 | // - Ptr to the single G4LogicalVolumeStore. |
---|
| 50 | |
---|
| 51 | // History: |
---|
| 52 | // 18.04.01 G.Cosmo Migrated to STL vector |
---|
| 53 | // 10.07.95 P.Kent Initial version |
---|
| 54 | // -------------------------------------------------------------------- |
---|
| 55 | #ifndef G4LOGICALVOLUMESTORE_HH |
---|
| 56 | #define G4LOGICALVOLUMESTORE_HH |
---|
| 57 | |
---|
| 58 | #include <vector> |
---|
| 59 | |
---|
| 60 | #include "G4LogicalVolume.hh" |
---|
| 61 | #include "G4VStoreNotifier.hh" |
---|
| 62 | |
---|
| 63 | class G4LogicalVolumeStore : public std::vector<G4LogicalVolume*> |
---|
| 64 | { |
---|
| 65 | public: // with description |
---|
| 66 | |
---|
| 67 | static void Register(G4LogicalVolume* pVolume); |
---|
| 68 | // Add the logical volume to the collection. |
---|
| 69 | static void DeRegister(G4LogicalVolume* pVolume); |
---|
| 70 | // Remove the logical volume from the collection. |
---|
| 71 | static G4LogicalVolumeStore* GetInstance(); |
---|
| 72 | // Get a ptr to the unique G4LogicalVolumeStore, creating it if necessary. |
---|
| 73 | static void SetNotifier(G4VStoreNotifier* pNotifier); |
---|
| 74 | // Assign a notifier for allocation/deallocation of the logical volumes. |
---|
| 75 | static void Clean(); |
---|
| 76 | // Delete all volumes from the store. |
---|
| 77 | |
---|
| 78 | G4LogicalVolume* GetVolume(const G4String& name, G4bool verbose=true) const; |
---|
| 79 | // Return the pointer of the first volume in the collection having |
---|
| 80 | // that name. |
---|
| 81 | |
---|
| 82 | virtual ~G4LogicalVolumeStore(); |
---|
| 83 | // Destructor: takes care to delete allocated logical volumes. |
---|
| 84 | |
---|
| 85 | protected: |
---|
| 86 | |
---|
| 87 | G4LogicalVolumeStore(); |
---|
| 88 | |
---|
| 89 | private: |
---|
| 90 | |
---|
| 91 | static G4LogicalVolumeStore* fgInstance; |
---|
| 92 | static G4VStoreNotifier* fgNotifier; |
---|
| 93 | static G4bool locked; |
---|
| 94 | }; |
---|
| 95 | |
---|
| 96 | #endif |
---|