ISF::BaseSimulatorTool Class Reference

#include <BaseSimulatorTool.h>

Inheritance diagram for ISF::BaseSimulatorTool:

Collaboration diagram for ISF::BaseSimulatorTool:

Public Member Functions
	BaseSimulatorTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~BaseSimulatorTool ()
	Destructor. More...
virtual StatusCode	sysInitialize () override
	Gaudi sysInitialize() methods. More...
virtual StatusCode	initialize () override
virtual StatusCode	setupEvent (const EventContext &) override
	Setup Event chain - in case of a begin-of event action is needed. More...
virtual StatusCode	setupEventST () override
	Setup Event chain - in case of a begin-of event action is needed (called by ISimulationSvc) More...
virtual StatusCode	simulate (ISFParticle &, ISFParticleContainer &, McEventCollection *) override
virtual StatusCode	simulateVector (const ISFParticleVector &particles, ISFParticleContainer &secondaries, McEventCollection *mcEventCollection, McEventCollection *) override
	Simulation call for vectors of particles. More...
virtual StatusCode	releaseEvent (const EventContext &) override
	Release Event chain - in case of an end-of event action is needed. More...
virtual StatusCode	releaseEventST () override
	Release Event chain - in case of an end-of event action is needed (called by ISimulationSvc) 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...

Protected Attributes
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...

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

Detailed Description

Concrete base class for all simulator Tools

Definition at line 36 of file BaseSimulatorTool.h.

Constructor & Destructor Documentation

BaseSimulatorTool() [1/2]

ISF::BaseSimulatorTool::BaseSimulatorTool ( const std::string &  type, const std::string &  name, const IInterface *  parent  )

inline

Definition at line 40 of file BaseSimulatorTool.h.

      : base_class(type, name, parent)
    {
      // Service handling
      declareProperty("ChronoStatService",    m_chronoSvcName     );
    }

~BaseSimulatorTool()

virtual ISF::BaseSimulatorTool::~BaseSimulatorTool ( )

inlinevirtual

Destructor.

Definition at line 48 of file BaseSimulatorTool.h.

{}

BaseSimulatorTool() [2/2]

ISF::BaseSimulatorTool::BaseSimulatorTool ( )

private

Default constructor.

Member Function Documentation

chronoStart()

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

inline

wrapper call to start chrono with given tag

Definition at line 100 of file BaseSimulatorTool.h.

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

chronoStop()

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

inline

wrapper call to stop chrono with given tag

Definition at line 106 of file BaseSimulatorTool.h.

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

initialize()

virtual StatusCode ISF::BaseSimulatorTool::initialize ( )

inlineoverridevirtual

Reimplemented in iGeant4::G4TransportTool, iGeant4::G4LegacyTransportTool, ISF::FastCaloSimV2Tool, ISF::ActsFatrasSimTool, ISF::ParticleKillerSimTool, and ISF::FatrasSimTool.

Definition at line 59 of file BaseSimulatorTool.h.

    {
      return StatusCode::SUCCESS;
    }

releaseEvent()

virtual StatusCode ISF::BaseSimulatorTool::releaseEvent ( const EventContext &  )

inlineoverridevirtual

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

Reimplemented in ISF::FastCaloSimV2Tool, ISF::ActsFatrasSimTool, iGeant4::G4TransportTool, iGeant4::G4LegacyTransportTool, ISF::ParticleKillerSimTool, and ISF::FatrasSimTool.

Definition at line 92 of file BaseSimulatorTool.h.

    { return StatusCode::FAILURE; }

releaseEventST()

virtual StatusCode ISF::BaseSimulatorTool::releaseEventST ( )

inlineoverridevirtual

Release Event chain - in case of an end-of event action is needed (called by ISimulationSvc)

Reimplemented in ISF::FastCaloSimV2Tool.

Definition at line 96 of file BaseSimulatorTool.h.

    { return releaseEvent(Gaudi::Hive::currentContext()); }

setupEvent()

virtual StatusCode ISF::BaseSimulatorTool::setupEvent ( const EventContext &  )

inlineoverridevirtual

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

Reimplemented in ISF::FastCaloSimV2Tool, ISF::ActsFatrasSimTool, iGeant4::G4TransportTool, iGeant4::G4LegacyTransportTool, ISF::ParticleKillerSimTool, and ISF::FatrasSimTool.

Definition at line 65 of file BaseSimulatorTool.h.

    { return StatusCode::FAILURE; }

setupEventST()

virtual StatusCode ISF::BaseSimulatorTool::setupEventST ( )

inlineoverridevirtual

Setup Event chain - in case of a begin-of event action is needed (called by ISimulationSvc)

Reimplemented in ISF::FastCaloSimV2Tool.

Definition at line 69 of file BaseSimulatorTool.h.

    { return setupEvent(Gaudi::Hive::currentContext()); }

simulate()

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

inlineoverridevirtual

Reimplemented in ISF::FastCaloSimV2Tool, ISF::ActsFatrasSimTool, ISF::ParticleKillerSimTool, ISF::FatrasSimTool, iGeant4::G4TransportTool, and iGeant4::G4LegacyTransportTool.

Definition at line 73 of file BaseSimulatorTool.h.

    { return StatusCode::FAILURE; }

simulateVector()

virtual StatusCode ISF::BaseSimulatorTool::simulateVector ( const ISFParticleVector &  particles, ISFParticleContainer &  secondaries, McEventCollection *  mcEventCollection, McEventCollection *    )

inlineoverridevirtual

Simulation call for vectors of particles.

Reimplemented in ISF::ActsFatrasSimTool, ISF::ParticleKillerSimTool, iGeant4::G4TransportTool, and iGeant4::G4LegacyTransportTool.

Definition at line 77 of file BaseSimulatorTool.h.

    {
      // this implementation is a wrapper in case the simulator does
      // implement particle-vector input
 
      // simulate each particle individually
      for (auto* cisp : particles) {
        ATH_MSG_VERBOSE( "Starting simulation of particle: " << (*cisp) );
        ATH_CHECK(this->simulate(*cisp, secondaries, mcEventCollection));
      }
      return StatusCode::SUCCESS;
 
    }

sysInitialize()

virtual StatusCode ISF::BaseSimulatorTool::sysInitialize ( )

inlineoverridevirtual

Gaudi sysInitialize() methods.

Definition at line 51 of file BaseSimulatorTool.h.

    {
      ATH_CHECK( AthAlgTool::sysInitialize() );
      ATH_CHECK( serviceLocator()->service(m_chronoSvcName, m_chrono ) );
      return StatusCode::SUCCESS;
    }

Member Data Documentation

m_chrono

IChronoStatSvc* ISF::BaseSimulatorTool::m_chrono {}

protected

The timing service for general usage.

Definition at line 120 of file BaseSimulatorTool.h.

m_chronoSvcName

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

protected

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

Definition at line 117 of file BaseSimulatorTool.h.

---

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

• BaseSimulatorTool.h