Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/geometry/management/include/G4RegionStore.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/G4RegionStore.hh (Version 11.3.0) and /geometry/management/include/G4RegionStore.hh (Version 7.1)


  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 // G4RegionStore                               <<  23 //
                                                   >>  24 // $Id: G4RegionStore.hh,v 1.6 2004/09/02 07:49:58 gcosmo Exp $
                                                   >>  25 // GEANT4 tag $Name: geant4-07-01 $
                                                   >>  26 //
                                                   >>  27 // class G4RegionStore
 27 //                                                 28 //
 28 // Class description:                              29 // Class description:
 29 //                                                 30 //
 30 // Container for all regions, with functionali <<  31 // Container for all regiong, 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 method
 33 // G4RegionStore::GetInstance().                   34 // G4RegionStore::GetInstance().
 34 //                                                 35 //
 35 // All regions should be registered with G4Reg     36 // All regions should be registered with G4RegionStore, and removed on their
 36 // destruction. The underlying container initi     37 // destruction. The underlying container initially has a capacity of 20.
 37 // A map indexed by volume names is also recor << 
 38 // pointers to regions with same name are stor << 
 39 //                                                 38 //
 40 // If much additional functionality is added,      39 // If much additional functionality is added, should consider containment
 41 // instead of inheritance for std::vector<T>.  <<  40 // instead of inheritance for std::vector<T>
                                                   >>  41 //
                                                   >>  42 // Member data:
                                                   >>  43 //
                                                   >>  44 // static G4RegionStore*
                                                   >>  45 //   - Pointer to the single G4RegionStore
 42                                                    46 
 43 // 18.09.02, G.Cosmo - Initial version         <<  47 // History:
                                                   >>  48 // 18.09.02 G.Cosmo Initial version
 44 // -------------------------------------------     49 // --------------------------------------------------------------------
 45 #ifndef G4REGIONSTORE_HH                           50 #ifndef G4REGIONSTORE_HH
 46 #define G4REGIONSTORE_HH 1                     <<  51 #define G4REGIONSTORE_HH
 47                                                    52 
 48 #include <vector>                                  53 #include <vector>
 49 #include <map>                                 << 
 50                                                << 
 51 #include "G4Types.hh"                              54 #include "G4Types.hh"
 52 #include "G4String.hh"                             55 #include "G4String.hh"
 53 #include "G4VStoreNotifier.hh"                 << 
 54                                                    56 
 55 class G4Region;                                    57 class G4Region;
 56 class G4VPhysicalVolume;                       <<  58 class G4VStoreNotifier;
 57                                                    59 
 58 class G4RegionStore : public std::vector<G4Reg     60 class G4RegionStore : public std::vector<G4Region*>
 59 {                                                  61 {
 60   public:                                      <<  62   public:  // with description
 61                                                    63 
 62     static void Register(G4Region* pRegion);   <<  64     static void Register(G4Region* pSolid);
 63       // Add the region to the collection.         65       // Add the region to the collection.
 64     static void DeRegister(G4Region* pRegion); <<  66     static void DeRegister(G4Region* pSolid);
 65       // Remove the region from the collection     67       // Remove the region from the collection.
 66     static G4RegionStore* GetInstance();           68     static G4RegionStore* GetInstance();
 67       // Get a ptr to the unique G4RegionStore     69       // Get a ptr to the unique G4RegionStore, creating it if necessary.
 68     static void SetNotifier(G4VStoreNotifier*      70     static void SetNotifier(G4VStoreNotifier* pNotifier);
 69       // Assign a notifier for allocation/deal     71       // Assign a notifier for allocation/deallocation of regions.
 70     static void Clean();                           72     static void Clean();
 71       // Delete all regions from the store exc     73       // Delete all regions from the store except for the world region.
 72                                                    74 
 73     G4bool IsModified() const;                     75     G4bool IsModified() const;
 74       // Loops through all regions to verify i     76       // Loops through all regions to verify if a region has been
 75       // modified. It returns TRUE if just one     77       // modified. It returns TRUE if just one region is modified.
 76     void ResetRegionModified();                    78     void ResetRegionModified();
 77       // Loops through all regions to reset fl     79       // Loops through all regions to reset flag for modification
 78       // to FALSE. Used by the run manager to      80       // to FALSE. Used by the run manager to notify that the
 79       // physics table has been updated.           81       // physics table has been updated.
 80                                                    82 
 81     void UpdateMaterialList(G4VPhysicalVolume* <<  83     void UpdateMaterialList();
 82       // Forces recomputation of material list     84       // Forces recomputation of material lists in all regions
 83       // in the store.                             85       // in the store.
 84                                                    86 
 85     G4Region* GetRegion(const G4String& name,  <<  87     G4Region* GetRegion(const G4String& name, G4bool verbose=true) const;
 86       // Returns a region through its name spe <<  88       // Returns a region through its name specification.
 87       // map for fast search and warns if a re << 
 88       // unique or not found.                  << 
 89                                                << 
 90     inline G4bool IsMapValid() const  { return << 
 91     inline void SetMapValid(G4bool val)  { mva << 
 92       // Accessor to assess validity of the in << 
 93     inline const std::map<G4String,            << 
 94             std::vector<G4Region*> >& GetMap() << 
 95       // Return the internal map.              << 
 96     void UpdateMap();                          << 
 97       // Bring contents of internal map up to  << 
 98                                                    89 
 99     G4Region* FindOrCreateRegion(const G4Strin     90     G4Region* FindOrCreateRegion(const G4String& name);
100       // Returns a region through its name spe     91       // Returns a region through its name specification, if it exists.
101       // If it does not exist it will allocate     92       // If it does not exist it will allocate one delegating ownership
102       // to the client.                            93       // to the client.
103                                                    94 
104     void SetWorldVolume();                     << 
105       // Set a world volume pointer to a regio << 
106       // Scan over all world volumes.          << 
107       // This method should be exclusively use << 
108                                                << 
109     virtual ~G4RegionStore();                      95     virtual ~G4RegionStore();
110       // Destructor: takes care to delete allo     96       // Destructor: takes care to delete allocated regions.
111                                                    97 
112     G4RegionStore(const G4RegionStore&) = dele << 
113     G4RegionStore& operator=(const G4RegionSto << 
114       // Forbidden copy constructor and assign << 
115                                                << 
116   protected:                                       98   protected:
117                                                    99 
118     G4RegionStore();                              100     G4RegionStore();
119       // Protected singleton constructor.      << 
120                                                   101 
121   private:                                        102   private:
122                                                   103 
123     static G4RegionStore* fgInstance;             104     static G4RegionStore* fgInstance;
124     static G4ThreadLocal G4VStoreNotifier* fgN << 105     static G4VStoreNotifier* fgNotifier;
125     static G4ThreadLocal G4bool locked;        << 106     static G4bool locked;
126                                                << 
127     std::map<G4String, std::vector<G4Region*>  << 
128     G4bool mvalid = false;  // Flag to indicat << 
129 };                                                107 };
130                                                   108 
131 #endif                                            109 #endif
132                                                   110