G4FieldManagerStore Class Reference

G4FieldManagerStore is a container for all field managers, with functionality derived from std::vector<T>. The class is a singleton. All field managers should be registered with G4FieldManagerStore, and removed on their destruction. Intended principally to enable resetting of 'state' at start of an event. More...

#include <G4FieldManagerStore.hh>

Inheritance diagram for G4FieldManagerStore:

Public Member Functions
void	ClearAllChordFindersState ()
	~G4FieldManagerStore ()

Static Public Member Functions
static G4FieldManagerStore *	GetInstance ()
static G4FieldManagerStore *	GetInstanceIfExist ()
static void	Register (G4FieldManager *pFieldMan)
static void	DeRegister (G4FieldManager *pFieldMan)
static void	Clean ()

Detailed Description

G4FieldManagerStore is a container for all field managers, with functionality derived from std::vector<T>. The class is a singleton. All field managers should be registered with G4FieldManagerStore, and removed on their destruction. Intended principally to enable resetting of 'state' at start of an event.

Definition at line 57 of file G4FieldManagerStore.hh.

Constructor & Destructor Documentation

~G4FieldManagerStore()

G4FieldManagerStore::~G4FieldManagerStore

(

)

Destructor: takes care to delete the allocated field managers.

Definition at line 78 of file G4FieldManagerStore.cc.

{
  Clean();
  fgInstance = nullptr;
}

Member Function Documentation

Clean()

void G4FieldManagerStore::Clean ( )

static

Deletes all managers from the store.

Definition at line 88 of file G4FieldManagerStore.cc.

{
  // Locks store for deletion of field managers. De-registration will be
  // performed at this stage. G4FieldManagers will not de-register themselves.
  //
  locked = true;  
 
  G4FieldManagerStore* store = GetInstance();
 
  for(const auto & pos : *store)
  {
    delete pos; 
  }
 
  locked = false;
  store->clear();
}

Referenced by ~G4FieldManagerStore().

ClearAllChordFindersState()

void G4FieldManagerStore::ClearAllChordFindersState

(

)

Loops over all field managers and calls each one to reset step estimate.

Definition at line 139 of file G4FieldManagerStore.cc.

{
  G4ChordFinder* pChordFnd;
   
  for (const auto & mgr : *GetInstance())
  {
    pChordFnd = mgr->GetChordFinder();
    if( pChordFnd != nullptr )
    {
      pChordFnd->ResetStepEstimate();
    }
  }
}

Referenced by G4Transportation::StartTracking().

DeRegister()

void G4FieldManagerStore::DeRegister ( G4FieldManager * pFieldMan )

static

Removes the field manager from the collection.

Definition at line 119 of file G4FieldManagerStore.cc.

{
  if (!locked)    // Do not de-register if locked !
  {
    for (auto i=GetInstance()->cbegin(); i!=GetInstance()->cend(); ++i)
    {
      if (*i==pFieldMgr)  //   For LogVol was **i == *pLogVolume ... Reason?
      {
        GetInstance()->erase(i);
        break;
      }
    }
  }
}

Referenced by G4FieldManager::~G4FieldManager().

GetInstance()

G4FieldManagerStore * G4FieldManagerStore::GetInstance ( )

static

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

Definition at line 46 of file G4FieldManagerStore.cc.

{
  if (fgInstance == nullptr)
  {
    fgInstance = new G4FieldManagerStore;
  }
  return fgInstance;
}

Referenced by Clean(), ClearAllChordFindersState(), DeRegister(), Register(), G4ITTransportation::StartTracking(), and G4Transportation::StartTracking().

GetInstanceIfExist()

G4FieldManagerStore * G4FieldManagerStore::GetInstanceIfExist ( )

static

Definition at line 59 of file G4FieldManagerStore.cc.

{
  return fgInstance;
}

Referenced by G4RunManagerKernel::~G4RunManagerKernel().

Register()

void G4FieldManagerStore::Register ( G4FieldManager * pFieldMan )

static

Adds the field manager to the collection.

Definition at line 110 of file G4FieldManagerStore.cc.

{
  GetInstance()->push_back(pFieldManager);
}

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

---

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

• G4FieldManagerStore.hh
• G4FieldManagerStore.cc