ISF::BaseSimulatorG4Tool Class Reference

#include <BaseSimulatorG4Tool.h>

Inheritance diagram for ISF::BaseSimulatorG4Tool:

Collaboration diagram for ISF::BaseSimulatorG4Tool:

Public Member Functions
virtual StatusCode	simulate (const EventContext &ctx, ISFParticle &isp, ISFParticleContainer &secondaries, McEventCollection *mcEventCollection, std::shared_ptr< HitCollectionMap >)=0
	Simulation call for individual particles. More...
virtual StatusCode	simulateVector (const EventContext &ctx, const ISFParticleVector &particles, ISFParticleContainer &secondaries, McEventCollection *mcEventCollection, std::shared_ptr< HitCollectionMap > HitCollectionMap, McEventCollection *shadowTruth=nullptr)=0
	Simulation call for vectors of particles. More...
virtual StatusCode	setupEvent (const EventContext &, HitCollectionMap &)=0
	Create data containers for an event. More...
virtual StatusCode	setupEventST (HitCollectionMap &hitCollections)
	Create data containers for an event (called by ISimulationSvc) More...
virtual StatusCode	releaseEvent (const EventContext &, HitCollectionMap &)=0
	Finalise data containers for an event. More...
virtual StatusCode	releaseEventST (HitCollectionMap &hitCollections)
	Finalise data containers for an event (called by ISimulationSvc) More...
virtual StatusCode	simulate (const EventContext &, ISFParticle &, ISFParticleContainer &, McEventCollection *)
	Simulation call for individual particles. More...
virtual StatusCode	simulateVector (const EventContext &, const ISFParticleVector &, ISFParticleContainer &, McEventCollection *, McEventCollection *)
	Simulation call for vectors of particles. More...
virtual StatusCode	setupEvent (const EventContext &)
	Create data containers for an event. More...
virtual StatusCode	setupEventST ()
	Create data containers for an event (called by ISimulationSvc) More...
virtual StatusCode	releaseEvent (const EventContext &)
	Finalise data containers for an event. More...
virtual StatusCode	releaseEventST ()
	Finalise data containers for an event (called by ISimulationSvc) More...
	BaseSimulatorTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard BaseSimulatorTool constructor. More...
virtual StatusCode	sysInitialize () override
	Gaudi sysInitialize() methods. More...
virtual StatusCode	initialize () override
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
ServiceHandle< IChronoStatSvc >	m_chrono {this, "ChronoStatService", "ChronoStatSvc"}
	The timing service for general usage. More...

Detailed Description

Definition at line 28 of file BaseSimulatorG4Tool.h.

Member Function Documentation

BaseSimulatorTool()

ISF::BaseSimulatorTool::BaseSimulatorTool

inline

Standard BaseSimulatorTool constructor.

Definition at line 40 of file BaseSimulatorTool.h.

      : base_class(type, name, parent)
    {
    }

chronoStart()

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

inlineinherited

wrapper call to start chrono with given tag

Definition at line 98 of file BaseSimulatorTool.h.

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

chronoStop()

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

inlineinherited

wrapper call to stop chrono with given tag

Definition at line 104 of file BaseSimulatorTool.h.

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

initialize()

virtual StatusCode ISF::BaseSimulatorTool::initialize ( )

inlineoverridevirtualinherited

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

Definition at line 57 of file BaseSimulatorTool.h.

    {
      return StatusCode::SUCCESS;
    }

releaseEvent() [1/2]

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

inlinevirtual

Finalise data containers for an event.

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 87 of file BaseSimulatorG4Tool.h.

                                                       {
    return StatusCode::FAILURE;
  };

releaseEvent() [2/2]

virtual StatusCode ISF::BaseSimulatorG4Tool::releaseEvent ( const EventContext &  , HitCollectionMap &    )

pure virtual

Finalise data containers for an event.

Implemented in iGeant4::G4TransportTool, and iGeant4::G4LegacyTransportTool.

releaseEventST() [1/2]

