SensitiveDetectorMasterTool Class Reference

Public tool which manages all the sensitive detector tools. More...

#include <SensitiveDetectorMasterTool.h>

Inheritance diagram for SensitiveDetectorMasterTool:

Collaboration diagram for SensitiveDetectorMasterTool:

Public Member Functions
	SensitiveDetectorMasterTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor. More...
virtual	~SensitiveDetectorMasterTool ()
	Empty virtual destructor. More...
StatusCode	initialize () override final
	Retrieve the SD tools. SD creation is deferred until initializeSDs. More...
StatusCode	initializeSDs () override final
	Calls initializeSD on each SD tool to create the SDs for the current worker thread. More...
StatusCode	BeginOfAthenaEvent () override final
	Calls SetupEvent on each SD tool. More...
StatusCode	EndOfAthenaEvent () override final
	Calls Gather on each SD tool. More...

Private Attributes
ToolHandleArray< ISensitiveDetector >	m_senDetTools {this, "SensitiveDetectors", {}, "Tool handle array of all sensitive detector tools"}
	Private array of tool handles pointing to all SD tools. More...

Detailed Description

Public tool which manages all the sensitive detector tools.

This tool provides functionality to trigger creation of SDs for the current worker thread and to invoke special SD methods at the beginning and end of an Athena event.

This will probably be changed (back) to a service in the near future.

Definition at line 25 of file SensitiveDetectorMasterTool.h.

Constructor & Destructor Documentation

SensitiveDetectorMasterTool()

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

Standard constructor.

Definition at line 8 of file SensitiveDetectorMasterTool.cxx.

  : base_class(type, name, parent)
{
}

~SensitiveDetectorMasterTool()

virtual SensitiveDetectorMasterTool::~SensitiveDetectorMasterTool ( )

inlinevirtual

Empty virtual destructor.

Definition at line 32 of file SensitiveDetectorMasterTool.h.

{}

Member Function Documentation

BeginOfAthenaEvent()

StatusCode SensitiveDetectorMasterTool::BeginOfAthenaEvent ( )

finaloverride

Calls SetupEvent on each SD tool.

Definition at line 45 of file SensitiveDetectorMasterTool.cxx.

{
  // Call setup for all sensitive detectors
  for (auto& isd : m_senDetTools) {
    CHECK( isd->SetupEvent() );
  }
  return StatusCode::SUCCESS;
}

EndOfAthenaEvent()

StatusCode SensitiveDetectorMasterTool::EndOfAthenaEvent ( )

finaloverride

Calls Gather on each SD tool.

Definition at line 54 of file SensitiveDetectorMasterTool.cxx.

{
  // Call gather for all sensitive detectors
  for (auto& isd : m_senDetTools) {
    CHECK( isd->Gather() );
  }
  return StatusCode::SUCCESS;
}

initialize()

StatusCode SensitiveDetectorMasterTool::initialize ( )

finaloverride

Retrieve the SD tools. SD creation is deferred until initializeSDs.

Definition at line 15 of file SensitiveDetectorMasterTool.cxx.

{
  ATH_MSG_DEBUG("initialize");
 
  // Retrieve all of the sensitive detector tools.
  // SD creation is deferred until later for multi-threading.
  CHECK( m_senDetTools.retrieve() );
  return StatusCode::SUCCESS;
}

initializeSDs()

StatusCode SensitiveDetectorMasterTool::initializeSDs ( )

finaloverride

Calls initializeSD on each SD tool to create the SDs for the current worker thread.

Definition at line 25 of file SensitiveDetectorMasterTool.cxx.

{
  // This method will be called concurrently in AthenaMT during initialization.
  // We thus conservatively lock the entire method to protect things like the
  // MsgStream usage and downstream clients.
  static std::mutex sdMutex;
  std::lock_guard<std::mutex> sdLock(sdMutex);
 
  ATH_MSG_VERBOSE( name() << "::initializeSDs()" );
 
  // Loop through all the sensitive detector tools and
  // initialize them for this thread.
  ATH_MSG_INFO( "Initializing list of " << m_senDetTools.size() <<
                " sensitive detectors." );
  for (auto& isd : m_senDetTools) {
    CHECK( isd->initializeSD() );
  }
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_senDetTools

ToolHandleArray<ISensitiveDetector> SensitiveDetectorMasterTool::m_senDetTools {this, "SensitiveDetectors", {}, "Tool handle array of all sensitive detector tools"}

private

Private array of tool handles pointing to all SD tools.

Definition at line 46 of file SensitiveDetectorMasterTool.h.

---

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

• SensitiveDetectorMasterTool.h
• SensitiveDetectorMasterTool.cxx