G4UA::G4HitFilterTool Class Reference

#include <G4HitFilterTool.h>

Inheritance diagram for G4UA::G4HitFilterTool:

Collaboration diagram for G4UA::G4HitFilterTool:

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

Protected Member Functions
virtual std::unique_ptr< G4HitFilter >	makeAndFillAction (G4AtlasUserActions &) override final
	Construct the user action for current worker thread. More...

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

Private Attributes
G4HitFilter::Config	m_config
	User action configuration options. More...

Detailed Description

Tool which constructs/manages the G4HitFilter user action.

Definition at line 18 of file G4HitFilterTool.h.

Constructor & Destructor Documentation

G4HitFilterTool()

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

Standard constructor.

Definition at line 12 of file G4HitFilterTool.cxx.

    : UserActionToolBase<G4HitFilter>(type, name, parent)
  {
    declareProperty("VolumeNames", m_config.volumenames);
  }

Member Function Documentation

fillUserAction()

virtual StatusCode G4UA::UserActionToolBase< G4HitFilter >::fillUserAction ( G4AtlasUserActions &  actionLists )

inlinefinaloverridevirtualinherited

Fill the user action lists.

Definition at line 45 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::G4HitFilterTool::finalize ( )

overridevirtual

Finalize the tool.

Definition at line 32 of file G4HitFilterTool.cxx.

  {
    // Merge results across worker threads
    G4HitFilter::Report report;
    m_actions.accumulate(report, &G4HitFilter::getReport,
                         &G4HitFilter::Report::merge);
 
    // Report the results
    ATH_MSG_INFO("processed " << report.ntot << " events, " <<
                 report.npass << " events passed filter ");
    return StatusCode::SUCCESS;
  }

makeAndFillAction()

std::unique_ptr< G4HitFilter > G4UA::G4HitFilterTool::makeAndFillAction ( G4AtlasUserActions &  actionList )

finaloverrideprotectedvirtual

Construct the user action for current worker thread.

Implements G4UA::UserActionToolBase< G4HitFilter >.

Definition at line 22 of file G4HitFilterTool.cxx.

  {
    ATH_MSG_DEBUG("Constructing a G4HitFilter action");
    auto action = std::make_unique<G4HitFilter>(m_config);
    actionList.runActions.push_back( action.get() );
    actionList.eventActions.push_back( action.get() );
    return action;
  }

Member Data Documentation

m_actions

ThreadSpecificUserAction<G4HitFilter > G4UA::UserActionToolBase< G4HitFilter >::m_actions

protectedinherited

Thread-specific storage of the user action.

Definition at line 63 of file UserActionToolBase.h.

m_config

G4HitFilter::Config G4UA::G4HitFilterTool::m_config

private

User action configuration options.

Definition at line 39 of file G4HitFilterTool.h.

---

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

• G4HitFilterTool.h
• G4HitFilterTool.cxx