#include <BaseSimulationSvc.h>

Inheritance diagram for ISF::BaseSimulationSvc:

Collaboration diagram for ISF::BaseSimulationSvc:

Public Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Public Member Functions
	BaseSimulationSvc (const std::string &name, ISvcLocator *pSvcLocator)

virtual	~BaseSimulationSvc ()
	Destructor. More...

virtual StatusCode	sysInitialize () override
	Gaudi sysInitialize() methods. More...

std::string &	simSvcDescriptor () override
	Return the simulation service descriptor. More...

virtual StatusCode	setupEvent () override
	Setup Event chain - in case of a begin-of event action is needed. More...

virtual StatusCode	releaseEvent () override
	Release Event chain - in case of an end-of event action is needed. More...

virtual StatusCode	setParticleBroker (IParticleBroker *broker) override
	Inform the SimulationSvc about the ParticleBroker svc. More...

virtual StatusCode	simulateVector (const ISFParticleVector &particles, McEventCollection mcEventCollection, McEventCollection ) override
	Simulation call for vectors of particles. More...

virtual StatusCode	simulate (ISFParticle &isp, McEventCollection *mcEventCollection) override
	Simulation call for individual particles. More...

const ChronoEntity *	chronoStart (const IChronoSvc::ChronoTag &tag)
	wrapper call to start chrono with given tag More...

const ChronoEntity *	chronoStop (const IChronoSvc::ChronoTag &tag)
	wrapper call to stop chrono with given tag More...

const StoreGateSvc_t &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

StoreGateSvc_t &	evtStore ()

const StoreGateSvc_t &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

StoreGateSvc_t &	detStore ()

template<class T >
StatusCode	retrieveTool (ToolHandle< T > &thandle)
	templated Tool retrieval - gives unique handling & look and feel More...

template<class T >
StatusCode	retrieveTools (ToolHandleArray< T > &thandleArray)
	templated Tool retrieval - gives unique handling & look and feel More...

template<class T >
StatusCode	recordCollection (T *&coll, const std::string &collName) const
	templated record collection method, will create a new one if not existing More...

template<class T >
StatusCode	retrieveCollection (T *&coll, const std::string &collName, bool forceBreak=true) const
	templated retrieve collection method, boolean steers that force break More...

Protected Attributes
std::string	m_simDescr {""}
	The simulator service descriptor. More...

std::string	m_screenOutputPrefix {"isf >> "}
	Screen output refinement - can be changed by declareProperty() More...

std::string	m_chronoSvcName {"ChronoStatSvc"}
	Name of the timing service - can be set by declareProperty() More...

IChronoStatSvc *	m_chrono {}
	The timing service for general usage. More...

IParticleBroker *	m_particleBroker {}
	The particle service used to push particles into the simulation. More...

Private Member Functions
	BaseSimulationSvc ()
	Default constructor. More...

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

Detailed Description

Concrete base class for all simulation services.

It facilitates the use of event store and detector store, provides record and retrieve methods and initializes the ChronoStatSvc.

Author: Michael.Duehrssen -at- cern.ch, Andreas.Salzburger -at- cern.ch, Elmar.Ritsch -at- cern.ch

Definition at line 40 of file BaseSimulationSvc.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> ISF::BaseSimulationSvc::StoreGateSvc_t

Definition at line 135 of file BaseSimulationSvc.h.

Constructor & Destructor Documentation

◆ BaseSimulationSvc() [1/2]

ISF::BaseSimulationSvc::BaseSimulationSvc	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

inline

