G4UA::G4SimTimerTool Class Reference

Tool which manages the G4SimTimer action. More...

#include <G4SimTimerTool.h>

Inheritance diagram for G4UA::G4SimTimerTool:

Collaboration diagram for G4UA::G4SimTimerTool:

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

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

Detailed Description

Tool which manages the G4SimTimer action.

Create the G4SimTimer for each worker thread and merges timing results in finalization.

Author

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

Definition at line 28 of file G4SimTimerTool.h.

Constructor & Destructor Documentation

G4SimTimerTool()

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

Standard constructor.

Definition at line 13 of file G4SimTimerTool.cxx.

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

Member Function Documentation

BeginOfAthenaEvent()

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

inlineoverrideinherited

Calls BeginOfAthenaEvent.

Definition at line 59 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

EndOfAthenaEvent()

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

inlineoverrideinherited

Calls EndOfAthenaEvent.

Definition at line 61 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

fillUserAction()

virtual StatusCode G4UA::UserActionToolBase< G4SimTimer >::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::G4SimTimerTool::finalize ( )

overridevirtual

Finalize and merge results from all worker threads.

Definition at line 32 of file G4SimTimerTool.cxx.

  {
    ATH_MSG_DEBUG( "Finalizing " << name() );
 
    // Accumulate results across threads
    G4SimTimer::Report report;
    m_actions.accumulate(report, &G4SimTimer::getReport,
                         &G4SimTimer::Report::merge);
 
    // Report the results
    auto meanSigma = report.meanAndSigma();
    ATH_MSG_INFO("Finalized timing results for " << report.nEvent <<
                 " events (not all events used)");
    ATH_MSG_INFO("Average time per event was " <<
                 std::setprecision(4) << meanSigma.first << " +- " <<
                 std::setprecision(4) << meanSigma.second);
    return StatusCode::SUCCESS;
  }

initialize()

StatusCode G4UA::G4SimTimerTool::initialize ( )

overridevirtual

Initialize the tool.

Definition at line 23 of file G4SimTimerTool.cxx.

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

makeAndFillAction()

std::unique_ptr< G4SimTimer > G4UA::G4SimTimerTool::makeAndFillAction ( G4AtlasUserActions & actionList )

finaloverrideprotectedvirtual

Create aciton for this thread.

Implements G4UA::UserActionToolBase< G4SimTimer >.

Definition at line 55 of file G4SimTimerTool.cxx.

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

Member Data Documentation

m_actions

ThreadSpecificUserAction<G4SimTimer> G4UA::UserActionToolBase< G4SimTimer >::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:

• G4SimTimerTool.h
• G4SimTimerTool.cxx