G4StateManager Class Reference

#include <G4StateManager.hh>

Public Member Functions
G4bool	DeregisterDependent (G4VStateDependent *aDependent)
	G4StateManager (const G4StateManager &)=delete
const G4ApplicationState &	GetCurrentState () const
G4VExceptionHandler *	GetExceptionHandler () const
const char *	GetMessage () const
const G4ApplicationState &	GetPreviousState () const
G4String	GetStateString (const G4ApplicationState &aState) const
G4int	GetSuppressAbortion () const
G4bool	operator!= (const G4StateManager &) const =delete
G4StateManager &	operator= (const G4StateManager &)=delete
G4bool	operator== (const G4StateManager &) const =delete
G4bool	RegisterDependent (G4VStateDependent *aDependent, G4bool bottom=false)
G4VStateDependent *	RemoveDependent (const G4VStateDependent *aDependent)
void	SetExceptionHandler (G4VExceptionHandler *eh)
G4bool	SetNewState (const G4ApplicationState &requestedState)
G4bool	SetNewState (const G4ApplicationState &requestedState, const char *msg)
void	SetSuppressAbortion (G4int i)
	~G4StateManager ()

Static Public Member Functions
static G4StateManager *	GetStateManager ()
static void	SetVerboseLevel (G4int val)

Private Member Functions
	G4StateManager ()

Private Attributes
G4VExceptionHandler *	exceptionHandler = nullptr
const char *	msgptr = nullptr
G4int	suppressAbortion = 0
G4VStateDependent *	theBottomDependent = nullptr
G4ApplicationState	theCurrentState = G4State_PreInit
std::vector< G4VStateDependent * >	theDependentsList
G4ApplicationState	thePreviousState = G4State_PreInit

Static Private Attributes
static G4ThreadLocal G4StateManager *	theStateManager = nullptr
static G4int	verboseLevel = 0

Detailed Description

Definition at line 49 of file G4StateManager.hh.

Constructor & Destructor Documentation

~G4StateManager()

G4StateManager::~G4StateManager

(

)

Definition at line 47 of file G4StateManager.cc.

{
  G4VStateDependent* state = nullptr;
 
  while(theDependentsList.size() > 0)
  {
    state = theDependentsList.back();
    theDependentsList.pop_back();
    for(auto i = theDependentsList.cbegin(); i != theDependentsList.cend();)
    {
      if(*i == state)
      {
        i = theDependentsList.erase(i);
      }
      else
      {
        ++i;
      }
    }
    delete state;
  }
  theStateManager = nullptr;
#ifdef G4MULTITHREADED_DEACTIVATE
  G4iosFinalization();
#endif
}

References G4iosFinalization(), theDependentsList, and theStateManager.

G4StateManager() [1/2]

G4StateManager::G4StateManager ( const G4StateManager &  )

delete

G4StateManager() [2/2]

G4StateManager::G4StateManager ( )

private

Definition at line 40 of file G4StateManager.cc.

{
#ifdef G4MULTITHREADED
  G4iosInitialization();
#endif
}

References G4iosInitialization().

Referenced by GetStateManager().

Member Function Documentation

DeregisterDependent()

G4bool G4StateManager::DeregisterDependent

(

G4VStateDependent *

aDependent

)

Definition at line 105 of file G4StateManager.cc.

{
  G4VStateDependent* tmp = nullptr;
  for(auto i = theDependentsList.cbegin(); i != theDependentsList.cend();)
  {
    if(**i == *aDependent)
    {
      tmp = *i;
      i   = theDependentsList.erase(i);
    }
    else
    {
      ++i;
    }
  }
  return (tmp != nullptr);
}

References theDependentsList.

Referenced by G4VStateDependent::~G4VStateDependent().

GetCurrentState()

const G4ApplicationState & G4StateManager::GetCurrentState

(

)

const

Definition at line 124 of file G4StateManager.cc.

{
  return theCurrentState;
}

References theCurrentState.

