CexmcRunManager Class Reference

#include <CexmcRunManager.hh>

Inheritance diagram for CexmcRunManager:

Public Member Functions
	CexmcRunManager (const G4String &projectId="", const G4String &rProject="", G4bool overrideExistingProject=false)
virtual	~CexmcRunManager ()
void	SetPhysicsManager (CexmcPhysicsManager *physicsManager_)
void	SetProductionModelType (CexmcProductionModelType productionModelType_)
void	SetGdmlFileName (const G4String &gdmlFileName_)
void	SetGdmlFileValidation (G4bool on=true)
void	SetGuiMacroName (const G4String &guiMacroName_)
void	SetEventCountPolicy (CexmcEventCountPolicy value)
void	SetEventDataVerboseLevel (CexmcEventDataVerboseLevel value)
void	RegisterScenePrimitives (void)
void	EnableLiveHistograms (G4bool on=true)
void	BeamParticleChangeHook (void)
void	SetupConstructionHook (void)
CexmcPhysicsManager *	GetPhysicsManager (void)
CexmcProductionModelType	GetProductionModelType (void) const
G4String	GetGdmlFileName (void) const
G4bool	ShouldGdmlFileBeValidated (void) const
G4String	GetGuiMacroName (void) const
G4bool	ProjectIsSaved (void) const
G4bool	ProjectIsRead (void) const
G4String	GetProjectsDir (void) const
G4String	GetProjectId (void) const
G4bool	AreLiveHistogramsEnabled (void) const
CexmcEventDataVerboseLevel	GetEventDataVerboseLevel (void) const
Public Member Functions inherited from G4RunManager
	G4RunManager ()
