Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/geometry/management/include/G4LogicalVolumeStore.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /geometry/management/include/G4LogicalVolumeStore.hh (Version 11.3.0) and /geometry/management/include/G4LogicalVolumeStore.hh (Version 11.2.1)


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