DerivationFramework::HardScatterVertexDecorator Class Reference

#include <HardScatterVertexDecorator.h>

Inheritance diagram for DerivationFramework::HardScatterVertexDecorator:

Collaboration diagram for DerivationFramework::HardScatterVertexDecorator:

Public Member Functions
Constructor
	HardScatterVertexDecorator (const std::string &type, const std::string &name, const IInterface *parent)
Function(s) implementing the AthAlgTool and IAugmentationTool interfaces
StatusCode	initialize ()
	Function initialising the tool. More...
virtual StatusCode	addBranches () const
	Function decorating the inputs. More...

Private Attributes
The properties that can be defined via the python job options
SG::ReadHandleKey< xAOD::VertexContainer >	m_vtxContKey
	ReadHandleKey for the input vertices. More...
Gaudi::Property< std::string >	m_evtDecoName
	Name of the output hardscatter decoration (applied to xAOD::EventInfo) More...
ToolHandle< InDet::IInDetHardScatterSelectionTool >	m_vtxSelectTool
	ToolHandle for the IInDetHardScatterSelectionTool. More...
Truly private internal data members
SG::ReadHandleKey< xAOD::EventInfo >	m_evtInfoKey {this, "EventInfo", "EventInfo", "EventInfo key"}
	xAOD::EventInfo ReadHandleKey More...
SG::WriteDecorHandleKey< xAOD::EventInfo >	m_evtDecoKey
	WriteDecorHandleKey for the output hardscatter decoration (applied to xAOD::EventInfo) More...

Detailed Description

Definition at line 29 of file HardScatterVertexDecorator.h.

Constructor & Destructor Documentation

HardScatterVertexDecorator()

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

Definition at line 25 of file HardScatterVertexDecorator.cxx.

                                                                                                                               : 
    base_class(type, name, parent) {
  }

Member Function Documentation

addBranches()

StatusCode DerivationFramework::HardScatterVertexDecorator::addBranches ( ) const

virtual

Function decorating the inputs.

Definition at line 64 of file HardScatterVertexDecorator.cxx.

  {
    ATH_MSG_DEBUG("In addBranches(...) for " << name() <<  "...");
 
    const EventContext& ctx = Gaudi::Hive::currentContext();
 
    // Open our vertex container
    SG::ReadHandle<xAOD::VertexContainer> vtxCont(m_vtxContKey, ctx);
    if (!vtxCont.isValid()) {
      ATH_MSG_ERROR("Unable to retrieve xAOD::VertexContainer!");
      return StatusCode::FAILURE;
    }
 
    // Open our event info
    SG::ReadHandle<xAOD::EventInfo> evtInfo(m_evtInfoKey, ctx);
    if (!evtInfo.isValid()) {
      ATH_MSG_ERROR("Unable to retrieve xAOD::EventInfo!");
      return StatusCode::FAILURE;
    }  
 
    // Instantiate our WriteDecorHandle
    SG::WriteDecorHandle<xAOD::EventInfo, ElementLink<xAOD::VertexContainer>> evtDeco(m_evtDecoKey, ctx);
 
    // Decorate our event info
    evtDeco(*evtInfo) = m_vtxSelectTool->getHardScatterLink(vtxCont.get());
 
    return StatusCode::SUCCESS;
  }  

initialize()

StatusCode DerivationFramework::HardScatterVertexDecorator::initialize

(

)

Function initialising the tool.

Definition at line 29 of file HardScatterVertexDecorator.cxx.

  {
    // Print configuration
    ATH_MSG_DEBUG("Initializing " << name() << "...");
    ATH_MSG_DEBUG("Using VertexContainerName: "      << m_vtxContKey);
    ATH_MSG_DEBUG("Using HardScatterDecoName: "      << m_evtDecoName);
    ATH_MSG_DEBUG("Using HardScatterSelectionTool: " << m_vtxSelectTool);
 
    if (m_vtxContKey.empty()) {
      ATH_MSG_ERROR("No xAOD::VertexContainer provided!");
      return StatusCode::FAILURE;
    }
 
    if (m_evtDecoName.empty()) {
      ATH_MSG_ERROR("Hardscatter decoration name cannot be empty!");
      return StatusCode::FAILURE;
    }
 
    if (m_vtxSelectTool.empty()) {
      ATH_MSG_ERROR("No InDet::IInDetHardScatterSelectionTool provided!");
      return StatusCode::FAILURE;
    }
 
    // Initialize our vertex and event info container reads
    ATH_CHECK(m_vtxContKey.initialize());
    ATH_CHECK(m_evtInfoKey.initialize());
 
    // Instantiate and initialize our event info decorator write
    m_evtDecoKey = m_evtInfoKey.key() + "." + m_evtDecoName;
    ATH_CHECK(m_evtDecoKey.initialize());    
    // Fetch our InDet::IInDetHardScatterSelectionTool
    ATH_CHECK(m_vtxSelectTool.retrieve());
    return StatusCode::SUCCESS;
  }

Member Data Documentation

m_evtDecoKey

SG::WriteDecorHandleKey<xAOD::EventInfo> DerivationFramework::HardScatterVertexDecorator::m_evtDecoKey

private

Initial value:

{this, "VertexDecorationKey", "", 
                                            "Declaration of the HardScatterVertexLink key. Will be overwrriten during initialize"}

WriteDecorHandleKey for the output hardscatter decoration (applied to xAOD::EventInfo)

Definition at line 84 of file HardScatterVertexDecorator.h.

m_evtDecoName

Gaudi::Property<std::string> DerivationFramework::HardScatterVertexDecorator::m_evtDecoName

private

Initial value:

{this, "HardScatterDecoName", "hardScatterVertexLink", 
                                              "Name of the hardscatter vertex decoration (applied to xAOD::EventInfo)"}

Name of the output hardscatter decoration (applied to xAOD::EventInfo)

Definition at line 67 of file HardScatterVertexDecorator.h.

m_evtInfoKey

SG::ReadHandleKey<xAOD::EventInfo> DerivationFramework::HardScatterVertexDecorator::m_evtInfoKey {this, "EventInfo", "EventInfo", "EventInfo key"}

private

xAOD::EventInfo ReadHandleKey

Definition at line 81 of file HardScatterVertexDecorator.h.

m_vtxContKey

SG::ReadHandleKey<xAOD::VertexContainer> DerivationFramework::HardScatterVertexDecorator::m_vtxContKey

private

Initial value:

{this, "VertexContainerName", "PrimaryVertices", 
                                                          "Name of the input vertex container"}

ReadHandleKey for the input vertices.

Definition at line 63 of file HardScatterVertexDecorator.h.

m_vtxSelectTool

ToolHandle<InDet::IInDetHardScatterSelectionTool> DerivationFramework::HardScatterVertexDecorator::m_vtxSelectTool

private

Initial value:

{this, "HardScatterSelectionTool", "",
                                                                      "IInDetHardScatterSelectionTool for selecting the hardscatter vertex" }

ToolHandle for the IInDetHardScatterSelectionTool.

Definition at line 71 of file HardScatterVertexDecorator.h.

---

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

• HardScatterVertexDecorator.h
• HardScatterVertexDecorator.cxx