virtual	~G4RunManager ()
virtual void	BeamOn (G4int n_event, const char *macroFile=0, G4int n_select=-1)
virtual void	Initialize ()
virtual void	DefineWorldVolume (G4VPhysicalVolume *worldVol, G4bool topologyIsChanged=true)
virtual void	AbortRun (G4bool softAbort=false)
virtual void	AbortEvent ()
virtual void	InitializeGeometry ()
virtual void	InitializePhysics ()
virtual G4bool	ConfirmBeamOnCondition ()
virtual void	RunInitialization ()
virtual void	RunTermination ()
virtual void	InitializeEventLoop (G4int n_event, const char *macroFile=0, G4int n_select=-1)
virtual void	ProcessOneEvent (G4int i_event)
virtual void	TerminateOneEvent ()
virtual void	TerminateEventLoop ()
virtual G4Event *	GenerateEvent (G4int i_event)
virtual void	AnalyzeEvent (G4Event *anEvent)
void	DumpRegion (const G4String &rname) const
void	DumpRegion (G4Region *region=0) const
virtual void	rndmSaveThisRun ()
virtual void	rndmSaveThisEvent ()
virtual void	RestoreRandomNumberStatus (const G4String &fileN)
virtual void	SetUserInitialization (G4VUserDetectorConstruction *userInit)
virtual void	SetUserInitialization (G4VUserPhysicsList *userInit)
virtual void	SetUserInitialization (G4VUserActionInitialization *userInit)
virtual void	SetUserInitialization (G4UserWorkerInitialization *userInit)
virtual void	SetUserInitialization (G4UserWorkerThreadInitialization *userInit)
virtual void	SetUserAction (G4UserRunAction *userAction)
virtual void	SetUserAction (G4VUserPrimaryGeneratorAction *userAction)
virtual void	SetUserAction (G4UserEventAction *userAction)
virtual void	SetUserAction (G4UserStackingAction *userAction)
virtual void	SetUserAction (G4UserTrackingAction *userAction)
virtual void	SetUserAction (G4UserSteppingAction *userAction)
const G4VUserDetectorConstruction *	GetUserDetectorConstruction () const
const G4VUserPhysicsList *	GetUserPhysicsList () const
const G4VUserActionInitialization *	GetUserActionInitialization () const
G4VUserActionInitialization *	GetNonConstUserActionInitialization () const
const G4UserWorkerInitialization *	GetUserWorkerInitialization () const
const G4UserWorkerThreadInitialization *	GetUserWorkerThreadInitialization () const
const G4UserRunAction *	GetUserRunAction () const
const G4VUserPrimaryGeneratorAction *	GetUserPrimaryGeneratorAction () const
const G4UserEventAction *	GetUserEventAction () const
const G4UserStackingAction *	GetUserStackingAction () const
const G4UserTrackingAction *	GetUserTrackingAction () const
const G4UserSteppingAction *	GetUserSteppingAction () const
void	SetNumberOfAdditionalWaitingStacks (G4int iAdd)
const G4String &	GetVersionString () const
void	SetPrimaryTransformer (G4PrimaryTransformer *pt)
void	StoreRandomNumberStatusToG4Event (G4int vl)
G4int	GetFlagRandomNumberStatusToG4Event () const
void	SetRandomNumberStore (G4bool flag)
G4bool	GetRandomNumberStore () const
void	SetRandomNumberStoreDir (const G4String &dir)
const G4String &	GetRandomNumberStoreDir () const
const G4String &	GetRandomNumberStatusForThisRun () const
const G4String &	GetRandomNumberStatusForThisEvent () const
void	SetRandomNumberStorePerEvent (G4bool flag)
G4bool	GetRandomNumberStorePerEvent () const
void	GeometryHasBeenModified (G4bool prop=true)
void	ReinitializeGeometry (G4bool destroyFirst=false, G4bool prop=true)
void	PhysicsHasBeenModified ()
void	CutOffHasBeenModified ()
void	ReOptimizeMotherOf (G4VPhysicalVolume *)
void	ReOptimize (G4LogicalVolume *)
void	SetVerboseLevel (G4int vl)
G4int	GetVerboseLevel () const
G4int	GetPrintProgress ()
void	SetPrintProgress (G4int i)
void	SetGeometryToBeOptimized (G4bool vl)
G4bool	GetGeometryToBeOptimized ()
void	SetNumberOfEventsToBeStored (G4int val)
const G4Run *	GetCurrentRun () const
G4Run *	GetNonConstCurrentRun () const
const G4Event *	GetCurrentEvent () const
const G4Event *	GetPreviousEvent (G4int i) const
void	SetRunIDCounter (G4int i)
G4int	GetNumberOfParallelWorld () const
void	SetNumberOfEventsToBeProcessed (G4int val)
G4int	GetNumberOfEventsToBeProcessed () const
G4int	GetNumberOfSelectEvents () const
G4String	GetSelectMacro () const
void	SetDCtable (G4DCtable *DCtbl)
RMType	GetRunManagerType () const
virtual void	ConstructScoringWorlds ()

Protected Member Functions
void	DoEventLoop (G4int nEvent, const char *macroFile, G4int nSelect)
Protected Member Functions inherited from G4RunManager
void	StackPreviousEvent (G4Event *anEvent)
	G4RunManager (RMType rmType)
virtual void	StoreRNGStatus (const G4String &filenamePrefix)
void	UpdateScoring ()
virtual void	DeleteUserInitializations ()

Additional Inherited Members
Public Types inherited from G4RunManager
enum	RMType { sequentialRM, masterRM, workerRM }
Static Public Member Functions inherited from G4RunManager
static G4RunManager *	GetRunManager ()
Protected Attributes inherited from G4RunManager
G4RunManagerKernel *	kernel
G4EventManager *	eventManager
G4VUserDetectorConstruction *	userDetector
G4VUserPhysicsList *	physicsList
G4VUserActionInitialization *	userActionInitialization
G4UserWorkerInitialization *	userWorkerInitialization
G4UserWorkerThreadInitialization *	userWorkerThreadInitialization
G4UserRunAction *	userRunAction
G4VUserPrimaryGeneratorAction *	userPrimaryGeneratorAction
G4UserEventAction *	userEventAction
G4UserStackingAction *	userStackingAction
G4UserTrackingAction *	userTrackingAction
G4UserSteppingAction *	userSteppingAction
G4bool	geometryInitialized
G4bool	physicsInitialized
G4bool	runAborted
G4bool	initializedAtLeastOnce
G4bool	geometryToBeOptimized
G4int	runIDCounter
G4int	verboseLevel
G4int	printModulo
G4Timer *	timer
G4DCtable *	DCtable
G4Run *	currentRun
G4Event *	currentEvent
std::vector< G4Event * > *	previousEvents
G4int	n_perviousEventsToBeStored
G4int	numberOfEventToBeProcessed
G4bool	storeRandomNumberStatus
G4int	storeRandomNumberStatusToG4Event
G4String	randomNumberStatusDir
G4String	randomNumberStatusForThisRun
G4String	randomNumberStatusForThisEvent
G4bool	rngStatusEventsFlag
G4VPhysicalVolume *	currentWorld
G4int	nParallelWorlds
G4String	msgText
G4int	n_select_msg
G4int	numberOfEventProcessed
G4String	selectMacro
G4bool	fakeRun
RMType	runManagerType

