G4LogicalVolumeStore Class Reference

G4LogicalVolumeStore is a singleton class, acting as container for all logical volumes, with functionality derived from std::vector<T>. All logical volumes should be registered with G4LogicalVolumeStore, and removed on their destruction. The underlying container initially has a capacity of 100. A map indexed by volume names is also recorded for fast search; pointers to volumes with same name are stored in buckets. More...

#include <G4LogicalVolumeStore.hh>

Inheritance diagram for G4LogicalVolumeStore:

Public Member Functions
virtual	~G4LogicalVolumeStore ()
	G4LogicalVolumeStore (const G4LogicalVolumeStore &)=delete
G4LogicalVolumeStore &	operator= (const G4LogicalVolumeStore &)=delete
G4LogicalVolume *	GetVolume (const G4String &name, G4bool verbose=true, G4bool reverseSearch=false) const
G4bool	IsMapValid () const
void	SetMapValid (G4bool val)
const std::map< G4String, std::vector< G4LogicalVolume * > > &	GetMap () const
void	UpdateMap ()

Static Public Member Functions
static void	Register (G4LogicalVolume *pVolume)
static void	DeRegister (G4LogicalVolume *pVolume)
static G4LogicalVolumeStore *	GetInstance ()
static void	SetNotifier (G4VStoreNotifier *pNotifier)
static void	Clean ()

Protected Member Functions
	G4LogicalVolumeStore ()

Detailed Description

G4LogicalVolumeStore is a singleton class, acting as container for all logical volumes, with functionality derived from std::vector<T>. All logical volumes should be registered with G4LogicalVolumeStore, and removed on their destruction. The underlying container initially has a capacity of 100. A map indexed by volume names is also recorded for fast search; pointers to volumes with same name are stored in buckets.

Definition at line 64 of file G4LogicalVolumeStore.hh.

Constructor & Destructor Documentation

~G4LogicalVolumeStore()

G4LogicalVolumeStore::~G4LogicalVolumeStore ( )

virtual

Destructor: takes care to delete allocated logical volumes.

Definition at line 65 of file G4LogicalVolumeStore.cc.

{
  Clean();  // Delete all volumes in the store
  G4LogicalVolume::Clean();  // Delete allocated sub-instance data
}

G4LogicalVolumeStore() [1/2]

G4LogicalVolumeStore::G4LogicalVolumeStore ( const G4LogicalVolumeStore & )

delete

Copy constructor and assignment operator not allowed.

Referenced by Clean(), DeRegister(), G4LogicalVolumeStore(), GetInstance(), GetVolume(), operator=(), and Register().

G4LogicalVolumeStore() [2/2]

G4LogicalVolumeStore::G4LogicalVolumeStore ( )

protected

Protected singleton constructor.

Definition at line 55 of file G4LogicalVolumeStore.cc.

{
  reserve(100);
}

Member Function Documentation

Clean()

void G4LogicalVolumeStore::Clean ( )

static

Deletes all volumes from the store.

Definition at line 75 of file G4LogicalVolumeStore.cc.

{
  // Do nothing if geometry is closed
  //
  if (G4GeometryManager::GetInstance()->IsGeometryClosed())
  {
    G4cout << "WARNING - Attempt to delete the logical volume store"
           << " while geometry closed !" << G4endl;
    return;
  }
 
  // Locks store for deletion of volumes. De-registration will be
  // performed at this stage. G4LogicalVolumes will not de-register themselves.
  //
  locked = true;  
 
  G4LogicalVolumeStore* store = GetInstance();
 
  for(const auto & pos : *store)
  {
    if (fgNotifier != nullptr) { fgNotifier->NotifyDeRegistration(); }
    if (pos != nullptr) { pos->Lock(); delete pos; }
  }
 
  store->bmap.clear(); store->mvalid = false;
  locked = false;
  store->clear();
}

Referenced by G4RunManager::ReinitializeGeometry(), and ~G4LogicalVolumeStore().

DeRegister()