Definition at line 44 of file BaseSimulationSvc.h.

                                                                        :
       base_class(name,pSvcLocator),
       m_evtStore( "StoreGateSvc/StoreGateSvc",  name ),
       m_detStore( "StoreGateSvc/DetectorStore", name )
     {
       // to be set to a unique descriptor
       declareProperty( "Identifier",
                        m_simDescr,
                        "A unique string to identify the simulator.");
  
       declareProperty( "EvtStore",
                        m_evtStore = StoreGateSvc_t ("StoreGateSvc", name),
                        "Handle to a StoreGateSvc instance: it will be used to retrieve data during the course of the job" );
       declareProperty( "DetStore",
                        m_detStore = StoreGateSvc_t ("StoreGateSvc/DetectorStore", name),
                        "Handle to a StoreGateSvc/DetectorStore instance: it will be used to retrieve data during the course of the job" );
       // refine the screen output for debugging
       declareProperty("ScreenOutputPrefix",   m_screenOutputPrefix);
       // Service handling
       declareProperty("ChronoStatService",    m_chronoSvcName     );
  
     };

◆ ~BaseSimulationSvc()

virtual ISF::BaseSimulationSvc::~BaseSimulationSvc ( )

inlinevirtual

Destructor.

Definition at line 68 of file BaseSimulationSvc.h.

68 {};

◆ BaseSimulationSvc() [2/2]

ISF::BaseSimulationSvc::BaseSimulationSvc ( )

private

Default constructor.

Member Function Documentation

◆ chronoStart()

const ChronoEntity* ISF::BaseSimulationSvc::chronoStart ( const IChronoSvc::ChronoTag & tag )

inline

wrapper call to start chrono with given tag

Definition at line 124 of file BaseSimulationSvc.h.

                                                                      {
       if (m_chrono) return m_chrono->chronoStart( tag);
       return nullptr;
     }

◆ chronoStop()

const ChronoEntity* ISF::BaseSimulationSvc::chronoStop ( const IChronoSvc::ChronoTag & tag )

inline

wrapper call to stop chrono with given tag

Definition at line 130 of file BaseSimulationSvc.h.

                                                                     {
       if (m_chrono) return m_chrono->chronoStop( tag);
       return nullptr;
     }

◆ detStore() [1/2]

StoreGateSvc_t& ISF::BaseSimulationSvc::detStore ( )

inline

Definition at line 147 of file BaseSimulationSvc.h.

147 {return m_detStore;};

◆ detStore() [2/2]

const StoreGateSvc_t& ISF::BaseSimulationSvc::detStore ( ) const

inline

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 146 of file BaseSimulationSvc.h.

146 {return m_detStore;};

◆ evtStore() [1/2]

StoreGateSvc_t& ISF::BaseSimulationSvc::evtStore ( )

inline

Definition at line 141 of file BaseSimulationSvc.h.

141 {return m_evtStore;};

◆ evtStore() [2/2]

const StoreGateSvc_t& ISF::BaseSimulationSvc::evtStore ( ) const

inline

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 140 of file BaseSimulationSvc.h.

140 {return m_evtStore;};

◆ recordCollection()

template<class T >

StatusCode ISF::BaseSimulationSvc::recordCollection	(	T *&	coll,
		const std::string &	collName
	)		const

inline

templated record collection method, will create a new one if not existing

Definition at line 172 of file BaseSimulationSvc.h.

                                                                            {
       // create if necessary
       coll = coll ? coll : new T;
       // record
       if (evtStore()->record( coll, collName).isFailure()){
         ATH_MSG_FATAL( m_screenOutputPrefix << "Cannot record collection " <<  collName << ". Abort." );
         return StatusCode::FAILURE;
       } else
         ATH_MSG_DEBUG(m_screenOutputPrefix << "Successfully recorded collection " << collName);
       return StatusCode::SUCCESS;
     }

◆ releaseEvent()

virtual StatusCode ISF::BaseSimulationSvc::releaseEvent ( )

inlineoverridevirtual

Release Event chain - in case of an end-of event action is needed.

Reimplemented in ISF::DNNCaloSimSvc, iGeant4::Geant4SimSvc, and ISF::LegacySimSvc.

Definition at line 93 of file BaseSimulationSvc.h.

94 { return StatusCode::SUCCESS; }

◆ retrieveCollection()

template<class T >

StatusCode ISF::BaseSimulationSvc::retrieveCollection	(	T *&	coll,
		const std::string &	collName,
		bool	forceBreak = `true`
	)		const

inline

templated retrieve collection method, boolean steers that force break

