#include <Geant4SimSvc.h>

Inheritance diagram for iGeant4::Geant4SimSvc:

Collaboration diagram for iGeant4::Geant4SimSvc:

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

virtual	~Geant4SimSvc ()
	Destructor. More...

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

virtual StatusCode	finalize () override
	framework methods More...

virtual StatusCode	simulate (ISF::ISFParticle &isp, McEventCollection *mcEventCollection, std::shared_ptr< HitCollectionMap >) override
	Simulation Call More...

virtual StatusCode	simulateVector (const ISF::ISFParticleVector &particles, McEventCollection mcEventCollection, std::shared_ptr< HitCollectionMap > hitCollections, McEventCollection shadowTruth=nullptr) override
	Simulation Call for vector of ISF particles. More...

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

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

virtual StatusCode	simulate (ISFParticle &, McEventCollection *) override
	Simulation call for individual particles. 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	simulateVector (const ISFParticleVector &, McEventCollection , McEventCollection ) override
	Simulation call for vectors of particles. More...

	BaseSimulationSvc (const std::string &name, ISvcLocator *pSvcLocator)
	Standard BaseSimulationSvc constructor. 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...

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 Member Functions
	Geant4SimSvc ()
	Default constructor. More...

Private Attributes
PublicToolHandle< ISF::ISimulatorTool >	m_simulatorTool

ISF::BaseSimulatorG4Tool *	m_simulatorG4Tool {}
	pointer to the downcasted G4 simulator tool More...

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 27 of file Geant4SimSvc.h.

Constructor & Destructor Documentation

◆ Geant4SimSvc() [1/2]

iGeant4::Geant4SimSvc::Geant4SimSvc	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Constructor.

Definition at line 11 of file Geant4SimSvc.cxx.

12 : BaseSimulationG4Svc(name, svc) {}

◆ ~Geant4SimSvc()

iGeant4::Geant4SimSvc::~Geant4SimSvc ( )

virtual

Destructor.

Definition at line 14 of file Geant4SimSvc.cxx.

15 {}

◆ Geant4SimSvc() [2/2]

iGeant4::Geant4SimSvc::Geant4SimSvc ( )

private

Default constructor.

Member Function Documentation

◆ BaseSimulationSvc()

ISF::BaseSimulationSvc::BaseSimulationSvc

inlineinherited

Standard BaseSimulationSvc constructor.

Definition at line 45 of file BaseSimulationSvc.h.

45 :

46 base_class(name,pSvcLocator) {};

◆ chronoStart()

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

inlineinherited

wrapper call to start chrono with given tag

Definition at line 105 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 111 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 126 of file BaseSimulationSvc.h.