Detailed Description

Definition at line 68 of file CexmcRunManager.hh.

Constructor & Destructor Documentation

CexmcRunManager::CexmcRunManager ( const G4String &  projectId = "", const G4String &  rProject = "", G4bool  overrideExistingProject = false  )

explicit

Definition at line 105 of file CexmcRunManager.cc.

References CexmcProjectExists, CexmcWeirdException, ProjectIsRead(), and ProjectIsSaved().

                                                                    :
    basePhysicsUsed( CexmcPMFactoryInstance::GetBasePhysics() ),
    productionModelType( CexmcUnknownProductionModel ),
    gdmlFileName( "default.gdml" ), shouldGdmlFileBeValidated( true ),
    zipGdmlFile( false ), projectsDir( "." ), projectId( projectId ),
    rProject( rProject ), guiMacroName( "" ), cfFileName( "" ),
    eventCountPolicy( CexmcCountAllEvents ), areLiveHistogramsEnabled( false ),
    skipInteractionsWithoutEDTonWrite( true ),
    evDataVerboseLevel( CexmcWriteEventDataOnEveryEDT ),
    rEvDataVerboseLevel( CexmcWriteNoEventData ), numberOfEventsProcessed( 0 ),
    numberOfEventsProcessedEffective( 0 ), curEventRead( 0 ),
#ifdef CEXMC_USE_PERSISTENCY
    eventsArchive( NULL ), fastEventsArchive( NULL ),
#ifdef CEXMC_USE_CUSTOM_FILTER
    customFilter( NULL ),
#endif
#endif
    physicsManager( NULL ), messenger( NULL )
{
    /* this exception must be caught before creating the object! */
    if ( rProject != "" && rProject == projectId )
        throw CexmcException( CexmcWeirdException );

    const char *  projectsDirEnv( getenv( "CEXMC_PROJECTS_DIR" ) );

    if ( projectsDirEnv )
        projectsDir = projectsDirEnv;

    struct stat  tmp;
    if ( ProjectIsSaved() &&
         stat( ( projectsDir + "/" + projectId + ".rdb" ).c_str(), &tmp ) == 0
         && ! overrideExistingProject )
        throw CexmcException( CexmcProjectExists );

    messenger = new CexmcRunManagerMessenger( this );

#ifdef CEXMC_USE_PERSISTENCY
    if ( ProjectIsRead() )
        ReadPreinitProjectData();
#endif
}

CexmcRunManager::~CexmcRunManager ( )

virtual

Definition at line 150 of file CexmcRunManager.cc.

{
#ifdef CEXMC_USE_CUSTOM_FILTER
    delete customFilter;
#endif
    delete messenger;
}

Member Function Documentation

G4bool CexmcRunManager::AreLiveHistogramsEnabled ( void  ) const

inline

Definition at line 394 of file CexmcRunManager.hh.

{
    return areLiveHistogramsEnabled;
}

void CexmcRunManager::BeamParticleChangeHook

(

void

)

Definition at line 1348 of file CexmcRunManager.cc.

References CexmcEventAction::BeamParticleChangeHook(), CexmcWeirdException, and G4RunManager::userEventAction.

