ActsTrk::MaterialTrackRecorderTool Class Reference

#include <MaterialTrackRecorderTool.h>

Inheritance diagram for ActsTrk::MaterialTrackRecorderTool:

Collaboration diagram for ActsTrk::MaterialTrackRecorderTool:

Public Member Functions
	MaterialTrackRecorderTool (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< MaterialTrackRecorder >	makeAndFillAction (G4UA::G4AtlasUserActions &) override final
	Make the action and push onto the lists.

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

Private Attributes
Gaudi::Property< std::string >	m_materialTrackCollectionName {this, "MaterialTrackCollectionName", "OutputMaterialTracks", "Name of the output recorded material track collection"}
	The name of the recorded material track collection.
Gaudi::Property< std::vector< std::string > >	m_excludeMaterials {this, "ExcludeMaterials", {"Air", "Vacuum"}, "Material you want to exclude from recording"}
	The list of material excluded from recording.

Detailed Description

Definition at line 17 of file MaterialTrackRecorderTool.h.

Constructor & Destructor Documentation

MaterialTrackRecorderTool()

ActsTrk::MaterialTrackRecorderTool::MaterialTrackRecorderTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 9 of file MaterialTrackRecorderTool.cxx.

    : G4UA::UserActionToolBase<MaterialTrackRecorder>(type, name, parent)
  {
  }

Member Function Documentation

BeginOfAthenaEvent()

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

inlineoverrideinherited

Calls BeginOfAthenaEvent.

Definition at line 59 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

EndOfAthenaEvent()

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

inlineoverrideinherited

Calls EndOfAthenaEvent.

Definition at line 61 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

fillUserAction()

virtual StatusCode G4UA::UserActionToolBase< MaterialTrackRecorder >::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< MaterialTrackRecorder > ActsTrk::MaterialTrackRecorderTool::makeAndFillAction ( G4UA::G4AtlasUserActions & actionLists )

finaloverrideprotectedvirtual

Make the action and push onto the lists.

Implements G4UA::UserActionToolBase< MaterialTrackRecorder >.

Definition at line 17 of file MaterialTrackRecorderTool.cxx.

  {
    ATH_MSG_DEBUG("Constructing a MaterialTrackRecorder action");
 
    MaterialTrackRecorder::Config config;
    config.materialTrackCollectionName = m_materialTrackCollectionName.value();
 
    auto action = std::make_unique<MaterialTrackRecorder>(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<MaterialTrackRecorder> G4UA::UserActionToolBase< MaterialTrackRecorder >::m_actions

protectedinherited

Thread-specific storage of the user action.

Definition at line 70 of file UserActionToolBase.h.

m_excludeMaterials

Gaudi::Property<std::vector<std::string> > ActsTrk::MaterialTrackRecorderTool::m_excludeMaterials {this, "ExcludeMaterials", {"Air", "Vacuum"}, "Material you want to exclude from recording"}

private

The list of material excluded from recording.

Definition at line 31 of file MaterialTrackRecorderTool.h.

{this, "ExcludeMaterials", {"Air", "Vacuum"}, "Material you want to exclude from recording"};

m_materialTrackCollectionName

Gaudi::Property<std::string> ActsTrk::MaterialTrackRecorderTool::m_materialTrackCollectionName {this, "MaterialTrackCollectionName", "OutputMaterialTracks", "Name of the output recorded material track collection"}

private

The name of the recorded material track collection.

Definition at line 27 of file MaterialTrackRecorderTool.h.

{this, "MaterialTrackCollectionName", "OutputMaterialTracks", "Name of the output recorded material track collection"};

---

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

• MaterialTrackRecorderTool.h
• MaterialTrackRecorderTool.cxx