126 {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 125 of file BaseSimulationSvc.h.

125 {return m_detStore;};

◆ evtStore() [1/2]

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

inlineinherited

Definition at line 120 of file BaseSimulationSvc.h.

120 {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 119 of file BaseSimulationSvc.h.

119 {return m_evtStore;};

◆ finalize()

StatusCode iGeant4::Geant4SimSvc::finalize ( )

overridevirtual

framework methods

Definition at line 31 of file Geant4SimSvc.cxx.

 {
   return StatusCode::SUCCESS;
 }

◆ initialize()

StatusCode iGeant4::Geant4SimSvc::initialize ( )

overridevirtual

Athena algorithm's interface methods.

framework methods

Definition at line 18 of file Geant4SimSvc.cxx.

 {
   ATH_CHECK (m_simulatorTool.retrieve());
   m_simulatorG4Tool =
       dynamic_cast<ISF::BaseSimulatorG4Tool*>(m_simulatorTool.get());
   if (!m_simulatorG4Tool) {
     ATH_MSG_FATAL("SimulatorTool is not of type ISF::BaseSimulatorG4Tool");
     return StatusCode::FAILURE;
   }
   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 151 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() [1/2]

virtual StatusCode ISF::BaseSimulationG4Svc::releaseEvent ( )

inlineoverridevirtualinherited

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

Reimplemented from ISF::BaseSimulationSvc.

Definition at line 85 of file BaseSimulationG4Svc.h.

85 { return StatusCode::FAILURE; }

◆ releaseEvent() [2/2]

StatusCode iGeant4::Geant4SimSvc::releaseEvent ( HitCollectionMap & hitCollections )

overridevirtual

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

Implements ISF::BaseSimulationG4Svc.

Definition at line 40 of file Geant4SimSvc.cxx.

                                       {
   return m_simulatorG4Tool->releaseEventST(hitCollections);
 }

◆ 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 165 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 129 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 140 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 78 of file BaseSimulationSvc.h.

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

◆ setupEvent() [1/2]

virtual StatusCode ISF::BaseSimulationG4Svc::setupEvent ( )

inlineoverridevirtualinherited

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

Reimplemented from ISF::BaseSimulationSvc.

Definition at line 82 of file BaseSimulationG4Svc.h.

82 { return StatusCode::FAILURE; }

◆ setupEvent() [2/2]

StatusCode iGeant4::Geant4SimSvc::setupEvent ( HitCollectionMap & hitCollections )

overridevirtual

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

Implements ISF::BaseSimulationG4Svc.

Definition at line 36 of file Geant4SimSvc.cxx.

                                                                            {
   return m_simulatorG4Tool->setupEventST(hitCollections);
 }

◆ simSvcDescriptor()

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

inlineoverrideinherited

Return the simulation service descriptor.

Definition at line 67 of file BaseSimulationSvc.h.

67 { return m_simDescr.value(); }

◆ simulate() [1/2]

StatusCode iGeant4::Geant4SimSvc::simulate	(	ISF::ISFParticle &	isp,
		McEventCollection *	mcEventCollection,
		std::shared_ptr< HitCollectionMap >	hitCollections
	)

overridevirtual

Simulation Call

Simulation Call.

Implements ISF::BaseSimulationG4Svc.

Definition at line 46 of file Geant4SimSvc.cxx.

                                                                                            {
   const EventContext& ctx = Gaudi::Hive::currentContext();
   ISF::ISFParticleContainer secondaries; // filled, but not used
   ATH_CHECK(m_simulatorG4Tool->simulate(ctx, isp, secondaries,
                                         mcEventCollection, hitCollections));
   return StatusCode::SUCCESS;
 }

◆ simulate() [2/2]

virtual StatusCode ISF::BaseSimulationG4Svc::simulate	(	ISFParticle &	,
		McEventCollection *
	)

inlineoverridevirtualinherited

Simulation call for individual particles.

Reimplemented from ISF::BaseSimulationSvc.

Definition at line 77 of file BaseSimulationG4Svc.h.

                                                                          {
     return StatusCode::FAILURE;
   }

◆ simulateVector() [1/2]

StatusCode iGeant4::Geant4SimSvc::simulateVector	(	const ISF::ISFParticleVector &	particles,
		McEventCollection *	mcEventCollection,
		std::shared_ptr< HitCollectionMap >	hitCollections,
		McEventCollection *	shadowTruth = `nullptr`
	)

overridevirtual

Simulation Call for vector of ISF particles.

Simulation Call.

Reimplemented from ISF::BaseSimulationG4Svc.

Definition at line 57 of file Geant4SimSvc.cxx.

                                     {
   const EventContext& ctx = Gaudi::Hive::currentContext();
   ISF::ISFParticleContainer secondaries; // filled, but not used
   ATH_CHECK(m_simulatorG4Tool->simulateVector(
       ctx, particles, secondaries, mcEventCollection, hitCollections, shadowTruth));
   return StatusCode::SUCCESS;
 }

◆ simulateVector() [2/2]

virtual StatusCode ISF::BaseSimulationG4Svc::simulateVector	(	const ISFParticleVector &	,
		McEventCollection *	,
		McEventCollection *
	)

inlineoverridevirtualinherited

Simulation call for vectors of particles.

Reimplemented from ISF::BaseSimulationSvc.

Definition at line 88 of file BaseSimulationG4Svc.h.

                                                                  {
     return StatusCode::FAILURE;
   }

◆ sysInitialize()

virtual StatusCode ISF::BaseSimulationSvc::sysInitialize ( )

inlineoverridevirtualinherited

Gaudi sysInitialize() methods.

Definition at line 52 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 203 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 189 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 185 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 206 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 199 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 195 of file BaseSimulationSvc.h.

◆ m_simulatorG4Tool

ISF::BaseSimulatorG4Tool* iGeant4::Geant4SimSvc::m_simulatorG4Tool {}

private

pointer to the downcasted G4 simulator tool

Definition at line 70 of file Geant4SimSvc.h.

◆ m_simulatorTool

PublicToolHandle<ISF::ISimulatorTool> iGeant4::Geant4SimSvc::m_simulatorTool

private

Initial value:

{this, "SimulatorTool",

"", ""}

Definition at line 66 of file Geant4SimSvc.h.

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Geant4SimSvc() [1/2]

◆ ~Geant4SimSvc()

◆ Geant4SimSvc() [2/2]

Member Function Documentation

◆ BaseSimulationSvc()

◆ chronoStart()

◆ chronoStop()

◆ detStore() [1/2]

◆ detStore() [2/2]

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ finalize()

◆ initialize()

◆ recordCollection()

◆ releaseEvent() [1/2]

◆ releaseEvent() [2/2]

◆ retrieveCollection()

◆ retrieveTool()

◆ retrieveTools()

◆ setParticleBroker()

◆ setupEvent() [1/2]

◆ setupEvent() [2/2]

◆ simSvcDescriptor()

◆ simulate() [1/2]

◆ simulate() [2/2]

◆ simulateVector() [1/2]

◆ simulateVector() [2/2]

◆ sysInitialize()

Member Data Documentation

◆ m_chrono

◆ m_detStore

◆ m_evtStore

◆ m_particleBroker

◆ m_screenOutputPrefix

◆ m_simDescr

◆ m_simulatorG4Tool

◆ m_simulatorTool