#include <LegacySimSvc.h>

Inheritance diagram for ISF::LegacySimSvc:

Collaboration diagram for ISF::LegacySimSvc:

Public Member Functions
	LegacySimSvc (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor. More...

virtual	~LegacySimSvc ()=default
	Destructor. More...

virtual StatusCode	initialize () override
	Athena algorithm's interface methods. More...

virtual StatusCode	simulate (ISFParticle &isp, McEventCollection *mcEventCollection) override
	Simulation Call. 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	sysInitialize () override
	Gaudi sysInitialize() methods. More...

const std::string &	simSvcDescriptor () override
	Return the simulation service descriptor. 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...

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 ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

ServiceHandle< StoreGateSvc > &	evtStore ()

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

ServiceHandle< StoreGateSvc > &	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
Gaudi::Property< std::string >	m_simDescr
	The simulator service descriptor. More...

Gaudi::Property< std::string >	m_screenOutputPrefix
	Screen output refinement. More...

ServiceHandle< IChronoStatSvc >	m_chrono {this, "ChronoStatService", "ChronoStatSvc"}
	The timing service for general usage. More...

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

Private Attributes
PublicToolHandle< ISimulatorTool >	m_simulatorTool {this, "SimulatorTool", "", ""}

ServiceHandle< StoreGateSvc >	m_evtStore
	Handle to StoreGate (event store by default) More...

ServiceHandle< StoreGateSvc >	m_detStore
	Handle to StoreGate (detector store by default) More...

Detailed Description

Definition at line 24 of file LegacySimSvc.h.

Constructor & Destructor Documentation

◆ LegacySimSvc()

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

Constructor.

Definition at line 10 of file LegacySimSvc.cxx.

                                                                     :
   BaseSimulationSvc(name, svc)
 {
 }

◆ ~LegacySimSvc()

virtual ISF::LegacySimSvc::~LegacySimSvc ( )

virtualdefault

Destructor.

Member Function Documentation

◆ chronoStart()

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

inlineinherited

wrapper call to start chrono with given tag

Definition at line 104 of file BaseSimulationSvc.h.

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

◆ chronoStop()

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

inlineinherited

wrapper call to stop chrono with given tag

Definition at line 110 of file BaseSimulationSvc.h.

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

◆ detStore() [1/2]

ServiceHandle<StoreGateSvc>& ISF::BaseSimulationSvc::detStore ( )

inlineinherited

Definition at line 125 of file BaseSimulationSvc.h.

125 {return m_detStore;};

◆ detStore() [2/2]

const ServiceHandle<StoreGateSvc>& ISF::BaseSimulationSvc::detStore ( ) const

inlineinherited

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

Definition at line 124 of file BaseSimulationSvc.h.

124 {return m_detStore;};

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& ISF::BaseSimulationSvc::evtStore ( )

inlineinherited

Definition at line 119 of file BaseSimulationSvc.h.

119 {return m_evtStore;};

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& ISF::BaseSimulationSvc::evtStore ( ) const

inlineinherited

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

Definition at line 118 of file BaseSimulationSvc.h.

118 {return m_evtStore;};

◆ initialize()

StatusCode ISF::LegacySimSvc::initialize ( )

overridevirtual

Athena algorithm's interface methods.

framework methods

Definition at line 16 of file LegacySimSvc.cxx.

 {
   m_checkToolDeps = false;
   ATH_CHECK ( m_simulatorTool.retrieve() );
   return StatusCode::SUCCESS;
 }

◆ recordCollection()

template<class T >

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

inlineinherited

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

Definition at line 150 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()

StatusCode ISF::LegacySimSvc::releaseEvent ( )

overridevirtual

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

Reimplemented from ISF::BaseSimulationSvc.

Definition at line 28 of file LegacySimSvc.cxx.

 {
   return m_simulatorTool->releaseEventST();
 }

◆ retrieveCollection()

template<class T >

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

inlineinherited

templated retrieve collection method, boolean steers that force break

Definition at line 164 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 )

inlineinherited

templated Tool retrieval - gives unique handling & look and feel

Definition at line 128 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 )

inlineinherited

templated Tool retrieval - gives unique handling & look and feel

Definition at line 139 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 )

inlineoverridevirtualinherited

Inform the SimulationSvc about the ParticleBroker svc.

Definition at line 77 of file BaseSimulationSvc.h.

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

◆ setupEvent()

StatusCode ISF::LegacySimSvc::setupEvent ( )

overridevirtual

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

