| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer << 3 // * DISCLAIMER *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th << 5 // * The following disclaimer summarizes all the specific disclaimers *
6 // * the Geant4 Collaboration. It is provided << 6 // * of contributors to this software. The specific disclaimers,which *
7 // * conditions of the Geant4 Software License << 7 // * govern, are listed with their locations in: *
8 // * LICENSE and available at http://cern.ch/ << 8 // * http://cern.ch/geant4/license *
9 // * include a list of copyright holders. <<
10 // * 9 // * *
11 // * Neither the authors of this software syst 10 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 11 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 12 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 13 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file << 14 // * use. *
16 // * for the full disclaimer and the limitatio <<
17 // * 15 // * *
18 // * This code implementation is the result << 16 // * This code implementation is the intellectual property of the *
19 // * technical work of the GEANT4 collaboratio << 17 // * GEANT4 collaboration. *
20 // * By using, copying, modifying or distri << 18 // * By copying, distributing or modifying the Program (or any work *
21 // * any work based on the software) you ag << 19 // * based on the Program) you indicate your acceptance of this *
22 // * use in resulting scientific publicati << 20 // * statement, and all its terms. *
23 // * acceptance of all terms of the Geant4 Sof <<
24 // ******************************************* 21 // ********************************************************************
25 // 22 //
26 // G4LogicalVolumeStore << 23 //
>> 24 // $Id: G4LogicalVolumeStore.hh,v 1.10 2004/09/02 07:49:58 gcosmo Exp $
>> 25 // GEANT4 tag $Name: geant4-07-01 $
>> 26 //
>> 27 // class G4LogicalVolumeStore
27 // 28 //
28 // Class description: 29 // Class description:
29 // 30 //
30 // Container for all logical volumes, with fun << 31 // Container for all LogicalVolumes, with functionality derived from
31 // std::vector<T>. The class is a 'singleton', << 32 // std::vector<T>. The class is a `singleton', in that only
32 // one can exist, and access is provided via t 33 // one can exist, and access is provided via the static function
33 // G4LogicalVolumeStore::GetInstance() 34 // G4LogicalVolumeStore::GetInstance()
34 // 35 //
35 // All logical volumes should be registered wi << 36 // All LogicalVolumes should be registered with G4LogicalVolumeStore,
36 // and removed on their destruction. << 37 // and removed on their destruction. Intended principally for UI browser.
37 // The underlying container initially has a ca 38 // The underlying container initially has a capacity of 100.
38 // A map indexed by volume names is also recor <<
39 // pointers to volumes with same name are stor <<
40 // 39 //
41 // If much additional functionality is added, 40 // If much additional functionality is added, should consider containment
42 // instead of inheritance for std::vector<T>. 41 // instead of inheritance for std::vector<T>.
>> 42 //
>> 43 // Member data:
>> 44 //
>> 45 // static G4LogicalVolumeStore* fgInstance
>> 46 // - Ptr to the single G4LogicalVolumeStore.
43 47
44 // 10.07.95, P.Kent, G.Cosmo - Initial version << 48 // History:
>> 49 // 18.04.01 G.Cosmo Migrated to STL vector
>> 50 // 10.07.95 P.Kent Initial version
45 // ------------------------------------------- 51 // --------------------------------------------------------------------
46 #ifndef G4LOGICALVOLUMESTORE_HH 52 #ifndef G4LOGICALVOLUMESTORE_HH
47 #define G4LOGICALVOLUMESTORE_HH 1 << 53 #define G4LOGICALVOLUMESTORE_HH
48 54
49 #include <vector> 55 #include <vector>
50 #include <map> <<
51 56
52 #include "G4LogicalVolume.hh" 57 #include "G4LogicalVolume.hh"
53 #include "G4VStoreNotifier.hh" << 58
>> 59 class G4VStoreNotifier;
54 60
55 class G4LogicalVolumeStore : public std::vecto 61 class G4LogicalVolumeStore : public std::vector<G4LogicalVolume*>
56 { 62 {
57 public: << 63 public: // with description
58 64
59 static void Register(G4LogicalVolume* pVol 65 static void Register(G4LogicalVolume* pVolume);
60 // Add the logical volume to the collect 66 // Add the logical volume to the collection.
61 static void DeRegister(G4LogicalVolume* pV 67 static void DeRegister(G4LogicalVolume* pVolume);
62 // Remove the logical volume from the co 68 // Remove the logical volume from the collection.
63 static G4LogicalVolumeStore* GetInstance() 69 static G4LogicalVolumeStore* GetInstance();
64 // Get a ptr to the unique G4LogicalVolu 70 // Get a ptr to the unique G4LogicalVolumeStore, creating it if necessary.
65 static void SetNotifier(G4VStoreNotifier* 71 static void SetNotifier(G4VStoreNotifier* pNotifier);
66 // Assign a notifier for allocation/deal 72 // Assign a notifier for allocation/deallocation of the logical volumes.
67 static void Clean(); 73 static void Clean();
68 // Delete all volumes from the store. 74 // Delete all volumes from the store.
69 75
70 G4LogicalVolume* GetVolume(const G4String& <<
71 G4bool reverseSearch=false) <<
72 // Return the pointer of the first or la <<
73 // that name. Uses the internal map for <<
74 // a volume in the collection is not uni <<
75 <<
76 inline G4bool IsMapValid() const { return <<
77 inline void SetMapValid(G4bool val) { mva <<
78 // Accessor to assess validity of the in <<
79 inline const std::map<G4String, <<
80 std::vector<G4LogicalVolume*> >& G <<
81 // Return the internal map. <<
82 void UpdateMap(); <<
83 // Bring contents of internal map up to <<
84 <<
85 virtual ~G4LogicalVolumeStore(); 76 virtual ~G4LogicalVolumeStore();
86 // Destructor: takes care to delete allo 77 // Destructor: takes care to delete allocated logical volumes.
87 78
88 G4LogicalVolumeStore(const G4LogicalVolume <<
89 G4LogicalVolumeStore& operator=(const G4Lo <<
90 // Forbidden copy constructor and assign <<
91 <<
92 protected: 79 protected:
93 80
94 G4LogicalVolumeStore(); 81 G4LogicalVolumeStore();
95 82
96 private: 83 private:
97 84
98 static G4LogicalVolumeStore* fgInstance; 85 static G4LogicalVolumeStore* fgInstance;
99 static G4ThreadLocal G4VStoreNotifier* fgN << 86 static G4VStoreNotifier* fgNotifier;
100 static G4ThreadLocal G4bool locked; << 87 static G4bool locked;
101 <<
102 std::map<G4String, std::vector<G4LogicalVo <<
103 G4bool mvalid = false; // Flag to indicat <<
104 }; 88 };
105 89
106 #endif 90 #endif
107 91