G4UA::iGeant4::TrackProcessorUserActionPassBackTool Class Reference

Tool which manages the TrackProcessorUserActionPassBack. More...

#include <TrackProcessorUserActionPassBackTool.h>

Inheritance diagram for G4UA::iGeant4::TrackProcessorUserActionPassBackTool:

Collaboration diagram for G4UA::iGeant4::TrackProcessorUserActionPassBackTool:

Public Member Functions
	TrackProcessorUserActionPassBackTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor.
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< TrackProcessorUserActionPassBack >	makeAndFillAction (G4AtlasUserActions &) override final
	Create an action for this thread.

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

Private Attributes
TrackProcessorUserActionPassBack::Config	m_config
	Configuration parameters.

Detailed Description

Tool which manages the TrackProcessorUserActionPassBack.

Author

Andrea Di Simone

Definition at line 22 of file TrackProcessorUserActionPassBackTool.h.

Constructor & Destructor Documentation

TrackProcessorUserActionPassBackTool()

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

Standard constructor.

Definition at line 14 of file TrackProcessorUserActionPassBackTool.cxx.

      : UserActionToolBase<TrackProcessorUserActionPassBack>(type, name, parent)
    {
      declareProperty("ParticleBroker", m_config.particleBroker, "ISF Particle Broker Svc");
      declareProperty("GeoIDSvc"      , m_config.geoIDSvc      , "ISF GeoID Svc"          );
 
      declareProperty("PassBackEkinThreshold",
                      m_config.passBackEkinThreshold=0.05, //TODO: should we add units here (MeV)?
                      "Ekin cut-off for particles returned to ISF");
      declareProperty("KillBoundaryParticlesBelowThreshold",
                      m_config.killBoundaryParticlesBelowThreshold=false,
                      "Kill particles at boundary which are below Ekin cut-off rather than continue their simulation in G4");
    }

Member Function Documentation

BeginOfAthenaEvent()

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

inlineoverrideinherited

Calls BeginOfAthenaEvent.

Definition at line 59 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

EndOfAthenaEvent()

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

inlineoverrideinherited

Calls EndOfAthenaEvent.

Definition at line 61 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

fillUserAction()

virtual StatusCode G4UA::UserActionToolBase< TrackProcessorUserActionPassBack >::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< TrackProcessorUserActionPassBack > G4UA::iGeant4::TrackProcessorUserActionPassBackTool::makeAndFillAction ( G4AtlasUserActions & actionList )

finaloverrideprotectedvirtual

Create an action for this thread.

Implements G4UA::UserActionToolBase< TrackProcessorUserActionPassBack >.

Definition at line 32 of file TrackProcessorUserActionPassBackTool.cxx.

    {
      ATH_MSG_DEBUG("Constructing a TrackProcessorUserActionPassBack");
      if(msgLvl(MSG::VERBOSE))    { m_config.verboseLevel = 10; }
      else if(msgLvl(MSG::DEBUG)) { m_config.verboseLevel = 5;  }
      auto action = std::make_unique<TrackProcessorUserActionPassBack>(m_config);
      actionList.eventActions.push_back( action.get() );
      actionList.trackingActions.push_back( action.get() );
      actionList.steppingActions.push_back( action.get() );
      return action;
    }

Member Data Documentation

m_actions

ThreadSpecificUserAction<TrackProcessorUserActionPassBack> G4UA::UserActionToolBase< TrackProcessorUserActionPassBack >::m_actions

protectedinherited

Thread-specific storage of the user action.

Definition at line 70 of file UserActionToolBase.h.

m_config

TrackProcessorUserActionPassBack::Config G4UA::iGeant4::TrackProcessorUserActionPassBackTool::m_config

private

Configuration parameters.

Definition at line 37 of file TrackProcessorUserActionPassBackTool.h.

---

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

• TrackProcessorUserActionPassBackTool.h
• TrackProcessorUserActionPassBackTool.cxx