Referenced by G4RunManager::AbortEvent(), G4MTRunManager::AbortRun(), G4RunManager::AbortRun(), G4TaskRunManager::AbortRun(), G4ProcessManager::ActivateProcess(), G4MTcoutDestination::AddMasterOutput(), G4RunManager::ConfirmBeamOnCondition(), G4RunManagerKernel::DefineWorldVolume(), G4EventManager::DoProcessing(), export_G4StateManager(), G4ParticleDefinition::G4ParticleDefinition(), G4EventManager::GetUserInformation(), G4ProcessManager::InActivateProcess(), G4ErrorPropagatorManager::InitGeant4e(), G4RunManager::Initialize(), G4RunManager::InitializeGeometry(), G4RunManager::InitializePhysics(), G4RunManagerKernel::InitializePhysics(), G4UIcommand::IsAvailable(), G4EmParameters::IsLocked(), G4OpticalParameters::IsLocked(), G4DeexPrecoParameters::IsLocked(), G4UItcsh::MakePrompt(), G4VUIshell::MakePrompt(), G4ExceptionHandler::Notify(), G4VSceneHandler::ProcessScene(), G4ErrorPropagator::PropagateOneStep(), G4VModularPhysicsList::RegisterPhysics(), G4IonTable::Remove(), G4ParticleTable::Remove(), G4VModularPhysicsList::RemovePhysics(), G4VModularPhysicsList::ReplacePhysics(), G4RunManagerKernel::RunInitialization(), G4MaterialScanner::Scan(), G4MTcoutDestination::SetDefaultOutput(), G4ParticlePropertyTable::SetParticleProperty(), G4EventManager::SetUserInformation(), G4VelocityTable::SetVelocityTableProperties(), G4TheMTRayTracer::Trace(), G4TheRayTracer::Trace(), G4RunManagerKernel::UpdateRegion(), G4RunManagerKernel::WorkerDefineWorldVolume(), G4ParticleDefinition::~G4ParticleDefinition(), G4RunManager::~G4RunManager(), and G4RunManagerKernel::~G4RunManagerKernel().

GetExceptionHandler()

G4VExceptionHandler * G4StateManager::GetExceptionHandler ( ) const

inline

Referenced by G4Exception().

GetMessage()

const char * G4StateManager::GetMessage ( ) const

inline

GetPreviousState()

const G4ApplicationState & G4StateManager::GetPreviousState

(

)

const

Definition at line 130 of file G4StateManager.cc.

{
  return thePreviousState;
}

References thePreviousState.

Referenced by export_G4StateManager(), and G4VisStateDependent::Notify().

GetStateManager()

G4StateManager * G4StateManager::GetStateManager ( )

static

Definition at line 75 of file G4StateManager.cc.

{
  if(theStateManager == nullptr)
  {
    theStateManager = new G4StateManager;
  }
  return theStateManager;
}

References G4StateManager(), and theStateManager.

Referenced by G4RunManager::AbortEvent(), G4MTRunManager::AbortRun(), G4RunManager::AbortRun(), G4TaskRunManager::AbortRun(), G4ProcessManager::ActivateProcess(), G4ErrorPropagatorManager::CloseGeometry(), G4RunManager::ConfirmBeamOnCondition(), G4TheRayTracer::CreateBitMap(), G4UIcommandTree::CreateHTML(), G4RunManagerKernel::DefineWorldVolume(), G4MaterialScanner::DoScan(), G4ExceptionHandler::DumpTrackInfo(), export_G4StateManager(), pyG4Exception::f2_G4Exception(), G4EmParameters::G4EmParameters(), G4EventManager::G4EventManager(), G4Exception(), G4MTcoutDestination::G4MTcoutDestination(), G4OpticalParameters::G4OpticalParameters(), G4ParticleDefinition::G4ParticleDefinition(), G4RunManagerKernel::G4RunManagerKernel(), G4VExceptionHandler::G4VExceptionHandler(), G4VStateDependent::G4VStateDependent(), G4UIcontrolMessenger::GetCurrentValue(), G4DNAMolecularMaterial::GetDensityTableFor(), G4DNAMolecularMaterial::GetNumMolPerVolTableFor(), G4ProcessManager::InActivateProcess(), G4ErrorPropagatorManager::InitGeant4e(), G4RunManager::Initialize(), G4RunManager::InitializeGeometry(), G4RunManager::InitializePhysics(), G4RunManagerKernel::InitializePhysics(), G4UIcommand::IsAvailable(), G4HadronicParameters::IsLocked(), G4UItcsh::MakePrompt(), G4VUIshell::MakePrompt(), G4ExceptionHandler::Notify(), G4UImanager::Notify(), G4DNAMolecularMaterial::Notify(), G4VisStateDependent::Notify(), G4ErrorPropagatorManager::PrintG4State(), G4VSceneHandler::ProcessScene(), G4ErrorPropagator::PropagateOneStep(), PyG4ExceptionHandler::PyG4ExceptionHandler(), G4UIQt::ReceiveG4cerr(), G4VModularPhysicsList::RegisterPhysics(), G4IonTable::Remove(), G4ParticleTable::Remove(), G4VModularPhysicsList::RemovePhysics(), G4VModularPhysicsList::ReplacePhysics(), G4RunManagerKernel::RunInitialization(), G4RunManagerKernel::RunTermination(), G4MaterialScanner::Scan(), G4DeexPrecoParameters::SetDefaults(), G4UIcontrolMessenger::SetNewValue(), G4ParticlePropertyTable::SetParticleProperty(), G4VelocityTable::SetVelocityTableProperties(), SignalHandler(), G4TheMTRayTracer::Trace(), G4TheRayTracer::Trace(), G4RunManagerKernel::UpdateRegion(), G4RunManagerKernel::WorkerDefineWorldVolume(), G4ParticleDefinition::~G4ParticleDefinition(), G4RunManager::~G4RunManager(), G4RunManagerKernel::~G4RunManagerKernel(), and G4VStateDependent::~G4VStateDependent().

