ATLAS Offline Software
ICaloRingsBuilder.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
3 */
4 
5 // $Id: ICaloRingsBuilder.h 670609 2015-05-28 14:45:21Z wsfreund $
6 #ifndef CALORINGERTOOLS_ICALORINGSBUILDER
7 #define CALORINGERTOOLS_ICALORINGSBUILDER
8 
20 #include "GaudiKernel/IAlgTool.h"
21 #include "AthLinks/ElementLink.h"
22 #include "StoreGate/WriteHandle.h"
23 
24 // xAOD includes:
25 #include "xAODBase/IParticle.h"
29 
30 // Forward declarations
32 
33 namespace Ringer {
34 
35 static const InterfaceID IID_ICaloRingsBuilder("ICaloRingsBuilder", 1, 0);
36 
37 class ICaloRingsBuilder : virtual public IAlgTool
38 {
39  public:
40 
42  virtual ~ICaloRingsBuilder() {};
43 
45  static const InterfaceID& interfaceID();
46 
48  virtual StatusCode initialize() = 0;
51  , xAOD::RingSetContainer* rsCont
52  , const std::size_t nReserve = 0) = 0;
57  ElementLink<xAOD::CaloRingsContainer> &clRingsLink) = 0;
61  virtual StatusCode execute(const xAOD::CaloCluster &cluster,
62  ElementLink<xAOD::CaloRingsContainer> &clRingsLink) = 0;
64  virtual StatusCode finalize() = 0;
65 
68 
75  virtual bool useShowerShapeBarycenter() = 0;
76  virtual std::size_t nRingSets() const = 0;
80 
81 };
82 
83 inline const InterfaceID& ICaloRingsBuilder::interfaceID()
84 {
85  return IID_ICaloRingsBuilder;
86 }
87 
88 } // namespace Ringer
89 
90 #endif
Ringer::ICaloRingsBuilder::nRingSets
virtual std::size_t nRingSets() const =0
Trk::ParticleSwitcher::particle
constexpr ParticleHypothesis particle[PARTICLEHYPOTHESES]
the array of masses
Definition: ParticleHypothesis.h:76
Ringer::ICaloRingsBuilder::rawConf
virtual const xAOD::RingSetConf::RawConfCollection & rawConf()=0
Extra methods:
IParticle.h
Ringer::ICaloRingsBuilder::rsContName
virtual const SG::WriteHandleKey< xAOD::RingSetContainer > & rsContName() const =0
xAOD::RingSetConf_v1::RawConfCollection
std::vector< RawConf > RawConfCollection
typedef The raw configuration structure data holder
Definition: RingSetConf_v1.h:124
Ringer::ICaloRingsBuilder::finalize
virtual StatusCode finalize()=0
finalize method
Ringer::ICaloRingsBuilder::crContName
virtual const SG::WriteHandleKey< xAOD::CaloRingsContainer > & crContName() const =0
Ringer::ICaloRingsBuilder::execute
virtual StatusCode execute(const xAOD::CaloCluster &cluster, ElementLink< xAOD::CaloRingsContainer > &clRingsLink)=0
build CaloRings for CaloCluster
Ringer::ICaloRingsBuilder::preExecute
virtual StatusCode preExecute(xAOD::CaloRingsContainer *crCont, xAOD::RingSetContainer *rsCont, const std::size_t nReserve=0)=0
execute container creation method
xAOD::IParticle
Class providing the definition of the 4-vector interface.
Definition: Event/xAOD/xAODBase/xAODBase/IParticle.h:40
Ringer::ICaloRingsBuilder::useShowerShapeBarycenter
virtual bool useShowerShapeBarycenter()=0
Retrieve whether it was set used shower shape barycenter.
Ringer::ICaloRingsBuilder
Definition: ICaloRingsBuilder.h:38
WriteHandle.h
Handle class for recording to StoreGate.
xAOD::CaloCluster_v1
Description of a calorimeter cluster.
Definition: CaloCluster_v1.h:59
CaloRingsContainer.h
SG::WriteHandleKey
Property holding a SG store/key/clid from which a WriteHandle is made.
Definition: StoreGate/StoreGate/WriteHandleKey.h:40
CaloClusterFwd.h
Ringer::ICaloRingsBuilder::initialize
virtual StatusCode initialize()=0
initialize method
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
Ringer::ICaloRingsBuilder::interfaceID
static const InterfaceID & interfaceID()
AlgTool interface methods.
Definition: ICaloRingsBuilder.h:83
DataVector
Derived DataVector<T>.
Definition: DataVector.h:581
RingSetContainer.h
RingSetConf.h
Ringer::ICaloRingsBuilder::execute
virtual StatusCode execute(const xAOD::IParticle &particle, ElementLink< xAOD::CaloRingsContainer > &clRingsLink)=0
build CaloRings for IParticle
Ringer
Namespace dedicated for Ringer utilities.
Definition: CaloRingsDefs.h:9
Ringer::ICaloRingsBuilder::~ICaloRingsBuilder
virtual ~ICaloRingsBuilder()
Virtual destructor.
Definition: ICaloRingsBuilder.h:42