Files
geant4/source/intercoms/include/G4StateManager.hh
T
2016-06-08 15:34:16 +02:00

98 lines
3.3 KiB
C++

// This code implementation is the intellectual property of
// the GEANT4 collaboration.
//
// By copying, distributing or modifying the Program (or any work
// based on the Program) you indicate your acceptance of this statement,
// and all its terms.
//
// $Id: G4StateManager.hh,v 1.5 2000/02/14 12:24:41 asaim Exp $
// GEANT4 tag $Name: geant4-01-01 $
//
//
// ------------------------------------------------------------
// GEANT 4 class header file
//
// For information related to this code contact:
// CERN, CN Division, ASD group
// ---------------- G4StateManager ----------------
// by Gabriele Cosmo, November 1996
#ifndef G4StateManager_h
#define G4StateManager_h 1
#include "g4rw/tpordvec.h"
#include "globals.hh"
#include "G4ApplicationState.hh"
#include "G4VStateDependent.hh"
// Class Description:
//
// Class responsible for handling and updating the running state
// of the Geant4 application during its different phases.
// The class is a singleton, it can be accessed via the public
// method G4StateManager::GetStateManager().
//
// States defined in Geant4 are descrived in G4ApplicationState.hh
//
class G4StateManager {
public: // with description
static G4StateManager* GetStateManager();
// This G4StateManager class is a singleton class and the pointer
// to the only one existing object can be obtained by this static
// method.
protected:
G4StateManager();
public:
~G4StateManager();
public: // with description
G4ApplicationState GetCurrentState();
// Returns the current state
G4ApplicationState GetPreviousState();
// Returns the previous state
G4bool SetNewState(G4ApplicationState requestedState);
// Set Geant4 to a new state.
// In case the request is irregal, false will be returned
// and the state of Geant4 will not be changed.
G4bool RegisterDependent(G4VStateDependent* aDependent);
// Register a concrete class of G4VStateDependent.
// Registered concrete classes will be notified via
// G4VStateDependent::Notify() method when the state of
// Geant4 changes.
// False will be returned if registration if failed.
G4bool DeregisterDependent(G4VStateDependent* aDependent);
// Remove the registration.
// False will be returned if aDependent has not been registered.
G4VStateDependent* RemoveDependent(const G4VStateDependent* aDependent);
// Remove the registration.
// Removed pointer is returned.
G4String GetStateString(G4ApplicationState aState);
// A utility method which returns a string of the state name.
void Pause();
void Pause(const char* msg);
void Pause(G4String msg);
// G4UIsession::pauseSession() will be invoked. The argument string "msg"
// will be used as a prompt characters if the session is non-graphical.
// This method can be invoked by any user action class during the event
// loop. After the user's interactions, control goes back to the caller.
private:
G4StateManager(const G4StateManager &right);
G4StateManager& operator=(const G4StateManager &right);
G4int operator==(const G4StateManager &right) const;
G4int operator!=(const G4StateManager &right) const;
private:
static G4StateManager* theStateManager;
G4ApplicationState theCurrentState;
G4ApplicationState thePreviousState;
G4RWTPtrOrderedVector<G4VStateDependent> theDependentsList;
};
#endif