GetStateString()

G4String G4StateManager::GetStateString

(

const G4ApplicationState &

aState

)

const

Definition at line 211 of file G4StateManager.cc.

{
  G4String stateName;
  switch(aState)
  {
    case G4State_PreInit:
      stateName = "PreInit";
      break;
    case G4State_Init:
      stateName = "Init";
      break;
    case G4State_Idle:
      stateName = "Idle";
      break;
    case G4State_GeomClosed:
      stateName = "GeomClosed";
      break;
    case G4State_EventProc:
      stateName = "EventProc";
      break;
    case G4State_Quit:
      stateName = "Quit";
      break;
    case G4State_Abort:
      stateName = "Abort";
      break;
    default:
      stateName = "Unknown";
      break;
  }
  return stateName;
}

References G4State_Abort, G4State_EventProc, G4State_GeomClosed, G4State_Idle, G4State_Init, G4State_PreInit, and G4State_Quit.

Referenced by G4UIcommandTree::CreateHTML(), G4RunManagerKernel::DefineWorldVolume(), export_G4StateManager(), G4RunManagerKernel::InitializePhysics(), SetNewState(), G4TheMTRayTracer::Trace(), and G4RunManagerKernel::WorkerDefineWorldVolume().

GetSuppressAbortion()

G4int G4StateManager::GetSuppressAbortion ( ) const

inline

operator!=()

G4bool G4StateManager::operator!= ( const G4StateManager &  ) const

delete

operator=()

G4StateManager & G4StateManager::operator= ( const G4StateManager &  )

delete

operator==()

G4bool G4StateManager::operator== ( const G4StateManager &  ) const

delete

RegisterDependent()

G4bool G4StateManager::RegisterDependent	(	G4VStateDependent *	aDependent,
		G4bool	bottom = false
	)

Definition at line 85 of file G4StateManager.cc.

{
  G4bool ack = true;
  if(!bottom)
  {
    theDependentsList.push_back(aDependent);
  }
  else
  {
    if(theBottomDependent)
    {
      theDependentsList.push_back(theBottomDependent);
    }
    theBottomDependent = aDependent;
  }
  return ack;
}

References theBottomDependent, and theDependentsList.

Referenced by G4VStateDependent::G4VStateDependent().

RemoveDependent()

G4VStateDependent * G4StateManager::RemoveDependent

(

const G4VStateDependent *

aDependent

)

Definition at line 191 of file G4StateManager.cc.

{
  G4VStateDependent* tmp = nullptr;
  for(auto i = theDependentsList.cbegin(); i != theDependentsList.cend();)
  {
    if(**i == *aDependent)
    {
      tmp = *i;
      i   = theDependentsList.erase(i);
    }
    else
    {
      ++i;
    }
  }
  return tmp;
}

References theDependentsList.

SetExceptionHandler()

void G4StateManager::SetExceptionHandler ( G4VExceptionHandler *  eh )

inline

Referenced by G4VExceptionHandler::G4VExceptionHandler().

SetNewState() [1/2]

G4bool G4StateManager::SetNewState

(

const G4ApplicationState &

requestedState

)

Definition at line 136 of file G4StateManager.cc.

{
  return SetNewState(requestedState, nullptr);
}

References SetNewState().