virtual StatusCode ISF::BaseSimulatorG4Tool::releaseEventST ( )

inlinevirtual

Finalise data containers for an event (called by ISimulationSvc)

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 92 of file BaseSimulatorG4Tool.h.

{ return StatusCode::FAILURE; };

releaseEventST() [2/2]

virtual StatusCode ISF::BaseSimulatorG4Tool::releaseEventST ( HitCollectionMap &  hitCollections )

inlinevirtual

Finalise data containers for an event (called by ISimulationSvc)

Definition at line 58 of file BaseSimulatorG4Tool.h.

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

setupEvent() [1/2]

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

inlinevirtual

Create data containers for an event.

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 79 of file BaseSimulatorG4Tool.h.

                                                     {
    return StatusCode::FAILURE;
  };

setupEvent() [2/2]

virtual StatusCode ISF::BaseSimulatorG4Tool::setupEvent ( const EventContext &  , HitCollectionMap &    )

pure virtual

Create data containers for an event.

Implemented in iGeant4::G4TransportTool, and iGeant4::G4LegacyTransportTool.

setupEventST() [1/2]

virtual StatusCode ISF::BaseSimulatorG4Tool::setupEventST ( )

inlinevirtual

Create data containers for an event (called by ISimulationSvc)

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 84 of file BaseSimulatorG4Tool.h.

{ return StatusCode::FAILURE; };

setupEventST() [2/2]

virtual StatusCode ISF::BaseSimulatorG4Tool::setupEventST ( HitCollectionMap &  hitCollections )

inlinevirtual

Create data containers for an event (called by ISimulationSvc)

Definition at line 49 of file BaseSimulatorG4Tool.h.

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

simulate() [1/2]

virtual StatusCode ISF::BaseSimulatorG4Tool::simulate ( const EventContext &  , ISFParticle &  , ISFParticleContainer &  , McEventCollection *    )

inlinevirtual

Simulation call for individual particles.

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 65 of file BaseSimulatorG4Tool.h.

                                                                         {
    return StatusCode::FAILURE;
  };

simulate() [2/2]

virtual StatusCode ISF::BaseSimulatorG4Tool::simulate ( const EventContext &  ctx, ISFParticle &  isp, ISFParticleContainer &  secondaries, McEventCollection *  mcEventCollection, std::shared_ptr< HitCollectionMap >    )

pure virtual

Simulation call for individual particles.

Implemented in iGeant4::G4LegacyTransportTool, and iGeant4::G4TransportTool.

simulateVector() [1/2]

virtual StatusCode ISF::BaseSimulatorG4Tool::simulateVector ( const EventContext &  , const ISFParticleVector &  , ISFParticleContainer &  , McEventCollection *  , McEventCollection *    )

inlinevirtual

Simulation call for vectors of particles.

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 71 of file BaseSimulatorG4Tool.h.

                                                        {
    return StatusCode::FAILURE;
  };

simulateVector() [2/2]

virtual StatusCode ISF::BaseSimulatorG4Tool::simulateVector ( const EventContext &  ctx, const ISFParticleVector &  particles, ISFParticleContainer &  secondaries, McEventCollection *  mcEventCollection, std::shared_ptr< HitCollectionMap >  HitCollectionMap, McEventCollection *  shadowTruth = nullptr  )

pure virtual

Simulation call for vectors of particles.

Implemented in iGeant4::G4TransportTool, and iGeant4::G4LegacyTransportTool.

sysInitialize()

virtual StatusCode ISF::BaseSimulatorTool::sysInitialize ( )

inlineoverridevirtualinherited

Gaudi sysInitialize() methods.

Definition at line 49 of file BaseSimulatorTool.h.

    {
      ATH_CHECK( AthAlgTool::sysInitialize() );
      ATH_CHECK( m_chrono.retrieve() );
      return StatusCode::SUCCESS;
    }

Member Data Documentation

m_chrono

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

protectedinherited

The timing service for general usage.

Definition at line 115 of file BaseSimulatorTool.h.

---

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

• BaseSimulatorG4Tool.h