ATLAS Offline Software
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
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. More...
 
virtual StatusCode fillUserAction (G4AtlasUserActions &actionLists) override final
 Fill the user action lists. More...
 

Protected Member Functions

virtual std::unique_ptr< DebugSteppingActionmakeAndFillAction (G4AtlasUserActions &) override final
 creates one action per thread More...
 

Protected Attributes

ThreadSpecificUserAction< DebugSteppingActionm_actions
 Thread-specific storage of the user action. More...
 

Private Attributes

DebugSteppingAction::Config m_config
 the config for the action More...
 

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.

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

Member Function Documentation

◆ fillUserAction()

virtual StatusCode G4UA::UserActionToolBase< DebugSteppingAction >::fillUserAction ( G4AtlasUserActions actionLists)
inlinefinaloverridevirtualinherited

Fill the user action lists.

Definition at line 45 of file UserActionToolBase.h.

46  {
47  auto myAction = makeAndFillAction(actionLists);
48  if(myAction == nullptr) {
49  ATH_MSG_ERROR( "Failed to construct user action in " << name() );
50  return StatusCode::FAILURE;
51  }
52  m_actions.set( std::move(myAction) );
53  return StatusCode::SUCCESS;
54  }

◆ 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.

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

Member Data Documentation

◆ m_actions

Thread-specific storage of the user action.

Definition at line 63 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:
G4UA::DebugSteppingAction::Config::numSteps
G4int numSteps
Definition: DebugSteppingAction.h:25
G4UA::DebugSteppingActionTool::m_config
DebugSteppingAction::Config m_config
the config for the action
Definition: DebugSteppingActionTool.h:37
G4UA::ThreadSpecificUserAction::set
void set(std::unique_ptr< ActionType > action)
Assign the object of the current thread.
Definition: ThreadSpecificUserAction.h:61
G4UA::DebugSteppingAction::Config::step
G4double step
Definition: DebugSteppingAction.h:24
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
G4UA::UserActionToolBase< DebugSteppingAction >::m_actions
ThreadSpecificUserAction< DebugSteppingAction > m_actions
Thread-specific storage of the user action.
Definition: UserActionToolBase.h:63
test_pyathena.parent
parent
Definition: test_pyathena.py:15
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:221
G4UA::UserActionToolBase< DebugSteppingAction >::makeAndFillAction
virtual std::unique_ptr< DebugSteppingAction > makeAndFillAction(G4AtlasUserActions &actionLists)=0
Make the action and push onto the lists.
python.CaloScaleNoiseConfig.action
action
Definition: CaloScaleNoiseConfig.py:77
python.CaloScaleNoiseConfig.type
type
Definition: CaloScaleNoiseConfig.py:78