Definition at line 186 of file BaseSimulationSvc.h.

                                                                                                    {
       // check for existence in the soft case
       if (!forceBreak && !evtStore()->contains<T>(collName)) {
         coll = 0;
         ATH_MSG_DEBUG(m_screenOutputPrefix << "Collection does not exists (not required). Ignore.");
         return StatusCode::SUCCESS;
       }
       if ( evtStore()->retrieve(coll, collName).isFailure()){
         ATH_MSG_FATAL( m_screenOutputPrefix << "Cannot retireve collection " <<  collName << ". Abort." );
         return StatusCode::FAILURE;
       } else
         ATH_MSG_DEBUG(m_screenOutputPrefix << "Successfully retrieved collection " << collName);
       return StatusCode::SUCCESS;
     }

◆ retrieveTool()

template<class T >

StatusCode ISF::BaseSimulationSvc::retrieveTool ( ToolHandle< T > & thandle )

inline

templated Tool retrieval - gives unique handling & look and feel

Definition at line 150 of file BaseSimulationSvc.h.

                                                                       {
       if (!thandle.empty() && thandle.retrieve().isFailure()){
         ATH_MSG_FATAL( m_screenOutputPrefix << "Cannot retrieve " << thandle << ". Abort.");
         return StatusCode::FAILURE;
       } else
         ATH_MSG_DEBUG(m_screenOutputPrefix << "Successfully retrieved " << thandle);
       return StatusCode::SUCCESS;
     }

◆ retrieveTools()

template<class T >

StatusCode ISF::BaseSimulationSvc::retrieveTools ( ToolHandleArray< T > & thandleArray )

inline

templated Tool retrieval - gives unique handling & look and feel

Definition at line 161 of file BaseSimulationSvc.h.

                                                               {
       if (!thandleArray.empty() && thandleArray.retrieve().isFailure()){
         ATH_MSG_FATAL( m_screenOutputPrefix << "Cannot retrieve " << thandleArray << ". Abort.");
         return StatusCode::FAILURE;
       } else
         ATH_MSG_DEBUG(m_screenOutputPrefix << "Successfully retrieved " << thandleArray);
       return StatusCode::SUCCESS;
     }

◆ setParticleBroker()

virtual StatusCode ISF::BaseSimulationSvc::setParticleBroker ( IParticleBroker * broker )

inlineoverridevirtual

Inform the SimulationSvc about the ParticleBroker svc.

Definition at line 97 of file BaseSimulationSvc.h.

                                                                             {
       m_particleBroker = broker;
       return StatusCode::SUCCESS;
     }

◆ setupEvent()

virtual StatusCode ISF::BaseSimulationSvc::setupEvent ( )

inlineoverridevirtual

Setup Event chain - in case of a begin-of event action is needed.

Reimplemented in ISF::DNNCaloSimSvc, iGeant4::Geant4SimSvc, and ISF::LegacySimSvc.

Definition at line 89 of file BaseSimulationSvc.h.

90 { return StatusCode::SUCCESS; }

◆ simSvcDescriptor()

std::string& ISF::BaseSimulationSvc::simSvcDescriptor ( )

inlineoverride

Return the simulation service descriptor.

Definition at line 86 of file BaseSimulationSvc.h.

86 { return m_simDescr; }

◆ simulate()

StatusCode ISF::BaseSimulationSvc::simulate	(	ISFParticle &	isp,
		McEventCollection *	mcEventCollection
	)

inlineoverridevirtual

Simulation call for individual particles.

Simulation Call — hand over to the particleProcessor if it exists.

Reimplemented in ISF::LegacySimSvc, ISF::DNNCaloSimSvc, and iGeant4::Geant4SimSvc.

Definition at line 232 of file BaseSimulationSvc.h.

   {
     return StatusCode::SUCCESS;
   }

◆ simulateVector()

virtual StatusCode ISF::BaseSimulationSvc::simulateVector	(	const ISFParticleVector &	particles,
		McEventCollection *	mcEventCollection,
		McEventCollection *
	)

inlineoverridevirtual