Referenced by CexmcParticleGunMessenger::SetNewValue().

{
    const CexmcEventAction *  eventAction(
                static_cast< const CexmcEventAction * >( userEventAction ) );
    if ( ! eventAction )
        throw CexmcException( CexmcWeirdException );

    CexmcEventAction *        theEventAction( const_cast< CexmcEventAction * >(
                                                                eventAction ) );
    theEventAction->BeamParticleChangeHook();
}

void CexmcRunManager::DoEventLoop ( G4int  nEvent, const char *  macroFile, G4int  nSelect  )

protectedvirtual

Reimplemented from G4RunManager.

Definition at line 885 of file CexmcRunManager.cc.

References cmd, G4cout, G4endl, ProjectIsRead(), ProjectIsSaved(), G4RunManager::runAborted, G4Timer::Start(), G4Timer::Stop(), G4RunManager::timer, and G4RunManager::verboseLevel.

{
    if ( verboseLevel > 0 ) 
        timer->Start();

    G4String  cmd;
    if ( macroFile != 0 )
    {
        if ( nSelect < 0 )
            nSelect = nEvent;
        cmd = "/control/execute ";
        cmd += macroFile;
    }
    else
    {
        nSelect = -1;
    }

    numberOfEventsProcessed = 0;
    numberOfEventsProcessedEffective = 0;

#ifdef CEXMC_USE_PERSISTENCY
    eventsArchive = NULL;
    fastEventsArchive = NULL;
    if ( ProjectIsRead() )
    {
        if ( ProjectIsSaved() )
        {
            std::ofstream   eventsDataFile(
                        ( projectsDir + "/" + projectId + ".edb" ).c_str() );
            boost::archive::binary_oarchive  eventsArchive_( eventsDataFile );
            std::ofstream   fastEventsDataFile(
                        ( projectsDir + "/" + projectId + ".fdb" ).c_str() );
            boost::archive::binary_oarchive  fastEventsArchive_(
                                                        fastEventsDataFile );
            eventsArchive = &eventsArchive_;
            fastEventsArchive = &fastEventsArchive_;
            DoReadEventLoop( nEvent );
        }
        else
        {
            DoReadEventLoop( nEvent );
        }
    }
    else
    {
        if ( ProjectIsSaved() )
        {
            std::ofstream   eventsDataFile(
                        ( projectsDir + "/" + projectId + ".edb" ).c_str() );
            boost::archive::binary_oarchive  eventsArchive_( eventsDataFile );
            std::ofstream   fastEventsDataFile(
                        ( projectsDir + "/" + projectId + ".fdb" ).c_str() );
            boost::archive::binary_oarchive  fastEventsArchive_(
                                                        fastEventsDataFile );
            eventsArchive = &eventsArchive_;
            fastEventsArchive = &fastEventsArchive_;
            DoCommonEventLoop( nEvent, cmd, nSelect );
        }
        else
        {
            DoCommonEventLoop( nEvent, cmd, nSelect );
        }
    }
    eventsArchive = NULL;
    fastEventsArchive = NULL;
#else
    DoCommonEventLoop( nEvent, cmd, nSelect );
#endif

    if ( verboseLevel > 0 )
    {
        timer->Stop();
        G4cout << "Run terminated." << G4endl;
        G4cout << "Run Summary" << G4endl;
        if ( runAborted )
        {
            G4cout << "  Run Aborted after " << numberOfEventsProcessed <<
                      " events processed." << G4endl;
        }
        else
        {
            G4cout << "  Number of events processed : " <<
                      numberOfEventsProcessed << ", effectively: " <<
                      numberOfEventsProcessedEffective << G4endl;
        }
        G4cout << "  "  << *timer << G4endl;
    }
}

void CexmcRunManager::EnableLiveHistograms ( G4bool  on = true )

inline

Definition at line 388 of file CexmcRunManager.hh.

Referenced by main().

{
    areLiveHistogramsEnabled = on;
}

CexmcEventDataVerboseLevel CexmcRunManager::GetEventDataVerboseLevel ( void  ) const