void G4LogicalVolumeStore::DeRegister ( G4LogicalVolume * pVolume )

static

Removes the logical volume 'pVolume' from the collection.

Definition at line 168 of file G4LogicalVolumeStore.cc.

{
  G4LogicalVolumeStore* store = GetInstance();
  if (!locked)    // Do not de-register if locked !
  {
    if (fgNotifier != nullptr) { fgNotifier->NotifyDeRegistration(); }
    for (auto i=store->cbegin(); i!=store->cend(); ++i)
    {
      if (**i==*pVolume)
      {
        store->erase(i);
        break;
      }
    }
    const G4String& vol_name = pVolume->GetName();
    auto it = store->bmap.find(vol_name);
    if (it != store->bmap.cend())
    {
      if (it->second.size() > 1)
      {
        for (auto i=it->second.cbegin(); i!=it->second.cend(); ++i)
        {
          if (**i==*pVolume)
          {
            it->second.erase(i);
            break;
          }
        }
      }
      else
      {
        store->bmap.erase(it);
      }
    }
  }
}

Referenced by G4LogicalVolume::~G4LogicalVolume().

GetInstance()

G4LogicalVolumeStore * G4LogicalVolumeStore::GetInstance ( )

static

Returns a pointer to the unique instance of G4LogicalVolumeStore, creating it if necessary.

Definition at line 249 of file G4LogicalVolumeStore.cc.

{
  static G4LogicalVolumeStore worldStore;
  if (fgInstance == nullptr)
  {
    fgInstance = &worldStore;
  }
  return fgInstance;
}

Referenced by checkVol(), Clean(), G4VUserDetectorConstruction::CloneF(), G4VUserDetectorConstruction::CloneSD(), DeRegister(), G4VRadioactiveDecay::DeselectAVolume(), G4Region::GetParentRegion(), G4GDMLReadStructure::GetVolume(), GetVolume(), G4GeneralCerenkov::PreparePhysicsTable(), Register(), G4RunManager::ReinitializeGeometry(), G4VRadioactiveDecay::SelectAllVolumes(), G4VRadioactiveDecay::SelectAVolume(), G4VVisCommandGeometrySet::Set(), G4LogicalVolume::SetName(), G4GDMLMessenger::SetNewValue(), G4VisCommandGeometryList::SetNewValue(), G4VisCommandGeometryRestore::SetNewValue(), G4VisCommandSceneAddLogicalVolume::SetNewValue(), SetNotifier(), G4VUserDetectorConstruction::SetSensitiveDetector(), G4VUserParallelWorld::SetSensitiveDetector(), G4ScoringProbe::SetupGeometry(), G4ScoringRealWorld::SetupGeometry(), G4GDMLRead::StripNames(), G4WorkerThread::UpdateGeometryAndPhysicsVectorFromMaster(), and UpdateMap().

GetMap()

const std::map< G4String, std::vector< G4LogicalVolume * > > & G4LogicalVolumeStore::GetMap ( ) const

inline

Returns the internal map.

Definition at line 126 of file G4LogicalVolumeStore.hh.

{ return bmap; }

Referenced by G4VUserDetectorConstruction::SetSensitiveDetector(), and G4VUserParallelWorld::SetSensitiveDetector().

GetVolume()

G4LogicalVolume * G4LogicalVolumeStore::GetVolume	(	const G4String &	name,
		G4bool	verbose = true,
		G4bool	reverseSearch = false ) const

Returns a pointer to the first or last volume in the collection having that 'name'. Uses the internal map for fast search and warns if a volume in the collection is not unique or not found.

Parameters

[in]	name	The name of the volume to search.
[in]	verbose	Flag for enabling verbosity (default true).
[in]	reverseSearch	Flag to enable inverse search (default false).

Definition at line 210 of file G4LogicalVolumeStore.cc.

