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

Tool which creates and manages the HyperspaceCatcher user action. More...

#include <HyperspaceCatcherTool.h>

Inheritance diagram for G4UA::HyperspaceCatcherTool:
Collaboration diagram for G4UA::HyperspaceCatcherTool:

Public Member Functions

 HyperspaceCatcherTool (const std::string &type, const std::string &name, const IInterface *parent)
 
virtual StatusCode fillUserAction (G4AtlasUserActions &actionLists) override final
 Fill the user action lists. More...
 

Protected Member Functions

virtual std::unique_ptr< HyperspaceCatchermakeAndFillAction (G4AtlasUserActions &) override final
 Make the action and push onto the lists. More...
 

Protected Attributes

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

Private Attributes

HyperspaceCatcher::Config m_config
 

Detailed Description

Tool which creates and manages the HyperspaceCatcher user action.

Definition at line 16 of file HyperspaceCatcherTool.h.

Constructor & Destructor Documentation

◆ HyperspaceCatcherTool()

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

Definition at line 10 of file HyperspaceCatcherTool.cxx.

13  : UserActionToolBase<HyperspaceCatcher>(type, name, parent)
14  {
15  declareProperty("TreatmentLevel", m_config.treatmentLevel);
16  declareProperty("KillAfter", m_config.killAfter);
17  }

Member Function Documentation

◆ fillUserAction()

virtual StatusCode G4UA::UserActionToolBase< HyperspaceCatcher >::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< HyperspaceCatcher > G4UA::HyperspaceCatcherTool::makeAndFillAction ( G4AtlasUserActions actionLists)
finaloverrideprotectedvirtual

Make the action and push onto the lists.

Implements G4UA::UserActionToolBase< HyperspaceCatcher >.

Definition at line 20 of file HyperspaceCatcherTool.cxx.

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

Member Data Documentation

◆ m_actions

Thread-specific storage of the user action.

Definition at line 63 of file UserActionToolBase.h.

◆ m_config

HyperspaceCatcher::Config G4UA::HyperspaceCatcherTool::m_config
private

Definition at line 30 of file HyperspaceCatcherTool.h.


The documentation for this class was generated from the following files:
G4UA::HyperspaceCatcher::Config::treatmentLevel
int treatmentLevel
Definition: HyperspaceCatcher.h:32
G4UA::ThreadSpecificUserAction::set
void set(std::unique_ptr< ActionType > action)
Assign the object of the current thread.
Definition: ThreadSpecificUserAction.h:61
G4UA::HyperspaceCatcher::Config::killAfter
int killAfter
Definition: HyperspaceCatcher.h:33
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< HyperspaceCatcher >::m_actions
ThreadSpecificUserAction< HyperspaceCatcher > m_actions
Thread-specific storage of the user action.
Definition: UserActionToolBase.h:63
test_pyathena.parent
parent
Definition: test_pyathena.py:15
G4UA::HyperspaceCatcherTool::m_config
HyperspaceCatcher::Config m_config
Definition: HyperspaceCatcherTool.h:30
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:195
G4UA::UserActionToolBase< HyperspaceCatcher >::makeAndFillAction
virtual std::unique_ptr< HyperspaceCatcher > 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
declareProperty
#define declareProperty(n, p, h)
Definition: BaseFakeBkgTool.cxx:15