ATLAS Offline Software
HardScatterVertexDecorator.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
3 */
4 
5 #ifndef DERIVATIONFRAMEWORK_HARDSCATTERVERTEXDECORATOR_H
6 #define DERIVATIONFRAMEWORK_HARDSCATTERVERTEXDECORATOR_H
7 
8 // Framework include(s):
13 #include "GaudiKernel/ToolHandle.h"
14 
15 // EDM include(s):
18 
19 // Tool include(s):
22 
23 namespace DerivationFramework {
24 
25  class HardScatterVertexDecorator : public extends<AthAlgTool, IAugmentationTool>
26  {
28  // Public methods:
30  public:
31 
34 
35  using base_class::base_class;
36 
38 
41 
43  virtual StatusCode initialize() override final;
44 
46  virtual StatusCode addBranches(const EventContext& ctx) const override final;
47 
49 
51  // Private data:
53  private:
54 
57 
59  SG::ReadHandleKey<xAOD::VertexContainer> m_vtxContKey{this, "VertexContainerName", "PrimaryVertices",
60  "Name of the input vertex container"};
61 
63  ToolHandle<InDet::IInDetHardScatterSelectionTool> m_vtxSelectTool{this, "HardScatterSelectionTool", "",
64  "IInDetHardScatterSelectionTool for selecting the hardscatter vertex" };
65 
67  SG::ReadHandleKey<xAOD::EventInfo> m_evtInfoKey {this, "EventInfo", "EventInfo", "EventInfo key"};
68 
70  SG::WriteDecorHandleKey<xAOD::EventInfo> m_evtDecoKey{this, "HardScatterDecoName", m_evtInfoKey, "hardScatterVertexLink",
71  "Name of the hardscatter vertex decoration (applied to xAOD::EventInfo)"};
72 
74 
75  }; // end: class HardScatterVertexDecorator
76 } // end: namespace DerivationFramework
77 
78 #endif // end: DERIVATIONFRAMEWORK_HARDSCATTERVERTEXDECORATOR_H
ReadHandleKey.h
Property holding a SG store/key/clid from which a ReadHandle is made.
SG::WriteDecorHandleKey< xAOD::EventInfo >
PropertyWrapper.h
VertexContainerFwd.h
DerivationFramework::HardScatterVertexDecorator::m_vtxSelectTool
ToolHandle< InDet::IInDetHardScatterSelectionTool > m_vtxSelectTool
ToolHandle for the IInDetHardScatterSelectionTool.
Definition: HardScatterVertexDecorator.h:63
IAugmentationTool.h
SG::ReadHandleKey
Property holding a SG store/key/clid from which a ReadHandle is made.
Definition: StoreGate/StoreGate/ReadHandleKey.h:39
DerivationFramework::HardScatterVertexDecorator::initialize
virtual StatusCode initialize() override final
Function initialising the tool.
Definition: HardScatterVertexDecorator.cxx:21
DerivationFramework::HardScatterVertexDecorator
Definition: HardScatterVertexDecorator.h:26
WriteDecorHandleKey.h
Property holding a SG store/key/clid/attr name from which a WriteDecorHandle is made.
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
AthAlgTool.h
DerivationFramework
THE reconstruction tool.
Definition: ParticleSortingAlg.h:24
EventInfo.h
DerivationFramework::HardScatterVertexDecorator::m_evtInfoKey
SG::ReadHandleKey< xAOD::EventInfo > m_evtInfoKey
xAOD::EventInfo ReadHandleKey
Definition: HardScatterVertexDecorator.h:67
IInDetHardScatterSelectionTool.h
DerivationFramework::HardScatterVertexDecorator::m_vtxContKey
SG::ReadHandleKey< xAOD::VertexContainer > m_vtxContKey
ReadHandleKey for the input vertices.
Definition: HardScatterVertexDecorator.h:59
DerivationFramework::HardScatterVertexDecorator::m_evtDecoKey
SG::WriteDecorHandleKey< xAOD::EventInfo > m_evtDecoKey
WriteDecorHandleKey for the output hardscatter decoration (applied to xAOD::EventInfo)
Definition: HardScatterVertexDecorator.h:70
DerivationFramework::HardScatterVertexDecorator::addBranches
virtual StatusCode addBranches(const EventContext &ctx) const override final
Function decorating the inputs.
Definition: HardScatterVertexDecorator.cxx:49