ATLAS Offline Software
Public Member Functions | Protected Attributes | List of all members
ISF::ParticleKillerSimTool Class Reference

#include <ParticleKillerSimTool.h>

Inheritance diagram for ISF::ParticleKillerSimTool:
Collaboration diagram for ISF::ParticleKillerSimTool:

Public Member Functions

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

Detailed Description

Definition at line 22 of file ParticleKillerSimTool.h.

Constructor & Destructor Documentation

◆ ParticleKillerSimTool()

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

Definition at line 7 of file ParticleKillerSimTool.cxx.

9 {
10 }

◆ ~ParticleKillerSimTool()

ISF::ParticleKillerSimTool::~ParticleKillerSimTool ( )

Definition at line 12 of file ParticleKillerSimTool.cxx.

12  {
13 
14 }

Member Function Documentation

◆ chronoStart()

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

wrapper call to start chrono with given tag

Definition at line 100 of file BaseSimulatorTool.h.

100  {
101  if (m_chrono) return m_chrono->chronoStart( tag);
102  return nullptr;
103  }

◆ chronoStop()

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

wrapper call to stop chrono with given tag

Definition at line 106 of file BaseSimulatorTool.h.

106  {
107  if (m_chrono) return m_chrono->chronoStop( tag);
108  return nullptr;
109  }

◆ initialize()

StatusCode ISF::ParticleKillerSimTool::initialize ( )
overridevirtual

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 16 of file ParticleKillerSimTool.cxx.

16  {
17  return StatusCode::SUCCESS;
18 }

◆ releaseEvent()

virtual StatusCode ISF::ParticleKillerSimTool::releaseEvent ( const EventContext &  )
inlineoverridevirtual

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

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 37 of file ParticleKillerSimTool.h.

37 { return StatusCode::SUCCESS; };

◆ releaseEventST()

virtual StatusCode ISF::BaseSimulatorTool::releaseEventST ( )
inlineoverridevirtualinherited

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.

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

◆ setupEvent()

virtual StatusCode ISF::ParticleKillerSimTool::setupEvent ( const EventContext &  )
inlineoverridevirtual

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

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 35 of file ParticleKillerSimTool.h.

35 { return StatusCode::SUCCESS; };

◆ setupEventST()

virtual StatusCode ISF::BaseSimulatorTool::setupEventST ( )
inlineoverridevirtualinherited

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.

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

◆ simFlavor()

virtual ISF::SimulationFlavor ISF::ParticleKillerSimTool::simFlavor ( ) const
inlineoverridevirtual

Definition at line 39 of file ParticleKillerSimTool.h.

39 { return ISF::ParticleKiller; };

◆ simulate()

StatusCode ISF::ParticleKillerSimTool::simulate ( ISFParticle isp,
ISFParticleContainer ,
McEventCollection  
)
overridevirtual

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 20 of file ParticleKillerSimTool.cxx.

20  {
21 
22  // give a screen output that you entered ParticleKillerSimSvc
23  ATH_MSG_VERBOSE( "Particle '" << isp << "' received for simulation." );
24  ATH_MSG_VERBOSE( "Killing this particle, since this"
25  << "is the soul purpose of this 'simulation engine'." );
26 
27  // particle 'simulation' done
28  // (memory management, ie delete, of the ISFParticle is done inside the ISFKernel)
29  return StatusCode::SUCCESS;
30 }

◆ simulateVector()

StatusCode ISF::ParticleKillerSimTool::simulateVector ( const ISFParticleVector particles,
ISFParticleContainer secondaries,
McEventCollection mcEventCollection,
McEventCollection  
)
overridevirtual

Simulation call for vectors of particles.

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 32 of file ParticleKillerSimTool.cxx.

32  {
33  for (auto isp : particles) {
34  ATH_CHECK(simulate(*isp, secondaries, mcEventCollection));
35  }
36  return StatusCode::SUCCESS;
37 }

◆ sysInitialize()

virtual StatusCode ISF::BaseSimulatorTool::sysInitialize ( )
inlineoverridevirtualinherited

Gaudi sysInitialize() methods.

Definition at line 51 of file BaseSimulatorTool.h.

52  {
54  ATH_CHECK( serviceLocator()->service(m_chronoSvcName, m_chrono ) );
55  return StatusCode::SUCCESS;
56  }

Member Data Documentation

◆ m_chrono

IChronoStatSvc* ISF::BaseSimulatorTool::m_chrono {}
protectedinherited

The timing service for general usage.

Definition at line 120 of file BaseSimulatorTool.h.

◆ m_chronoSvcName

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

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 files:
ISF::BaseSimulatorTool::m_chronoSvcName
std::string m_chronoSvcName
Name of the timing service - can be set by declareProperty()
Definition: BaseSimulatorTool.h:117
ISF::BaseSimulatorTool::releaseEvent
virtual StatusCode releaseEvent(const EventContext &) override
Release Event chain - in case of an end-of event action is needed.
Definition: BaseSimulatorTool.h:92
ISF::ParticleKiller
@ ParticleKiller
Definition: SimulationFlavor.h:21
ISF::BaseSimulatorTool::m_chrono
IChronoStatSvc * m_chrono
The timing service for general usage.
Definition: BaseSimulatorTool.h:120
ATH_MSG_VERBOSE
#define ATH_MSG_VERBOSE(x)
Definition: AthMsgStreamMacros.h:28
test_pyathena.parent
parent
Definition: test_pyathena.py:15
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
ISF::BaseSimulatorTool::BaseSimulatorTool
BaseSimulatorTool()
Default constructor.
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:195
AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize
virtual StatusCode sysInitialize() override
Perform system initialization for an algorithm.
ISF::BaseSimulatorTool::setupEvent
virtual StatusCode setupEvent(const EventContext &) override
Setup Event chain - in case of a begin-of event action is needed.
Definition: BaseSimulatorTool.h:65
python.CaloScaleNoiseConfig.type
type
Definition: CaloScaleNoiseConfig.py:78
LArG4FSStartPointFilter.particles
list particles
Definition: LArG4FSStartPointFilter.py:84
CaloCondBlobAlgs_fillNoiseFromASCII.tag
string tag
Definition: CaloCondBlobAlgs_fillNoiseFromASCII.py:24
ISF::ParticleKillerSimTool::simulate
virtual StatusCode simulate(ISFParticle &isp, ISFParticleContainer &, McEventCollection *) override
Definition: ParticleKillerSimTool.cxx:20