G4UA::DebugSteppingActionTool Class Reference

a class to manage the DebugSteppingAction action More...

#include <DebugSteppingActionTool.h>

Inheritance diagram for G4UA::DebugSteppingActionTool:

Collaboration diagram for G4UA::DebugSteppingActionTool:

Public Member Functions
	DebugSteppingActionTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor.
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< DebugSteppingAction >	makeAndFillAction (G4AtlasUserActions &) override final
	creates one action per thread

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

Private Attributes
DebugSteppingAction::Config	m_config
	the config for the action

Detailed Description

a class to manage the DebugSteppingAction action

Author

Andrea Di Simone

Definition at line 18 of file DebugSteppingActionTool.h.

Constructor & Destructor Documentation

DebugSteppingActionTool()

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

Standard constructor.

Definition at line 10 of file DebugSteppingActionTool.cxx.

    : UserActionToolBase<DebugSteppingAction>(type, name, parent)
  {
    declareProperty("DebugStep", m_config.step);
    declareProperty("NumSteps", m_config.numSteps);
  }

Member Function Documentation

BeginOfAthenaEvent()

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

inlineoverrideinherited

Calls BeginOfAthenaEvent.

Definition at line 59 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

EndOfAthenaEvent()

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

inlineoverrideinherited

Calls EndOfAthenaEvent.

Definition at line 61 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

fillUserAction()

virtual StatusCode G4UA::UserActionToolBase< DebugSteppingAction >::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;
      }

makeAndFillAction()

std::unique_ptr< DebugSteppingAction > G4UA::DebugSteppingActionTool::makeAndFillAction ( G4AtlasUserActions & actionList )

finaloverrideprotectedvirtual

creates one action per thread

Implements G4UA::UserActionToolBase< DebugSteppingAction >.

Definition at line 20 of file DebugSteppingActionTool.cxx.

  {
    ATH_MSG_DEBUG("Constructing a DebugSteppingAction");
    auto action = std::make_unique<DebugSteppingAction>(m_config);
    actionList.steppingActions.push_back( action.get() );
    return action;
  }

Member Data Documentation

m_actions

ThreadSpecificUserAction<DebugSteppingAction> G4UA::UserActionToolBase< DebugSteppingAction >::m_actions

protectedinherited

Thread-specific storage of the user action.

Definition at line 70 of file UserActionToolBase.h.

m_config

DebugSteppingAction::Config G4UA::DebugSteppingActionTool::m_config

private

the config for the action

Definition at line 37 of file DebugSteppingActionTool.h.

---

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

• DebugSteppingActionTool.h
• DebugSteppingActionTool.cxx