inline

Definition at line 400 of file CexmcRunManager.hh.

{
    return evDataVerboseLevel;
}

G4String CexmcRunManager::GetGdmlFileName ( void  ) const

inline

Definition at line 301 of file CexmcRunManager.hh.

Referenced by main().

{
    return gdmlFileName;
}

G4String CexmcRunManager::GetGuiMacroName ( void  ) const

inline

Definition at line 313 of file CexmcRunManager.hh.

Referenced by main().

{
    return guiMacroName;
}

CexmcPhysicsManager * CexmcRunManager::GetPhysicsManager ( void  )

inline

Definition at line 288 of file CexmcRunManager.hh.

{
    return physicsManager;
}

CexmcProductionModelType CexmcRunManager::GetProductionModelType ( void  ) const

inline

Definition at line 295 of file CexmcRunManager.hh.

Referenced by main().

{
    return productionModelType;
}

G4String CexmcRunManager::GetProjectId ( void  ) const

inline

Definition at line 337 of file CexmcRunManager.hh.

{
    return projectId;
}

G4String CexmcRunManager::GetProjectsDir ( void  ) const

inline

Definition at line 331 of file CexmcRunManager.hh.

{
    return projectsDir;
}

G4bool CexmcRunManager::ProjectIsRead ( void  ) const

inline

Definition at line 325 of file CexmcRunManager.hh.

Referenced by CexmcRunManager(), CexmcEnergyDepositDigitizer::Digitize(), DoEventLoop(), main(), SetEventCountPolicy(), SetEventDataVerboseLevel(), SetGdmlFileName(), SetProductionModelType(), SetupConstructionHook(), and ThrowExceptionIfProjectIsRead().

{
    return rProject != "";
}

G4bool CexmcRunManager::ProjectIsSaved ( void  ) const

inline

Definition at line 319 of file CexmcRunManager.hh.

Referenced by CexmcRunManager(), DoEventLoop(), main(), and SetupConstructionHook().

{
    return projectId != "";
}

void CexmcRunManager::RegisterScenePrimitives

(

void

)

Definition at line 1308 of file CexmcRunManager.cc.

References CexmcScenePrimitivesDescription, CexmcWeirdException, G4VVisManager::GetConcreteInstance(), G4VisManager::GetCurrentScene(), and G4RunManager::userDetector.

Referenced by CexmcRunManagerMessenger::SetNewValue().

{
    G4VisManager *  visManager( static_cast< G4VisManager * >(
                                    G4VVisManager::GetConcreteInstance() ) );
    if ( ! visManager )
        return;

    G4Scene *       curScene( visManager->GetCurrentScene() );
    if ( ! curScene )
        return;

    /* G4Scene declarations lack this kind of typedef */
#if G4VERSION_NUMBER < 960
    typedef std::vector< G4VModel * >      MList;
#else
    typedef std::vector< G4Scene::Model >  MList;
#endif
    const MList &  mList( curScene->GetRunDurationModelList() );

    for ( MList::const_iterator  k( mList.begin() ); k != mList.end(); ++k )
    {
#if G4VERSION_NUMBER < 960
        const G4String &  modelDesc( ( *k )->GetGlobalDescription() );
#else
        const G4String &  modelDesc( k->fpModel->GetGlobalDescription() );
#endif
        if ( modelDesc == CexmcScenePrimitivesDescription )
            return;
    }

    CexmcSetup *  setup( static_cast< CexmcSetup * >( userDetector ) );
    if ( ! setup )
        throw CexmcException( CexmcWeirdException );

    /* BEWARE: looks like G4Scene won't delete models from its lists upon
     * termination! Hence destructor of the new model won't be called */
    curScene->AddRunDurationModel( new CexmcScenePrimitives( setup ) );
}

void CexmcRunManager::SetEventCountPolicy ( CexmcEventCountPolicy  value )

inline

Definition at line 268 of file CexmcRunManager.hh.

References CexmcCmdIsNotAllowed, and ProjectIsRead().

Referenced by CexmcRunManagerMessenger::SetNewValue().

