G4UA::MCTruthSteppingActionTool Class Reference

A tool for managing the MCTruthSteppingAction. More...

#include <MCTruthSteppingActionTool.h>

Inheritance diagram for G4UA::MCTruthSteppingActionTool:

Collaboration diagram for G4UA::MCTruthSteppingActionTool:

Public Member Functions
	MCTruthSteppingActionTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor.
virtual StatusCode	initialize () override final
	Initialize the tool.
virtual StatusCode	fillUserAction (G4AtlasUserActions &actionLists) override final
	Fill the user action lists.

Protected Member Functions
virtual std::unique_ptr< MCTruthSteppingAction >	makeAndFillAction (G4AtlasUserActions &) override final
	Setup the user action for current thread.
StatusCode	BeginOfAthenaEvent (HitCollectionMap &) override
	Calls BeginOfAthenaEvent.
StatusCode	EndOfAthenaEvent (HitCollectionMap &) override
	Calls EndOfAthenaEvent.

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

Private Attributes
std::map< std::string, std::string >	m_volumeCollectionMap
	Map of volume name to output collection name.
int	m_secondarySavingLevel
	The saving level for secondaries.
int	m_subDetVolLevel
	The level in the G4 volume hierarchy at which we find the sub-detector.

Detailed Description

A tool for managing the MCTruthSteppingAction.

Author

Steve Farrell Steve.nosp@m.n.Fa.nosp@m.rrell.nosp@m.@cer.nosp@m.n.ch

Definition at line 26 of file MCTruthSteppingActionTool.h.

Constructor & Destructor Documentation

MCTruthSteppingActionTool()

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

Standard constructor.

Definition at line 14 of file MCTruthSteppingActionTool.cxx.

    : UserActionToolBase<MCTruthSteppingAction>(type, name, parent),
      m_secondarySavingLevel(2),
      m_subDetVolLevel(1)
  {
    declareProperty("VolumeCollectionMap", m_volumeCollectionMap,
                    "Map of volume name to output collection name");
    declareProperty("SecondarySavingLevel", m_secondarySavingLevel,
                    "Three valid options: 1 - Primaries; "
                    "2 - StoredSecondaries(default); 3 - All");
    declareProperty("SubDetVolumeLevel", m_subDetVolLevel,
                    "The level in the G4 volume hierarchy at which can we find "
                    "the sub-detector name");
  }

Member Function Documentation

BeginOfAthenaEvent()

StatusCode G4UA::MCTruthSteppingActionTool::BeginOfAthenaEvent ( HitCollectionMap & hitCollections )

overrideprotected

Calls BeginOfAthenaEvent.

Definition at line 56 of file MCTruthSteppingActionTool.cxx.

  {
    for(const auto& volCollPair : m_volumeCollectionMap) {
      hitCollections.Emplace<TrackRecordCollection>(volCollPair.second, volCollPair.second);
    }
    return StatusCode::SUCCESS;
  }

EndOfAthenaEvent()

StatusCode G4UA::MCTruthSteppingActionTool::EndOfAthenaEvent ( HitCollectionMap & hitCollections )

overrideprotected

Calls EndOfAthenaEvent.

Definition at line 64 of file MCTruthSteppingActionTool.cxx.

  {
    for(const auto& volCollPair : m_volumeCollectionMap) {
      CHECK(hitCollections.Record<TrackRecordCollection>(volCollPair.second));
    }
    return StatusCode::SUCCESS;
  }

fillUserAction()

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

initialize()

StatusCode G4UA::MCTruthSteppingActionTool::initialize ( )

finaloverridevirtual

Initialize the tool.

Definition at line 34 of file MCTruthSteppingActionTool.cxx.

  {
    ATH_MSG_DEBUG( "Initializing " << name() );
    return StatusCode::SUCCESS;
  }

makeAndFillAction()

std::unique_ptr< MCTruthSteppingAction > G4UA::MCTruthSteppingActionTool::makeAndFillAction ( G4AtlasUserActions & actionLists )

finaloverrideprotectedvirtual

Setup the user action for current thread.

Implements G4UA::UserActionToolBase< MCTruthSteppingAction >.

Definition at line 44 of file MCTruthSteppingActionTool.cxx.

  {
    ATH_MSG_DEBUG("Constructing an MCTruthSteppingAction");
    auto action = std::make_unique<MCTruthSteppingAction> (
        m_volumeCollectionMap, m_secondarySavingLevel, m_subDetVolLevel,
        msgSvc(), msg().level() );
    actionLists.eventActions.push_back( action.get() );
    actionLists.steppingActions.push_back( action.get() );
    return action;
  }

Member Data Documentation

m_actions

ThreadSpecificUserAction<MCTruthSteppingAction> G4UA::UserActionToolBase< MCTruthSteppingAction >::m_actions

protectedinherited

Thread-specific storage of the user action.

Definition at line 70 of file UserActionToolBase.h.

m_secondarySavingLevel

int G4UA::MCTruthSteppingActionTool::m_secondarySavingLevel

private

The saving level for secondaries.

Definition at line 55 of file MCTruthSteppingActionTool.h.

m_subDetVolLevel

int G4UA::MCTruthSteppingActionTool::m_subDetVolLevel

private

The level in the G4 volume hierarchy at which we find the sub-detector.

Definition at line 58 of file MCTruthSteppingActionTool.h.

m_volumeCollectionMap

std::map<std::string, std::string> G4UA::MCTruthSteppingActionTool::m_volumeCollectionMap

private

Map of volume name to output collection name.

Definition at line 52 of file MCTruthSteppingActionTool.h.

---

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

• MCTruthSteppingActionTool.h
• MCTruthSteppingActionTool.cxx