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.
StatusCode	BeginOfAthenaEvent (HitCollectionMap &) override
	Calls BeginOfAthenaEvent.
StatusCode	EndOfAthenaEvent (HitCollectionMap &) override
	Calls EndOfAthenaEvent.

Protected Member Functions
virtual std::unique_ptr< HyperspaceCatcher >	makeAndFillAction (G4AtlasUserActions &) override final
	Make the action and push onto the lists.

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

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.

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

Member Function Documentation

BeginOfAthenaEvent()

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

inlineoverrideinherited

Calls BeginOfAthenaEvent.

Definition at line 59 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

EndOfAthenaEvent()

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

inlineoverrideinherited

Calls EndOfAthenaEvent.

Definition at line 61 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

fillUserAction()

virtual StatusCode G4UA::UserActionToolBase< HyperspaceCatcher >::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< 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.

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

Member Data Documentation

m_actions

ThreadSpecificUserAction<HyperspaceCatcher> G4UA::UserActionToolBase< HyperspaceCatcher >::m_actions

protectedinherited

Thread-specific storage of the user action.

Definition at line 70 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:

• HyperspaceCatcherTool.h
• HyperspaceCatcherTool.cxx