Simulation call for vectors of particles.

Reimplemented in iGeant4::Geant4SimSvc.

Definition at line 103 of file BaseSimulationSvc.h.

                                                                                                                                               {
       // this implementation is a wrapper in case the simulator does
       // implement particle-vector input
       bool success = true;
       // simulate each particle individually
       for (ISF::ISFParticle* part : particles) {
         ATH_MSG_VERBOSE( m_screenOutputPrefix <<  "Starting simulation of particle: " << part );
         if ( this->simulate(*part, mcEventCollection).isFailure()) {
           ATH_MSG_WARNING("Simulation of particle failed!" << endmsg <<
                           "   -> simulator: " << this->simSvcDescriptor() <<
                           "   -> particle : " << *part );
           success = false;
         }
       }
       return ( success ) ? StatusCode::SUCCESS : StatusCode::FAILURE;
     }

◆ sysInitialize()

virtual StatusCode ISF::BaseSimulationSvc::sysInitialize ( )

inlineoverridevirtual

Gaudi sysInitialize() methods.

Definition at line 71 of file BaseSimulationSvc.h.

     {
       if ( AthService::sysInitialize().isFailure() ) {
         ATH_MSG_FATAL( m_screenOutputPrefix << " Cannot initialize AthService! Abort.");
         return StatusCode::FAILURE;
       }
       if ( serviceLocator()->service(m_chronoSvcName, m_chrono ).isFailure()){
         ATH_MSG_FATAL( m_screenOutputPrefix << " Cannot retrieve ChronoStatSvc! Abort.");
         return StatusCode::FAILURE;
       }
  
       return StatusCode::SUCCESS;
     }

Member Data Documentation

◆ m_chrono

IChronoStatSvc* ISF::BaseSimulationSvc::m_chrono {}

protected

The timing service for general usage.

Definition at line 223 of file BaseSimulationSvc.h.

◆ m_chronoSvcName

std::string ISF::BaseSimulationSvc::m_chronoSvcName {"ChronoStatSvc"}

protected

Name of the timing service - can be set by declareProperty()

Definition at line 220 of file BaseSimulationSvc.h.

◆ m_detStore

StoreGateSvc_t ISF::BaseSimulationSvc::m_detStore

private

Pointer to StoreGate (detector store by default)

Definition at line 209 of file BaseSimulationSvc.h.

◆ m_evtStore

StoreGateSvc_t ISF::BaseSimulationSvc::m_evtStore

private

Pointer to StoreGate (event store by default)

Definition at line 206 of file BaseSimulationSvc.h.

◆ m_particleBroker

IParticleBroker* ISF::BaseSimulationSvc::m_particleBroker {}

protected

The particle service used to push particles into the simulation.

Definition at line 226 of file BaseSimulationSvc.h.

◆ m_screenOutputPrefix

std::string ISF::BaseSimulationSvc::m_screenOutputPrefix {"isf >> "}

protected

Screen output refinement - can be changed by declareProperty()

Definition at line 217 of file BaseSimulationSvc.h.

◆ m_simDescr

std::string ISF::BaseSimulationSvc::m_simDescr {""}

protected

The simulator service descriptor.

Definition at line 214 of file BaseSimulationSvc.h.

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

BaseSimulationSvc.h

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ BaseSimulationSvc() [1/2]

◆ ~BaseSimulationSvc()

◆ BaseSimulationSvc() [2/2]

Member Function Documentation

◆ chronoStart()

◆ chronoStop()

◆ detStore() [1/2]

◆ detStore() [2/2]

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ recordCollection()

◆ releaseEvent()

◆ retrieveCollection()

◆ retrieveTool()

◆ retrieveTools()

◆ setParticleBroker()

◆ setupEvent()

◆ simSvcDescriptor()

◆ simulate()

◆ simulateVector()

◆ sysInitialize()

Member Data Documentation

◆ m_chrono

◆ m_chronoSvcName

◆ m_detStore

◆ m_evtStore

◆ m_particleBroker

◆ m_screenOutputPrefix

◆ m_simDescr