G4AssemblyStore Class Reference

G4AssemblyStore is a container for all assemblies, with functionality derived from std::vector<T>. The class is a singleton. All assemblies are registered with G4AssemblyStore, and removed on their destruction. More...

#include <G4AssemblyStore.hh>

Inheritance diagram for G4AssemblyStore:

Public Member Functions
G4AssemblyVolume *	GetAssembly (unsigned int id, G4bool verbose=true) const

Static Public Member Functions
static void	Register (G4AssemblyVolume *pAssembly)
static void	DeRegister (G4AssemblyVolume *pAssembly)
static G4AssemblyStore *	GetInstance ()
static void	SetNotifier (G4VStoreNotifier *pNotifier)
static void	Clean ()

Detailed Description

G4AssemblyStore is a container for all assemblies, with functionality derived from std::vector<T>. The class is a singleton. All assemblies are registered with G4AssemblyStore, and removed on their destruction.

Definition at line 61 of file G4AssemblyStore.hh.

Member Function Documentation

Clean()

void G4AssemblyStore::Clean ( )

static

Deletes all assemblies from the store.

Definition at line 69 of file G4AssemblyStore.cc.

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

Referenced by G4RunManager::ReinitializeGeometry().

DeRegister()

void G4AssemblyStore::DeRegister ( G4AssemblyVolume * pAssembly )

static

Removes the assembly from the collection.

Definition at line 121 of file G4AssemblyStore.cc.

{
  if (!locked)    // Do not de-register if locked !
  {
    if (fgNotifier != nullptr)  { fgNotifier->NotifyDeRegistration(); }
    for (auto i=GetInstance()->cbegin(); i!=GetInstance()->cend(); ++i)
    {
      if (*i==pAssembly)
      {
        GetInstance()->erase(i);
        break;
      }
    }
  }
}

Referenced by G4AssemblyVolume::~G4AssemblyVolume().

GetAssembly()

G4AssemblyVolume * G4AssemblyStore::GetAssembly	(	unsigned int	id,
		G4bool	verbose = true ) const

Returns an assembly through its Id number specification.

Definition at line 156 of file G4AssemblyStore.cc.

{
  for (const auto & i : *GetInstance())
  {
    if (i->GetAssemblyID() == id) { return i; }
  }
  if (verbose)
  {
    std::ostringstream message;
    message << "Assembly NOT found in store !" << G4endl
            << "        Assembly " << id << " NOT found in store !" << G4endl
            << "        Returning NULL pointer.";
    G4Exception("G4AssemblyStore::GetAssembly()",
                "GeomVol1001", JustWarning, message);
  }
  return nullptr;
}

Referenced by G4GDMLWriteStructure::AssemblyWrite(), G4AssemblyVolume::G4AssemblyVolume(), G4AssemblyVolume::G4AssemblyVolume(), and G4GDMLWriteStructure::TraverseVolumeTree().

GetInstance()

G4AssemblyStore * G4AssemblyStore::GetInstance ( )

static

Gets a pointer to the unique G4AssemblyStore, creating it if necessary.

Definition at line 141 of file G4AssemblyStore.cc.

{
  static G4AssemblyStore assemblyStore;
  if (fgInstance == nullptr)
  {
    fgInstance = &assemblyStore;
  }
  return fgInstance;
}

Referenced by G4GDMLWriteStructure::AssemblyWrite(), Clean(), DeRegister(), G4AssemblyVolume::G4AssemblyVolume(), G4AssemblyVolume::G4AssemblyVolume(), GetAssembly(), Register(), G4RunManager::ReinitializeGeometry(), SetNotifier(), G4GDMLWriteStructure::StructureWrite(), G4GDMLWriteStructure::TraverseVolumeTree(), and G4AssemblyVolume::~G4AssemblyVolume().

Register()

void G4AssemblyStore::Register ( G4AssemblyVolume * pAssembly )

static

Adds the assembly to the collection.

Definition at line 111 of file G4AssemblyStore.cc.

{
  GetInstance()->push_back(pAssembly);
  if (fgNotifier != nullptr)  { fgNotifier->NotifyRegistration(); }
}

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

SetNotifier()

void G4AssemblyStore::SetNotifier ( G4VStoreNotifier * pNotifier )

static

Assigns a notifier for allocation/deallocation of assemblies.

Definition at line 101 of file G4AssemblyStore.cc.

{
  GetInstance();
  fgNotifier = pNotifier;
}

---

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

• G4AssemblyStore.hh
• G4AssemblyStore.cc