ATLAS Offline Software
ITkStripCablingTool.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 ITkStripCablingTool_h
6 #define ITkStripCablingTool_h
7 
18 
22 
23 // Gaudi includes
24 #include "GaudiKernel/EventContext.h"
25 
26 //STL includes
27 #include <string>
28 #include <vector>
29 
30 //fwd declarations
31 class StatusCode;
32 class SCT_ID;
33 class Identifier;
34 
38 class ITkStripCablingTool: public extends<AthAlgTool, IITkStripCablingTool> {
39  public:
40 
41  //@name Tool methods, reimplemented
43  using base_class::base_class;
44  virtual ~ITkStripCablingTool() = default;
45  virtual StatusCode initialize() override;
47 
48  //@name ITkStripCablingTool methods implemented, these are visible to clients
50 
51  virtual IdentifierHash getHashFromOnlineId(const ITkStripOnlineId& onlineId, const EventContext& ctx, const bool withWarnings = true) const override;
52 
54  virtual ITkStripOnlineId getOnlineIdFromHash(const IdentifierHash& hash, const EventContext& ctx) const override;
55  virtual ITkStripOnlineId getOnlineIdFromHash(const IdentifierHash& hash) const override;
56 
58  virtual std::uint32_t getRobIdFromHash(const IdentifierHash& hash, const EventContext& ctx) const override;
59  virtual std::uint32_t getRobIdFromHash(const IdentifierHash& hash) const override;
60 
62  virtual void getAllRods(std::vector<std::uint32_t>& usersVector, const EventContext& ctx) const override;
63  virtual void getAllRods(std::vector<std::uint32_t>& usersVector) const override;
64 
66 
67  private:
68  SG::ReadCondHandleKey<ITkStripCablingData> m_data{this, "ITkStripCablingData", "ITkStripCablingData", "ITkStripCablingData created by ITkStripCablingCondAlgFromCoraCool"};
69  StringProperty m_cablingDataSource{this, "DataSource", "", "the name of the data source"};
70  bool m_usingDatabase{true};
71 
72  const SCT_ID* m_idHelper{nullptr};
73 
74  const ITkStripCablingData* getData(const EventContext& ctx) const;
75 };
76 
77 #endif // ITkStripCablingTool_h
ITkStripCablingTool::m_usingDatabase
bool m_usingDatabase
Definition: ITkStripCablingTool.h:70
ITkStripCablingTool::m_idHelper
const SCT_ID * m_idHelper
helper for offlineId/hash conversions
Definition: ITkStripCablingTool.h:72
xAOD::uint32_t
setEventNumber uint32_t
Definition: EventInfo_v1.cxx:127
ITkStripCablingTool::initialize
virtual StatusCode initialize() override
Definition: ITkStripCablingTool.cxx:35
ITkStripCablingTool::m_cablingDataSource
StringProperty m_cablingDataSource
Definition: ITkStripCablingTool.h:69
ITkStripCablingData
Definition: ITkStripCablingData.h:24
ITkStripCablingData.h
ITkStripCablingTool::~ITkStripCablingTool
virtual ~ITkStripCablingTool()=default
ITkStripCablingTool::getHashFromOnlineId
virtual IdentifierHash getHashFromOnlineId(const ITkStripOnlineId &onlineId, const EventContext &ctx, const bool withWarnings=true) const override
Definition: ITkStripCablingTool.cxx:46
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
AthAlgTool.h
ITkStripCablingTool
Definition: ITkStripCablingTool.h:38
IITkStripCablingTool.h
ReadCondHandleKey.h
IdentifierHash.h
ITkStripCablingTool::getOnlineIdFromHash
virtual ITkStripOnlineId getOnlineIdFromHash(const IdentifierHash &hash, const EventContext &ctx) const override
return the online Id, given a hash (used by simulation encoders)
Definition: ITkStripCablingTool.cxx:51
ITkStripCablingTool::m_data
SG::ReadCondHandleKey< ITkStripCablingData > m_data
Definition: ITkStripCablingTool.h:68
SG::ReadCondHandleKey< ITkStripCablingData >
CaloCondBlobAlgs_fillNoiseFromASCII.hash
dictionary hash
Definition: CaloCondBlobAlgs_fillNoiseFromASCII.py:108
SCT_ID
Definition: SCT_ID.h:68
ITkStripOnlineId
Definition: ITkStripOnlineId.h:16
ITkStripCablingTool::getData
const ITkStripCablingData * getData(const EventContext &ctx) const
Definition: ITkStripCablingTool.cxx:102
ITkStripCablingTool::getRobIdFromHash
virtual std::uint32_t getRobIdFromHash(const IdentifierHash &hash, const EventContext &ctx) const override
return the rob/rod Id, given a hash (used by simulation encoders)
Definition: ITkStripCablingTool.cxx:68
ITkStripCablingTool::getAllRods
virtual void getAllRods(std::vector< std::uint32_t > &usersVector, const EventContext &ctx) const override
fill a users vector with all the RodIds
Definition: ITkStripCablingTool.cxx:79
IdentifierHash
This is a "hash" representation of an Identifier. This encodes a 32 bit index which can be used to lo...
Definition: IdentifierHash.h:25
Identifier
Definition: IdentifierFieldParser.cxx:14