ATLAS Offline Software
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
StoppedParticleFastSimTool Class Reference

#include <StoppedParticleFastSimTool.h>

Inheritance diagram for StoppedParticleFastSimTool:
Collaboration diagram for StoppedParticleFastSimTool:

Public Member Functions

 StoppedParticleFastSimTool (const std::string &type, const std::string &name, const IInterface *parent)
 
 ~StoppedParticleFastSimTool ()
 
StatusCode initialize () override final
 
StatusCode initializeFastSim () override
 Construct and setup the fast simulation model. More...
 
virtual StatusCode BeginOfAthenaEvent () override
 Begin of an athena event - do anything that needs to be done at the beginning of each athena event. More...
 
virtual StatusCode EndOfAthenaEvent () override
 End of an athena event - do any tidying up required at the end of each athena event. More...
 

Protected Member Functions

virtual G4VFastSimulationModel * makeFastSimModel () override final
 Method to make the actual fast simulation model itself, which will be owned by the tool. More...
 
G4Region * getRegion () const
 

Protected Attributes

Gaudi::Property< std::string > m_regionName {this, "RegionName", ""}
 The region to which this fast sim is assigned. More...
 
Gaudi::Property< bool > m_noRegions {this, "NoRegions", false}
 This Fast Simulation has no regions associated with it. More...
 

Private Attributes

ToolHandle< ISensitiveDetectorm_trackFastSimSDTool
 

Detailed Description

Definition at line 15 of file StoppedParticleFastSimTool.h.

Constructor & Destructor Documentation

◆ StoppedParticleFastSimTool()

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

Definition at line 8 of file StoppedParticleFastSimTool.cxx.

10  m_trackFastSimSDTool("TrackFastSimSDTool")
11 {
12 }

◆ ~StoppedParticleFastSimTool()

StoppedParticleFastSimTool::~StoppedParticleFastSimTool ( )
inline

Definition at line 20 of file StoppedParticleFastSimTool.h.

20 {}

Member Function Documentation

◆ BeginOfAthenaEvent()

virtual StatusCode FastSimulationBase::BeginOfAthenaEvent ( )
inlineoverridevirtualinherited

Begin of an athena event - do anything that needs to be done at the beginning of each athena event.

Definition at line 42 of file FastSimulationBase.h.

42 { return StatusCode::SUCCESS; }

◆ EndOfAthenaEvent()

virtual StatusCode FastSimulationBase::EndOfAthenaEvent ( )
inlineoverridevirtualinherited

End of an athena event - do any tidying up required at the end of each athena event.

Definition at line 45 of file FastSimulationBase.h.

45 { return StatusCode::SUCCESS; }

◆ getRegion()

G4Region * FastSimulationBase::getRegion ( ) const
protectedinherited

Definition at line 17 of file FastSimulationBase.cxx.

18 {
19  if (m_regionName.value().empty()) {
20  return nullptr;
21  }
22  return G4RegionStore::GetInstance()->GetRegion(m_regionName.value());
23 }

◆ initialize()

StatusCode StoppedParticleFastSimTool::initialize ( )
finaloverride

Definition at line 14 of file StoppedParticleFastSimTool.cxx.

15 {
16  CHECK(m_trackFastSimSDTool.retrieve());
17  CHECK(m_trackFastSimSDTool->initializeSD());
18  return StatusCode::SUCCESS;
19 }

◆ initializeFastSim()

StatusCode FastSimulationBase::initializeFastSim ( )
overrideinherited

Construct and setup the fast simulation model.

This method invokes the makeFastSimModel of the derived concrete tool type. It is the derived class's responsibility to assign the fast simulation model to the correct regions. The fast simulation model is registered for deletion. In multi-threaded jobs, this method is called once on each geant4 worker thread during detector construction (ConstructSDandField).

Definition at line 27 of file FastSimulationBase.cxx.

27  {
28  ATH_MSG_VERBOSE( name() << "::initializeFastSim()" );
29 
30  // Instantiate the FastSimModel for this geant4 thread and register it for deletion
31  G4AutoDelete::Register(makeFastSimModel());
32 
33  return StatusCode::SUCCESS;
34 }

◆ makeFastSimModel()

G4VFastSimulationModel * StoppedParticleFastSimTool::makeFastSimModel ( )
finaloverrideprotectedvirtual

Method to make the actual fast simulation model itself, which will be owned by the tool.

Must be implemented in all concrete base classes.

Definition at line 21 of file StoppedParticleFastSimTool.cxx.

22 {
23  ATH_MSG_DEBUG( "Initializing Fast Sim Model" );
24 
25  // Create a fresh Fast Sim Model
27 }

Member Data Documentation

◆ m_noRegions

Gaudi::Property<bool> FastSimulationBase::m_noRegions {this, "NoRegions", false}
protectedinherited

This Fast Simulation has no regions associated with it.

Definition at line 54 of file FastSimulationBase.h.

◆ m_regionName

Gaudi::Property<std::string> FastSimulationBase::m_regionName {this, "RegionName", ""}
protectedinherited

The region to which this fast sim is assigned.

Definition at line 52 of file FastSimulationBase.h.

◆ m_trackFastSimSDTool

ToolHandle<ISensitiveDetector> StoppedParticleFastSimTool::m_trackFastSimSDTool
private

Definition at line 28 of file StoppedParticleFastSimTool.h.


The documentation for this class was generated from the following files:
FastSimulationBase::m_regionName
Gaudi::Property< std::string > m_regionName
The region to which this fast sim is assigned.
Definition: FastSimulationBase.h:52
ATH_MSG_VERBOSE
#define ATH_MSG_VERBOSE(x)
Definition: AthMsgStreamMacros.h:28
python.CaloAddPedShiftConfig.type
type
Definition: CaloAddPedShiftConfig.py:42
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
FastSimulationBase::FastSimulationBase
FastSimulationBase(const std::string &type, const std::string &name, const IInterface *parent)
Definition: FastSimulationBase.cxx:12
test_pyathena.parent
parent
Definition: test_pyathena.py:15
CHECK
#define CHECK(...)
Evaluate an expression and check for errors.
Definition: Control/AthenaKernel/AthenaKernel/errorcheck.h:422
StoppedParticleFastSimTool::m_trackFastSimSDTool
ToolHandle< ISensitiveDetector > m_trackFastSimSDTool
Definition: StoppedParticleFastSimTool.h:28
StoppedParticleFastSim
Definition: StoppedParticleFastSim.h:18
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:240
FastSimulationBase::getRegion
G4Region * getRegion() const
Definition: FastSimulationBase.cxx:17