G4SolidStore Class Reference

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

#include <G4SolidStore.hh>

Inheritance diagram for G4SolidStore:

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

Static Public Member Functions
static void	Register (G4VSolid *pSolid)
static void	DeRegister (G4VSolid *pSolid)
static G4SolidStore *	GetInstance ()
static void	SetNotifier (G4VStoreNotifier *pNotifier)
static void	Clean ()

Protected Member Functions
	G4SolidStore ()

Detailed Description

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

Definition at line 63 of file G4SolidStore.hh.

Constructor & Destructor Documentation

~G4SolidStore()

G4SolidStore::~G4SolidStore ( )

virtual

Destructor: takes care to delete allocated solids.

Definition at line 65 of file G4SolidStore.cc.

{
  Clean();
}

G4SolidStore() [1/2]

G4SolidStore::G4SolidStore ( const G4SolidStore & )

delete

Copy constructor and assignment operator not allowed.

Referenced by Clean(), DeRegister(), G4SolidStore(), GetInstance(), GetSolid(), operator=(), and Register().

G4SolidStore() [2/2]

G4SolidStore::G4SolidStore ( )

protected

Protected singleton constructor.

Definition at line 55 of file G4SolidStore.cc.

{
  reserve(100);
}

Member Function Documentation

Clean()

void G4SolidStore::Clean ( )

static

Deletes all solids from the store.

Definition at line 74 of file G4SolidStore.cc.

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

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

DeRegister()

void G4SolidStore::DeRegister ( G4VSolid * pSolid )

static

Removes the solid 'pSolid' from the collection.

Definition at line 167 of file G4SolidStore.cc.

{
  G4SolidStore* store = GetInstance();
  if (!locked)    // Do not de-register if locked !
  {
    if (fgNotifier != nullptr) { fgNotifier->NotifyDeRegistration(); }
    for (auto i=store->crbegin(); i!=store->crend(); ++i)
    {
      if (**i==*pSolid)
      {
        store->erase(std::next(i).base());
        store->mvalid = false;
        break;
      }
    }
    const G4String& sol_name = pSolid->GetName();
    auto it = store->bmap.find(sol_name);
    if (it != store->bmap.cend())
    {
      if (it->second.size() > 1)
      {
        for (auto i=it->second.cbegin(); i!=it->second.cend(); ++i)
        {
          if (**i==*pSolid)
          {
            it->second.erase(i);
            break;
          }
        }
      }
      else
      {
        store->bmap.erase(it);
      }
    }
  }
}

Referenced by G4Voxelizer::G4Voxelizer(), and G4VSolid::~G4VSolid().

GetInstance()

G4SolidStore * G4SolidStore::GetInstance ( )

static

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

Definition at line 247 of file G4SolidStore.cc.

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

Referenced by Clean(), DeRegister(), G4Voxelizer::G4Voxelizer(), G4VSolid::G4VSolid(), G4VSolid::G4VSolid(), G4VSolid::G4VSolid(), G4GDMLReadSolids::GetSolid(), GetSolid(), Register(), G4RunManager::ReinitializeGeometry(), G4VSolid::SetName(), SetNotifier(), G4GeometryManager::SetWorldMaximumExtent(), G4GDMLRead::StripNames(), UpdateMap(), and G4VSolid::~G4VSolid().

GetMap()

const std::map< G4String, std::vector< G4VSolid * > > & G4SolidStore::GetMap ( ) const

inline

Returns the internal map.

Definition at line 125 of file G4SolidStore.hh.

{ return bmap; }

GetSolid()

G4VSolid * G4SolidStore::GetSolid	(	const G4String &	name,
		G4bool	verbose = true,
		G4bool	reverseSearch = false ) const

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

Parameters

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

Definition at line 209 of file G4SolidStore.cc.

{
  G4SolidStore* 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 solid in store named: "
              << name << "!" << G4endl
              << "Returning the first found.";
      G4Exception("G4SolidStore::GetSolid()",
                  "GeomMgt1001", JustWarning, message);
    }
    if(reverseSearch)
    {
      return pos->second[pos->second.size()-1];
    }
    return pos->second[0];
  }
  if (verbose)
  {
    std::ostringstream message;
    message << "Solid " << name << " not found in store !" << G4endl
            << "Returning NULL pointer.";
    G4Exception("G4SolidStore::GetSolid()",
                "GeomMgt1001", JustWarning, message);
  }
  return nullptr;
}

Referenced by G4GDMLReadSolids::GetSolid().

IsMapValid()

G4bool G4SolidStore::IsMapValid ( ) const

inline

Accessor and modifier to assess validity of the internal map.

Definition at line 118 of file G4SolidStore.hh.

{ return mvalid; }

operator=()

G4SolidStore & G4SolidStore::operator= ( const G4SolidStore & )

delete

Register()

void G4SolidStore::Register ( G4VSolid * pSolid )

static

Adds the solid 'pSolid' to the collection.

Definition at line 144 of file G4SolidStore.cc.

{
  G4SolidStore* store = GetInstance();
  store->push_back(pSolid);
  const G4String& sol_name = pSolid->GetName();
  auto it = store->bmap.find(sol_name);
  if (it != store->bmap.cend())
  {
    it->second.push_back(pSolid);
  }
  else
  {
    std::vector<G4VSolid*> sol_vec { pSolid };
    store->bmap.insert(std::make_pair(sol_name, sol_vec));
  }
  if (fgNotifier != nullptr) { fgNotifier->NotifyRegistration(); }
  store->mvalid = true;
}

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

SetMapValid()

void G4SolidStore::SetMapValid ( G4bool val )

inline

Definition at line 119 of file G4SolidStore.hh.

{ mvalid = val; }

Referenced by G4VSolid::SetName().

SetNotifier()

void G4SolidStore::SetNotifier ( G4VStoreNotifier * pNotifier )

static

Assigns a notifier for allocation/deallocation of the solids.

Definition at line 107 of file G4SolidStore.cc.

{
  GetInstance();
  fgNotifier = pNotifier;
}

UpdateMap()

void G4SolidStore::UpdateMap

(

)

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

Definition at line 117 of file G4SolidStore.cc.

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

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

---

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

• G4SolidStore.hh
• G4SolidStore.cc