G4UA::G4TrackCounterTool Class Reference

Tool which manages the G4TrackCounter action. More...

#include <G4TrackCounterTool.h>

Inheritance diagram for G4UA::G4TrackCounterTool:

Collaboration diagram for G4UA::G4TrackCounterTool:

Public Member Functions
	G4TrackCounterTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor.
virtual StatusCode	initialize () override final
	Initialize tool.
virtual StatusCode	finalize () override final
	Finalize and merge results from all threads.
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< G4TrackCounter >	makeAndFillAction (G4AtlasUserActions &) override final
	Create action for this thread.

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

Detailed Description

Tool which manages the G4TrackCounter action.

This tool creates the G4TrackCounter for each thread and merges the track counts from all threads in finalization.

Author

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

Definition at line 24 of file G4TrackCounterTool.h.

Constructor & Destructor Documentation

G4TrackCounterTool()

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

Standard constructor.

Definition at line 13 of file G4TrackCounterTool.cxx.

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

Member Function Documentation

BeginOfAthenaEvent()

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

inlineoverrideinherited

Calls BeginOfAthenaEvent.

Definition at line 59 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

EndOfAthenaEvent()

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

inlineoverrideinherited

Calls EndOfAthenaEvent.

Definition at line 61 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

fillUserAction()

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

finalize()

StatusCode G4UA::G4TrackCounterTool::finalize ( )

finaloverridevirtual

Finalize and merge results from all threads.

Definition at line 32 of file G4TrackCounterTool.cxx.

  {
    ATH_MSG_DEBUG( "Finalizing " << name() );
 
    // Accumulate the results across threads
    G4TrackCounter::Report report;
    m_actions.accumulate(report, &G4TrackCounter::getReport,
                         &G4TrackCounter::Report::merge);
 
    // Report the totals
    ATH_MSG_INFO("nEvents          " << report.nEvents);
    ATH_MSG_INFO("nPrimaryTracks   " << report.nPrimaryTracks);
    ATH_MSG_INFO("nSecondaryTracks " << report.nSecondaryTracks);
    ATH_MSG_INFO("n50MeVTracks     " << report.n50MeVTracks);
 
    return StatusCode::SUCCESS;
  }

initialize()

StatusCode G4UA::G4TrackCounterTool::initialize ( )

finaloverridevirtual

Initialize tool.

Definition at line 23 of file G4TrackCounterTool.cxx.

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

makeAndFillAction()

std::unique_ptr< G4TrackCounter > G4UA::G4TrackCounterTool::makeAndFillAction ( G4AtlasUserActions & actionList )

finaloverrideprotectedvirtual

Create action for this thread.

Implements G4UA::UserActionToolBase< G4TrackCounter >.

Definition at line 54 of file G4TrackCounterTool.cxx.

  {
    ATH_MSG_DEBUG("Making a G4TrackCounter action");
    auto action = std::make_unique<G4TrackCounter>();
    actionList.eventActions.push_back( action.get() );
    actionList.trackingActions.push_back( action.get() );
    return action;
  }

Member Data Documentation

m_actions

ThreadSpecificUserAction<G4TrackCounter> G4UA::UserActionToolBase< G4TrackCounter >::m_actions

protectedinherited

Thread-specific storage of the user action.

Definition at line 70 of file UserActionToolBase.h.

---

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

• G4TrackCounterTool.h
• G4TrackCounterTool.cxx