A class to manage EnergyLossRecorder actions. More...

#include <EnergyLossRecorderTool.h>

Inheritance diagram for G4UA::EnergyLossRecorderTool:

Collaboration diagram for G4UA::EnergyLossRecorderTool:

Public Member Functions
	EnergyLossRecorderTool (const std::string &type, const std::string &name, const IInterface *parent)
	standard tool ctor
virtual StatusCode	initialize () override final
	Athena initialize method.
virtual StatusCode	fillUserAction (G4AtlasUserActions &actionLists) override final
	Fill the user action lists.
StatusCode	BeginOfAthenaEvent (HitCollectionMap &) override
	Calls BeginOfAthenaEvent.
StatusCode	EndOfAthenaEvent (HitCollectionMap &) override
	Calls EndOfAthenaEvent.

Protected Member Functions
virtual std::unique_ptr< EnergyLossRecorder >	makeAndFillAction (G4AtlasUserActions &) override final
	creates the instance for this thread

Protected Attributes
ThreadSpecificUserAction< EnergyLossRecorder >	m_actions
	Thread-specific storage of the user action.

Private Attributes
EnergyLossRecorder::Config	m_config
	stores the config obtained from the python side
ToolHandle< Trk::IPositionMomentumWriter >	m_pmWriter

Detailed Description

A class to manage EnergyLossRecorder actions.

creates one instance of the action per thread

Author: Andrea Di Simone

Definition at line 29 of file EnergyLossRecorderTool.h.

Constructor & Destructor Documentation

◆ EnergyLossRecorderTool()

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

standard tool ctor

Definition at line 11 of file EnergyLossRecorderTool.cxx.

    : UserActionToolBase<EnergyLossRecorder>(type, name, parent),
      m_pmWriter("")
  {
    declareProperty("PositionMomentumWriter", m_pmWriter, "");
  }

Member Function Documentation

◆ BeginOfAthenaEvent()

StatusCode G4UA::UserActionToolBase< EnergyLossRecorder >::BeginOfAthenaEvent ( HitCollectionMap & )

inlineoverrideinherited

Calls BeginOfAthenaEvent.

Definition at line 59 of file UserActionToolBase.h.

59{return StatusCode::SUCCESS;};

G4UA::UserActionToolBase

abstract template utility base-class for G4 user-action tools.

Definition UserActionToolBase.h:35

◆ EndOfAthenaEvent()

StatusCode G4UA::UserActionToolBase< EnergyLossRecorder >::EndOfAthenaEvent ( HitCollectionMap & )

inlineoverrideinherited

Calls EndOfAthenaEvent.

Definition at line 61 of file UserActionToolBase.h.

61{return StatusCode::SUCCESS;};

◆ fillUserAction()

virtual StatusCode G4UA::UserActionToolBase< EnergyLossRecorder >::fillUserAction ( G4AtlasUserActions & actionLists )

inlinefinaloverridevirtualinherited

Fill the user action lists.

Definition at line 47 of file UserActionToolBase.h.

      {
        auto myAction = makeAndFillAction(actionLists);
        if(myAction == nullptr) {
          ATH_MSG_ERROR( "Failed to construct user action in " << name() );
          return StatusCode::FAILURE;
        }
        m_actions.set( std::move(myAction) );
        return StatusCode::SUCCESS;
      }

◆ initialize()

StatusCode G4UA::EnergyLossRecorderTool::initialize ( )

finaloverridevirtual

Athena initialize method.

Definition at line 20 of file EnergyLossRecorderTool.cxx.

  {
    if(!m_pmWriter.empty()) {
      ATH_CHECK(m_pmWriter.retrieve());
      // FIXME: thread-unsafe usage of a component in a thread-local action?
      // See ATLASSIM-3562.
      m_config.pmWriter = &(*m_pmWriter);
    }
    return StatusCode::SUCCESS;
  }

◆ makeAndFillAction()

std::unique_ptr< EnergyLossRecorder > G4UA::EnergyLossRecorderTool::makeAndFillAction ( G4AtlasUserActions & actionList )

finaloverrideprotectedvirtual

creates the instance for this thread

Implements G4UA::UserActionToolBase< EnergyLossRecorder >.

Definition at line 32 of file EnergyLossRecorderTool.cxx.

  {
    ATH_MSG_DEBUG("Constructing an EnergyLossRecorder action");
    auto action = std::make_unique<EnergyLossRecorder>(m_config);
    actionList.runActions.push_back( action.get() );
    actionList.eventActions.push_back( action.get() );
    actionList.steppingActions.push_back( action.get() );
    return action;
  }

Member Data Documentation

◆ m_actions

ThreadSpecificUserAction<EnergyLossRecorder> G4UA::UserActionToolBase< EnergyLossRecorder >::m_actions

protectedinherited

Thread-specific storage of the user action.

Definition at line 70 of file UserActionToolBase.h.

◆ m_config

EnergyLossRecorder::Config G4UA::EnergyLossRecorderTool::m_config

private

stores the config obtained from the python side

Definition at line 44 of file EnergyLossRecorderTool.h.

◆ m_pmWriter

ToolHandle<Trk::IPositionMomentumWriter> G4UA::EnergyLossRecorderTool::m_pmWriter