Reimplemented from ISF::BaseSimulationSvc.

Definition at line 23 of file LegacySimSvc.cxx.

 {
   return m_simulatorTool->setupEventST();
 }

◆ simSvcDescriptor()

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

inlineoverrideinherited

Return the simulation service descriptor.

Definition at line 66 of file BaseSimulationSvc.h.

66 { return m_simDescr.value(); }

◆ simulate()

StatusCode ISF::LegacySimSvc::simulate	(	ISF::ISFParticle &	isfp,
		McEventCollection *	mcEventCollection
	)

overridevirtual

Simulation Call.

Reimplemented from ISF::BaseSimulationSvc.

Definition at line 34 of file LegacySimSvc.cxx.

 {
   const EventContext& ctx = Gaudi::Hive::currentContext();
   ISF::ISFParticleContainer secondaries;
   ATH_CHECK(m_simulatorTool->simulate(ctx, isfp, secondaries, mcEventCollection));
   if (not secondaries.empty()) {
     for (auto particle : secondaries) {
       m_particleBroker->push( particle, &isfp);
     }
   }
   return StatusCode::SUCCESS;
 }

◆ simulateVector()

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

inlineoverridevirtualinherited

Simulation call for vectors of particles.

Reimplemented in iGeant4::Geant4SimSvc.

Definition at line 83 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 ( )

inlineoverridevirtualinherited

Gaudi sysInitialize() methods.

Definition at line 51 of file BaseSimulationSvc.h.

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

Member Data Documentation

◆ m_chrono

ServiceHandle<IChronoStatSvc> ISF::BaseSimulationSvc::m_chrono {this, "ChronoStatService", "ChronoStatSvc"}

protectedinherited

The timing service for general usage.

Definition at line 202 of file BaseSimulationSvc.h.

◆ m_detStore

ServiceHandle<StoreGateSvc> ISF::BaseSimulationSvc::m_detStore

privateinherited

Initial value:

{this, "DetStore", "StoreGateSvc/DetectorStore",

"Handle to a StoreGateSvc/DetectorStore instance: it will be used to retrieve data during the course of the job"}

Handle to StoreGate (detector store by default)

Definition at line 188 of file BaseSimulationSvc.h.

◆ m_evtStore

ServiceHandle<StoreGateSvc> ISF::BaseSimulationSvc::m_evtStore

privateinherited

Initial value:

{this, "EvtStore", "StoreGateSvc/StoreGateSvc",

"Handle to a StoreGateSvc instance: it will be used to retrieve data during the course of the job"}

Handle to StoreGate (event store by default)

Definition at line 184 of file BaseSimulationSvc.h.

◆ m_particleBroker

IParticleBroker* ISF::BaseSimulationSvc::m_particleBroker {}

protectedinherited

The particle service used to push particles into the simulation.

Definition at line 205 of file BaseSimulationSvc.h.

◆ m_screenOutputPrefix

Gaudi::Property<std::string> ISF::BaseSimulationSvc::m_screenOutputPrefix

protectedinherited

Initial value:

{this, "ScreenOutputPrefix", "isf >> ",

"Prefix for log output"}

Screen output refinement.

Definition at line 198 of file BaseSimulationSvc.h.

◆ m_simDescr

Gaudi::Property<std::string> ISF::BaseSimulationSvc::m_simDescr

protectedinherited

Initial value:

{this, "Identifier", {},

"A unique string to identify the simulator."}

The simulator service descriptor.

Definition at line 194 of file BaseSimulationSvc.h.

◆ m_simulatorTool

PublicToolHandle<ISimulatorTool> ISF::LegacySimSvc::m_simulatorTool {this, "SimulatorTool", "", ""}

private

Definition at line 46 of file LegacySimSvc.h.

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

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LegacySimSvc()

◆ ~LegacySimSvc()

Member Function Documentation

◆ chronoStart()

◆ chronoStop()

◆ detStore() [1/2]

◆ detStore() [2/2]

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ initialize()

◆ recordCollection()

◆ releaseEvent()

◆ retrieveCollection()

◆ retrieveTool()

◆ retrieveTools()

◆ setParticleBroker()

◆ setupEvent()

◆ simSvcDescriptor()

◆ simulate()

◆ simulateVector()

◆ sysInitialize()

Member Data Documentation

◆ m_chrono

◆ m_detStore

◆ m_evtStore

◆ m_particleBroker

◆ m_screenOutputPrefix

◆ m_simDescr

◆ m_simulatorTool