{
    if ( ProjectIsRead() )
        throw CexmcException( CexmcCmdIsNotAllowed );

    eventCountPolicy = value;
}

void CexmcRunManager::SetEventDataVerboseLevel ( CexmcEventDataVerboseLevel  value )

inline

Definition at line 278 of file CexmcRunManager.hh.

References CexmcPoorEventData, and ProjectIsRead().

Referenced by CexmcRunManagerMessenger::SetNewValue().

{
    if ( ProjectIsRead() && value > rEvDataVerboseLevel )
        throw CexmcException( CexmcPoorEventData );

    evDataVerboseLevel = value;
}

void CexmcRunManager::SetGdmlFileName ( const G4String &  gdmlFileName_ )

inline

Definition at line 247 of file CexmcRunManager.hh.

References CexmcCmdIsNotAllowed, and ProjectIsRead().

Referenced by CexmcRunManagerMessenger::SetNewValue().

{
    if ( ProjectIsRead() )
        throw CexmcException( CexmcCmdIsNotAllowed );

    gdmlFileName = gdmlFileName_;
}

void CexmcRunManager::SetGdmlFileValidation ( G4bool  on = true )

inline

Definition at line 256 of file CexmcRunManager.hh.

Referenced by CexmcRunManagerMessenger::SetNewValue().

{
    shouldGdmlFileBeValidated = on;
}

void CexmcRunManager::SetGuiMacroName ( const G4String &  guiMacroName_ )

inline

Definition at line 262 of file CexmcRunManager.hh.

Referenced by CexmcRunManagerMessenger::SetNewValue().

{
    guiMacroName = guiMacroName_;
}

void CexmcRunManager::SetPhysicsManager ( CexmcPhysicsManager *  physicsManager_ )

inline

Definition at line 230 of file CexmcRunManager.hh.

Referenced by main().

{
    physicsManager = physicsManager_;
}

void CexmcRunManager::SetProductionModelType ( CexmcProductionModelType  productionModelType_ )

inline

Definition at line 237 of file CexmcRunManager.hh.

References CexmcCmdIsNotAllowed, and ProjectIsRead().

Referenced by CexmcRunManagerMessenger::SetNewValue().

{
    if ( ProjectIsRead() )
        throw CexmcException( CexmcCmdIsNotAllowed );

    productionModelType = productionModelType_;
}

void CexmcRunManager::SetupConstructionHook

(

void

)

Definition at line 1361 of file CexmcRunManager.cc.

References CexmcFileCompressException, CexmcSystemException, cmd, ProjectIsRead(), and ProjectIsSaved().

Referenced by CexmcSetup::Construct().

{
#ifdef CEXMC_USE_PERSISTENCY
    /* save gdml file */
    G4String            cmd( "" );
    CexmcExceptionType  exceptionType( CexmcSystemException );

    if ( zipGdmlFile )
    {
        if ( ProjectIsRead() )
        {
            cmd = G4String( "bzip2 " ) + projectsDir + "/" + rProject +
                                                            gdmlFileExtension;
        }
        else
        {
            if ( ProjectIsSaved() )
                cmd = G4String( "bzip2 -c " ) + gdmlFileName + " > " +
                        projectsDir + "/" + projectId + gdmlbz2FileExtension;
        }
        exceptionType = CexmcFileCompressException;
    }
    else
    {
        if ( ! ProjectIsRead() && ProjectIsSaved() )
            cmd = G4String( "cp " ) + gdmlFileName + " " + projectsDir + "/" +
                                                projectId + gdmlFileExtension;
        /* else already saved in ReadPreinitProjectData() */
    }

    if ( ! cmd.empty() && system( cmd ) != 0 )
        throw CexmcException( exceptionType );
#endif
}

G4bool CexmcRunManager::ShouldGdmlFileBeValidated ( void  ) const

inline

Definition at line 307 of file CexmcRunManager.hh.

Referenced by main().

{
    return shouldGdmlFileBeValidated;
}

---

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

• CexmcRunManager.hh
• CexmcRunManager.cc