{
  G4LogicalVolumeStore* store = GetInstance();
  if (!store->mvalid)  { store->UpdateMap(); }
  auto pos = store->bmap.find(name);
  if(pos != store->bmap.cend())
  {
    if ((verbose) && (pos->second.size()>1))
    {
      std::ostringstream message;
      message << "There exists more than ONE logical volume in store named: "
              << name << "!" << G4endl
              << "Returning the first found.";
      G4Exception("G4LogicalVolumeStore::GetVolume()",
                  "GeomMgt1001", JustWarning, message);
    }
    if(reverseSearch)
    {
      return pos->second[pos->second.size()-1];
    }
    return pos->second[0];
  }
  if (verbose)
  {
     std::ostringstream message;
     message << "Volume NOT found in store !" << G4endl
             << "        Volume " << name << " NOT found in store !" << G4endl
             << "        Returning NULL pointer.";
     G4Exception("G4LogicalVolumeStore::GetVolume()",
                 "GeomMgt1001", JustWarning, message);
  }
  return nullptr;
}

Referenced by G4VRadioactiveDecay::DeselectAVolume(), G4GDMLReadStructure::GetVolume(), G4VRadioactiveDecay::SelectAVolume(), G4GDMLMessenger::SetNewValue(), G4VisCommandSceneAddLogicalVolume::SetNewValue(), and G4ScoringProbe::SetupGeometry().

IsMapValid()

G4bool G4LogicalVolumeStore::IsMapValid ( ) const

inline

Accessor and modifier to assess validity of the internal map.

Definition at line 119 of file G4LogicalVolumeStore.hh.

{ return mvalid; }

operator=()

G4LogicalVolumeStore & G4LogicalVolumeStore::operator= ( const G4LogicalVolumeStore & )

delete

Register()

void G4LogicalVolumeStore::Register ( G4LogicalVolume * pVolume )

static

Adds the logical volume 'pVolume' to the collection.

Definition at line 145 of file G4LogicalVolumeStore.cc.

{
  G4LogicalVolumeStore* store = GetInstance();
  store->push_back(pVolume);
  const G4String& vol_name = pVolume->GetName();
  auto it = store->bmap.find(vol_name);
  if (it != store->bmap.cend())
  {
    it->second.push_back(pVolume);
  }
  else
  {
    std::vector<G4LogicalVolume*> vol_vec { pVolume };
    store->bmap.insert(std::make_pair(vol_name, vol_vec));
  }
  if (fgNotifier != nullptr) { fgNotifier->NotifyRegistration(); }
  store->mvalid = true;
}

Referenced by G4LogicalVolume::G4LogicalVolume(), and G4LogicalVolume::G4LogicalVolume().

SetMapValid()

void G4LogicalVolumeStore::SetMapValid ( G4bool val )

inline

Definition at line 120 of file G4LogicalVolumeStore.hh.

{ mvalid = val; }

Referenced by G4LogicalVolume::SetName().

SetNotifier()

void G4LogicalVolumeStore::SetNotifier ( G4VStoreNotifier * pNotifier )

static

Assigns a notifier for allocation/deallocation of the logical volumes.

Definition at line 108 of file G4LogicalVolumeStore.cc.

{
  GetInstance();
  fgNotifier = pNotifier;
}

UpdateMap()

void G4LogicalVolumeStore::UpdateMap

(

)

Brings contents of the internal map up to date and resets validity flag.

Definition at line 118 of file G4LogicalVolumeStore.cc.

{
  G4AutoLock l(&mapMutex);  // to avoid thread contention at initialisation
  if (mvalid) { return; }
  bmap.clear();
  for(const auto & pos : *GetInstance())
  {
    const G4String& vol_name = pos->GetName();
    auto it = bmap.find(vol_name);
    if (it != bmap.cend())
    {
      it->second.push_back(pos);
    }
    else
    {
      std::vector<G4LogicalVolume*> vol_vec { pos };
      bmap.insert(std::make_pair(vol_name, vol_vec));
    }
  }
  mvalid = true;
  l.unlock();
}

Referenced by GetVolume(), and G4GDMLRead::StripNames().

---

The documentation for this class was generated from the following files:

• G4LogicalVolumeStore.hh
• G4LogicalVolumeStore.cc