ATLAS Offline Software
HardScatterVertexDecorator.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
3 */
4 
6 // HardScatterVertexDecorator.h, (c) ATLAS Detector software
8 
9 #ifndef DERIVATIONFRAMEWORK_HARDSCATTERVERTEXDECORATOR_H
10 #define DERIVATIONFRAMEWORK_HARDSCATTERVERTEXDECORATOR_H
11 
12 // Framework include(s):
17 #include "GaudiKernel/ToolHandle.h"
18 
19 // EDM include(s):
22 
23 // Tool include(s):
26 
27 namespace DerivationFramework {
28 
29  class HardScatterVertexDecorator : public extends<AthAlgTool, IAugmentationTool>
30  {
32  // Public methods:
34  public:
35 
38 
39  HardScatterVertexDecorator(const std::string& type, const std::string& name, const IInterface* parent);
40 
42 
45 
48 
50  virtual StatusCode addBranches() const;
51 
53 
55  // Private data:
57  private:
58 
61 
63  SG::ReadHandleKey<xAOD::VertexContainer> m_vtxContKey{this, "VertexContainerName", "PrimaryVertices",
64  "Name of the input vertex container"};
65 
67  Gaudi::Property<std::string> m_evtDecoName{this, "HardScatterDecoName", "hardScatterVertexLink",
68  "Name of the hardscatter vertex decoration (applied to xAOD::EventInfo)"};
69 
71  ToolHandle<InDet::IInDetHardScatterSelectionTool> m_vtxSelectTool{this, "HardScatterSelectionTool", "",
72  "IInDetHardScatterSelectionTool for selecting the hardscatter vertex" };
73 
75  private:
76 
79 
81  SG::ReadHandleKey<xAOD::EventInfo> m_evtInfoKey {this, "EventInfo", "EventInfo", "EventInfo key"};
82 
84  SG::WriteDecorHandleKey<xAOD::EventInfo> m_evtDecoKey{this, "VertexDecorationKey", "",
85  "Declaration of the HardScatterVertexLink key. Will be overwrriten during initialize"};
86 
88 
89  }; // end: class HardScatterVertexDecorator
90 } // end: namespace DerivationFramework
91 
92 #endif // end: DERIVATIONFRAMEWORK_HARDSCATTERVERTEXDECORATOR_H
SG::WriteDecorHandleKey< xAOD::EventInfo >
PropertyWrapper.h
VertexContainerFwd.h
DerivationFramework::HardScatterVertexDecorator::m_vtxSelectTool
ToolHandle< InDet::IInDetHardScatterSelectionTool > m_vtxSelectTool
ToolHandle for the IInDetHardScatterSelectionTool.
Definition: HardScatterVertexDecorator.h:71
IAugmentationTool.h
DerivationFramework::HardScatterVertexDecorator::m_evtDecoName
Gaudi::Property< std::string > m_evtDecoName
Name of the output hardscatter decoration (applied to xAOD::EventInfo)
Definition: HardScatterVertexDecorator.h:67
SG::ReadHandleKey
Property holding a SG store/key/clid from which a ReadHandle is made.
Definition: StoreGate/StoreGate/ReadHandleKey.h:39
python.CaloAddPedShiftConfig.type
type
Definition: CaloAddPedShiftConfig.py:42
DerivationFramework::HardScatterVertexDecorator
Definition: HardScatterVertexDecorator.h:30
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
ReadHandleKey.h
Property holding a SG store/key/clid from which a ReadHandle is made.
AthAlgTool.h
test_pyathena.parent
parent
Definition: test_pyathena.py:15
DerivationFramework
THE reconstruction tool.
Definition: ParticleSortingAlg.h:24
DerivationFramework::HardScatterVertexDecorator::addBranches
virtual StatusCode addBranches() const
Function decorating the inputs.
Definition: HardScatterVertexDecorator.cxx:64
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:240
EventInfo.h
DerivationFramework::HardScatterVertexDecorator::m_evtInfoKey
SG::ReadHandleKey< xAOD::EventInfo > m_evtInfoKey
xAOD::EventInfo ReadHandleKey
Definition: HardScatterVertexDecorator.h:81
WriteDecorHandleKey.h
IInDetHardScatterSelectionTool.h
DerivationFramework::HardScatterVertexDecorator::m_vtxContKey
SG::ReadHandleKey< xAOD::VertexContainer > m_vtxContKey
ReadHandleKey for the input vertices.
Definition: HardScatterVertexDecorator.h:63
DerivationFramework::HardScatterVertexDecorator::m_evtDecoKey
SG::WriteDecorHandleKey< xAOD::EventInfo > m_evtDecoKey
WriteDecorHandleKey for the output hardscatter decoration (applied to xAOD::EventInfo)
Definition: HardScatterVertexDecorator.h:84
DerivationFramework::HardScatterVertexDecorator::initialize
StatusCode initialize()
Function initialising the tool.
Definition: HardScatterVertexDecorator.cxx:29
DerivationFramework::HardScatterVertexDecorator::HardScatterVertexDecorator
HardScatterVertexDecorator(const std::string &type, const std::string &name, const IInterface *parent)
Definition: HardScatterVertexDecorator.cxx:25