Referenced by G4ErrorPropagatorManager::CloseGeometry(), G4TheRayTracer::CreateBitMap(), G4RunManagerKernel::DefineWorldVolume(), G4EventManager::DoProcessing(), G4MaterialScanner::DoScan(), G4RunManagerKernel::G4RunManagerKernel(), G4RunManager::Initialize(), G4RunManager::InitializeGeometry(), G4RunManager::InitializePhysics(), G4RunManagerKernel::InitializePhysics(), G4RunManagerKernel::RunInitialization(), G4RunManagerKernel::RunTermination(), SetNewState(), G4RunManagerKernel::WorkerDefineWorldVolume(), G4RunManager::~G4RunManager(), and G4RunManagerKernel::~G4RunManagerKernel().

SetNewState() [2/2]

G4bool G4StateManager::SetNewState	(	const G4ApplicationState &	requestedState,
		const char *	msg
	)

Definition at line 142 of file G4StateManager.cc.

{
  if(requestedState == G4State_Abort && suppressAbortion > 0)
  {
    if(suppressAbortion == 2)
    {
      return false;
    }
    if(theCurrentState == G4State_EventProc)
    {
      return false;
    }
  }
  msgptr                        = msg;
  std::size_t i                 = 0;
  G4bool ack                    = true;
  G4ApplicationState savedState = thePreviousState;
  thePreviousState              = theCurrentState;
 
  while((ack) && (i < theDependentsList.size()))
  {
    ack = theDependentsList[i]->Notify(requestedState);
    ++i;
  }
  if(theBottomDependent)
  {
    ack = theBottomDependent->Notify(requestedState);
  }
 
  if(!ack)
  {
    thePreviousState = savedState;
  }
  else
  {
    theCurrentState = requestedState;
    if(verboseLevel > 0)
    {
      G4cout << "#### G4StateManager::SetNewState from "
             << GetStateString(thePreviousState) << " to "
             << GetStateString(requestedState) << G4endl;
    }
  }
  msgptr = nullptr;
  return ack;
}

References G4cout, G4endl, G4State_Abort, G4State_EventProc, GetStateString(), msgptr, G4VStateDependent::Notify(), suppressAbortion, theBottomDependent, theCurrentState, theDependentsList, thePreviousState, and verboseLevel.

SetSuppressAbortion()

void G4StateManager::SetSuppressAbortion ( G4int  i )

inline

Referenced by G4UIcontrolMessenger::SetNewValue().

SetVerboseLevel()

void G4StateManager::SetVerboseLevel ( G4int  val )

static

Definition at line 245 of file G4StateManager.cc.

{ verboseLevel = val; }

References verboseLevel.

Field Documentation

exceptionHandler

G4VExceptionHandler* G4StateManager::exceptionHandler = nullptr

private

Definition at line 110 of file G4StateManager.hh.

msgptr

const char* G4StateManager::msgptr = nullptr

private

Definition at line 109 of file G4StateManager.hh.

Referenced by SetNewState().

suppressAbortion

G4int G4StateManager::suppressAbortion = 0

private

Definition at line 108 of file G4StateManager.hh.

Referenced by SetNewState().

theBottomDependent

G4VStateDependent* G4StateManager::theBottomDependent = nullptr

private

Definition at line 107 of file G4StateManager.hh.

Referenced by RegisterDependent(), and SetNewState().

theCurrentState

G4ApplicationState G4StateManager::theCurrentState = G4State_PreInit

private

Definition at line 104 of file G4StateManager.hh.

Referenced by GetCurrentState(), and SetNewState().

theDependentsList

std::vector<G4VStateDependent*> G4StateManager::theDependentsList

private

Definition at line 106 of file G4StateManager.hh.

Referenced by DeregisterDependent(), RegisterDependent(), RemoveDependent(), SetNewState(), and ~G4StateManager().

thePreviousState

G4ApplicationState G4StateManager::thePreviousState = G4State_PreInit

private

Definition at line 105 of file G4StateManager.hh.

Referenced by GetPreviousState(), and SetNewState().

theStateManager

G4ThreadLocal G4StateManager * G4StateManager::theStateManager = nullptr

staticprivate

Definition at line 103 of file G4StateManager.hh.

Referenced by GetStateManager(), and ~G4StateManager().

verboseLevel

G4int G4StateManager::verboseLevel = 0

staticprivate

Definition at line 111 of file G4StateManager.hh.

Referenced by SetNewState(), and SetVerboseLevel().

---

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

• source/global/management/include/G4StateManager.hh
• source/global/management/src/G4StateManager.cc