ATLAS Offline Software
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
Muon::STGC_RawDataProviderToolMT Class Reference

#include <STGC_RawDataProviderToolMT.h>

Inheritance diagram for Muon::STGC_RawDataProviderToolMT:
Collaboration diagram for Muon::STGC_RawDataProviderToolMT:

Public Types

typedef std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > ROBFragmentList
 Decoding method. More...
 

Public Member Functions

 STGC_RawDataProviderToolMT (const std::string &t, const std::string &n, const IInterface *p)
 Default constructor. More...
 
virtual ~STGC_RawDataProviderToolMT ()=default
 Default destructor. More...
 
virtual StatusCode initialize () override
 Standard AlgTool method. More...
 
virtual StatusCode convert () const override
 the new ones More...
 
virtual StatusCode convert (const ROBFragmentList &) const override
 
virtual StatusCode convert (const std::vector< IdentifierHash > &rdoIdhVect) const override
 for a selection of rdo collections More...
 
virtual StatusCode convert (const ROBFragmentList &, const std::vector< IdentifierHash > &) const override
 
virtual StatusCode convert (const EventContext &) const override
 Event Context functions. More...
 
virtual StatusCode convert (const std::vector< IdentifierHash > &, const EventContext &) const override
 
virtual StatusCode convert (const std::vector< uint32_t > &, const EventContext &) const override
 
virtual StatusCode convert (const ROBFragmentList &) const=0
 
virtual StatusCode convert (const ROBFragmentList &, const std::vector< IdentifierHash > &) const=0
 
virtual StatusCode convert () const=0
 the new ones More...
 
virtual StatusCode convert (const std::vector< IdentifierHash > &) const=0
 for a selection of rdo collections More...
 
virtual StatusCode convert (const std::vector< uint32_t > &) const
 
virtual StatusCode convert (const EventContext &) const
 Event Context functions. More...
 
virtual StatusCode convert (const ROBFragmentList &, const EventContext &) const
 
virtual StatusCode convert (const ROBFragmentList &, const std::vector< IdentifierHash > &, const EventContext &) const
 
virtual StatusCode convert (const std::vector< IdentifierHash > &, const EventContext &) const
 
virtual StatusCode convert (const std::vector< uint32_t > &, const EventContext &) const
 
 DeclareInterfaceID (IMuonRawDataProviderTool, 1, 0)
 
virtual StatusCode convert (const std::vector< uint32_t > &) const
 
virtual StatusCode convert (const ROBFragmentList &, const EventContext &) const
 
virtual StatusCode convert (const ROBFragmentList &, const std::vector< IdentifierHash > &, const EventContext &) const
 
virtual StatusCode convertIntoContainer (const EventContext &ctx, const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &, const std::vector< IdentifierHash > &, STGC_RawDataContainer &) const
 Method that converts the ROBFragments into the passed container. More...
 
ServiceHandle< StoreGateSvc > & evtStore ()
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
 
const ServiceHandle< StoreGateSvc > & evtStore () const
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
 
const ServiceHandle< StoreGateSvc > & detStore () const
 The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
 
virtual StatusCode sysInitialize () override
 Perform system initialization for an algorithm. More...
 
virtual StatusCode sysStart () override
 Handle START transition. More...
 
virtual std::vector< Gaudi::DataHandle * > inputHandles () const override
 Return this algorithm's input handles. More...
 
virtual std::vector< Gaudi::DataHandle * > outputHandles () const override
 Return this algorithm's output handles. More...
 
Gaudi::Details::PropertyBase & declareProperty (Gaudi::Property< T > &t)
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, T &property, const std::string &doc="none")
 Declare a new Gaudi property. More...
 
void updateVHKA (Gaudi::Details::PropertyBase &)
 
MsgStream & msg () const
 
MsgStream & msg (const MSG::Level lvl) const
 
bool msgLvl (const MSG::Level lvl) const
 

Protected Member Functions

StatusCode initRdoContainer (const EventContext &, STGC_RawDataContainer *&) const
 
void renounceArray (SG::VarHandleKeyArray &handlesArray)
 remove all handles from I/O resolution More...
 
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > renounce (T &h)
 
void extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
 Add StoreName to extra input/output deps as needed. More...
 

Protected Attributes

std::vector< uint32_t > m_allRobIds
 
SG::UpdateHandleKey< STGC_RawDataCollection_Cachem_rdoContainerCacheKey
 
ServiceHandle< Muon::IMuonIdHelperSvcm_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
 The ID helper. More...
 
ToolHandle< ISTGC_ROD_Decoderm_decoder {this, "Decoder", "Muon::STGC_ROD_Decoder/STGC_ROD_Decoder"}
 Decoder for ROB fragment RDO conversion. More...
 
SG::WriteHandleKey< STGC_RawDataContainerm_rdoContainerKey { this, "RdoLocation", "sTGCRDO", "Name of the sTGCRDO produced by RawDataProvider"}
 RDO container key. More...
 
unsigned int m_maxhashtoUse {0}
 
ServiceHandle< IROBDataProviderSvcm_robDataProvider
 Rob Data Provider handle. More...
 
Gaudi::Property< bool > m_skipDecoding {this, "SkipDecoding", false, "Skip the decoding but still write the container"}
 Flag to skip decoding and write empty container. More...
 

Private Types

typedef ServiceHandle< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
 specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
 specialization for handling Gaudi::Property<SG::VarHandleBase> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
 specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...
 

Private Attributes

StoreGateSvc_t m_evtStore
 Pointer to StoreGate (event store by default) More...
 
StoreGateSvc_t m_detStore
 Pointer to StoreGate (detector store by default) More...
 
std::vector< SG::VarHandleKeyArray * > m_vhka
 
bool m_varHandleArraysDeclared
 

Detailed Description

A tool to decode STGC ROB fragments into STGC RDO (based on the TGC tool).

Author
Stelios Angelidakis sange.nosp@m.lid@.nosp@m.cern..nosp@m.ch

Definition at line 19 of file STGC_RawDataProviderToolMT.h.

Member Typedef Documentation

◆ ROBFragmentList

Decoding method.

  • current methods: let's keep them!

Definition at line 27 of file IMuonRawDataProviderTool.h.

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t
privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ STGC_RawDataProviderToolMT()

Muon::STGC_RawDataProviderToolMT::STGC_RawDataProviderToolMT ( const std::string &  t,
const std::string &  n,
const IInterface *  p 
)

Default constructor.

Definition at line 15 of file STGC_RawDataProviderToolMT.cxx.

17 {
18  declareInterface<IMuonRawDataProviderTool>(this);
19 }

◆ ~STGC_RawDataProviderToolMT()

virtual Muon::STGC_RawDataProviderToolMT::~STGC_RawDataProviderToolMT ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ convert() [1/20]

StatusCode Muon::STGC_RawDataProviderToolMT::convert ( ) const
overridevirtual

the new ones

for the entire event

Implements Muon::IMuonRawDataProviderTool.

Definition at line 139 of file STGC_RawDataProviderToolMT.cxx.

140 {
141  ATH_MSG_ERROR("STGC_RawDataProviderToolMT::convert() Not implemented.");
142  return StatusCode::FAILURE;
143 }

◆ convert() [2/20]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert

the new ones

for the entire event

◆ convert() [3/20]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert
inline

Event Context functions.

Definition at line 35 of file IMuonRawDataProviderTool.h.

35 {return StatusCode::FAILURE;}

◆ convert() [4/20]

StatusCode Muon::STGC_RawDataProviderToolMT::convert ( const EventContext &  ) const
overridevirtual

Event Context functions.

Reimplemented from Muon::IMuonRawDataProviderTool.

Definition at line 103 of file STGC_RawDataProviderToolMT.cxx.

104 {
105  // method for unseeded mode. just decode everything.
106 
107  STGC_RawDataContainer* rdoContainer{nullptr};
108  ATH_CHECK(initRdoContainer(ctx, rdoContainer));
109  if(m_skipDecoding) return StatusCode::SUCCESS;
110 
111  std::vector<const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment*> vecRobf;
112  m_robDataProvider->getROBData(ctx, m_allRobIds, vecRobf);
113 
114  // dummy hashID vector for the decoder (empty = unseeded mode)
115  const std::vector<IdentifierHash> rdoIdhVect;
116 
117  return convertIntoContainer(ctx, vecRobf, rdoIdhVect, *rdoContainer);
118 }

◆ convert() [5/20]

StatusCode Muon::STGC_RawDataProviderToolMT::convert ( const ROBFragmentList ) const
overridevirtual

Implements Muon::IMuonRawDataProviderTool.

Definition at line 145 of file STGC_RawDataProviderToolMT.cxx.

146 {
147  ATH_MSG_ERROR("STGC_RawDataProviderToolMT::convert(const ROBFragmentList& vecRobs) Not implemented.");
148  return StatusCode::FAILURE;
149 }

◆ convert() [6/20]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert

◆ convert() [7/20]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert
inline

Definition at line 36 of file IMuonRawDataProviderTool.h.

36 {return StatusCode::FAILURE;}

◆ convert() [8/20]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert ( const ROBFragmentList ,
const EventContext &   
) const
inlinevirtualinherited

Reimplemented in Muon::NSWMMTP_RawDataProviderToolMT, Muon::NSWTP_RawDataProviderToolMT, and Muon::PadTrig_RawDataProviderToolMT.

Definition at line 36 of file IMuonRawDataProviderTool.h.

36 {return StatusCode::FAILURE;}

◆ convert() [9/20]

StatusCode Muon::STGC_RawDataProviderToolMT::convert ( const ROBFragmentList ,
const std::vector< IdentifierHash > &   
) const
overridevirtual

Implements Muon::IMuonRawDataProviderTool.

Definition at line 157 of file STGC_RawDataProviderToolMT.cxx.

158 {
159  ATH_MSG_ERROR("STGC_RawDataProviderToolMT::convert(const ROBFragmentList& vecRobs, const std::vector<IdentifierHash>&) Not implemented.");
160  return StatusCode::FAILURE;
161 }

◆ convert() [10/20]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert

◆ convert() [11/20]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert
inline

Definition at line 37 of file IMuonRawDataProviderTool.h.

37 {return StatusCode::FAILURE;}

◆ convert() [12/20]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert ( const ROBFragmentList ,
const std::vector< IdentifierHash > &  ,
const EventContext &   
) const
inlinevirtualinherited

Definition at line 37 of file IMuonRawDataProviderTool.h.

37 {return StatusCode::FAILURE;}

◆ convert() [13/20]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert

for a selection of rdo collections

◆ convert() [14/20]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert
inline

Definition at line 38 of file IMuonRawDataProviderTool.h.

38 {return StatusCode::FAILURE;}

◆ convert() [15/20]

StatusCode Muon::STGC_RawDataProviderToolMT::convert ( const std::vector< IdentifierHash > &  rdoIdhVect,
const EventContext &  ctx 
) const
overridevirtual

Reimplemented from Muon::IMuonRawDataProviderTool.

Definition at line 85 of file STGC_RawDataProviderToolMT.cxx.

86 {
87  // method for RoI-seeded mode. we don't let empty hash containers reach the decoder,
88  // since an empty container means unseeded mode (decode everything).
89 
90  STGC_RawDataContainer* rdoContainer{nullptr};
91  ATH_CHECK(initRdoContainer(ctx, rdoContainer));
92 
93  if (rdoIdhVect.empty() || m_skipDecoding) return StatusCode::SUCCESS;
94 
95  std::vector<const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment*> vecRobf;
96  m_robDataProvider->getROBData(ctx, m_allRobIds, vecRobf);
97 
98  return convertIntoContainer(ctx, vecRobf, rdoIdhVect, *rdoContainer);
99 }

◆ convert() [16/20]

StatusCode Muon::STGC_RawDataProviderToolMT::convert ( const std::vector< IdentifierHash > &  ) const
overridevirtual

for a selection of rdo collections

Implements Muon::IMuonRawDataProviderTool.

Definition at line 151 of file STGC_RawDataProviderToolMT.cxx.

152 {
153  ATH_MSG_ERROR("STGC_RawDataProviderToolMT::convert(const std::vector<IdentifierHash>& rdoIdhVect) Not implemented.");
154  return StatusCode::FAILURE;
155 }

◆ convert() [17/20]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert
inline

Definition at line 33 of file IMuonRawDataProviderTool.h.

33 {return StatusCode::FAILURE;}

◆ convert() [18/20]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert ( const std::vector< uint32_t > &  ) const
inlinevirtualinherited

Definition at line 33 of file IMuonRawDataProviderTool.h.

33 {return StatusCode::FAILURE;}

◆ convert() [19/20]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert
inline

Definition at line 39 of file IMuonRawDataProviderTool.h.

39 {return StatusCode::FAILURE;}

◆ convert() [20/20]

StatusCode Muon::STGC_RawDataProviderToolMT::convert ( const std::vector< uint32_t > &  robIds,
const EventContext &  ctx 
) const
overridevirtual

Reimplemented from Muon::IMuonRawDataProviderTool.

Definition at line 120 of file STGC_RawDataProviderToolMT.cxx.

121 {
122  STGC_RawDataContainer* rdoContainer{nullptr};
123  ATH_CHECK(initRdoContainer(ctx, rdoContainer));
124 
125  if (robIds.empty() || m_skipDecoding) return StatusCode::SUCCESS;
126 
127  std::vector<const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment*> vecRobf;
128 
129  m_robDataProvider->getROBData(ctx, robIds, vecRobf);
130 
131  // pass empty list of ID hashes, every ROB ID in list will be decoded
132  const std::vector<IdentifierHash> hashIDList;
133 
134  return convertIntoContainer(ctx, vecRobf, hashIDList, *rdoContainer);
135 
136 }

◆ convertIntoContainer()

StatusCode Muon::STGC_RawDataProviderToolCore::convertIntoContainer ( const EventContext &  ctx,
const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &  ,
const std::vector< IdentifierHash > &  ,
STGC_RawDataContainer  
) const
virtualinherited

Method that converts the ROBFragments into the passed container.

Definition at line 28 of file STGC_RawDataProviderToolCore.cxx.

32 {
33  // Since there can be multiple ROBFragments contributing to the same RDO collection a temporary cache is setup and passed to fillCollection by reference. Once all ROBFragments are processed the collections are added into the rdo container
34  std::unordered_map<IdentifierHash, std::unique_ptr<STGC_RawDataCollection>> rdo_map;
35 
36 
37  // Loop on the passed ROB fragments, and call the decoder for each one to fill the RDO container.
38  for (const ROBFragment* fragment : vecRobs)
39  ATH_CHECK( m_decoder->fillCollection(ctx, *fragment, rdoIdhVect, rdo_map) ); // always returns StatusCode::SUCCESS
40 
41 
42  // error counters
43  int nerr_duplicate{0}, nerr_rdo{0};
44 
45  // add the RDO collections created from the data of this ROB into the identifiable container.
46  for (auto& [hash, collection]: rdo_map) {
47 
48  if ((!collection) or collection->empty()) continue; // skip empty collections
49 
50  STGC_RawDataContainer::IDC_WriteHandle lock = stgcRdoContainer.getWriteHandle(hash);
51 
52  if (lock.alreadyPresent()) {
53  ++nerr_duplicate;
54  } else if (!lock.addOrDelete(std::move(collection)).isSuccess()) {
55  // since we prevent duplicates above, this error should never happen.
56  ++nerr_rdo;
57  }
58  }
59 
60 
61  // error summary (to reduce the number of messages)
62  if (nerr_duplicate) ATH_MSG_WARNING(nerr_duplicate << " elinks skipped since the same module hash has been added by a previous ROB fragment");
63  if (nerr_rdo) {
64  ATH_MSG_ERROR("Failed to add "<<nerr_rdo<<" RDOs into the identifiable container");
65  return StatusCode::FAILURE;
66  }
67 
68  ATH_MSG_DEBUG("Size of sTgcRdoContainer is " << stgcRdoContainer.size());
69  return StatusCode::SUCCESS;
70 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyArrayType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

172  {
173  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
174  hndl.value(),
175  hndl.documentation());
176 
177  }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

158  {
159  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160  hndl.value(),
161  hndl.documentation());
162 
163  }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

186  {
187  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
188  hndl.value(),
189  hndl.documentation());
190  }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t,
const SG::NotHandleType  
)
inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

200  {
201  return PBASE::declareProperty(t);
202  }

◆ DeclareInterfaceID()

Muon::IMuonRawDataProviderTool::DeclareInterfaceID ( IMuonRawDataProviderTool  ,
,
 
)
inherited

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleBase hndl,
const std::string &  doc,
const SG::VarHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

249  {
250  this->declare(hndl.vhKey());
251  hndl.vhKey().setOwner(this);
252 
253  return PBASE::declareProperty(name,hndl,doc);
254  }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleKey hndl,
const std::string &  doc,
const SG::VarHandleKeyType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

225  {
226  this->declare(hndl);
227  hndl.setOwner(this);
228 
229  return PBASE::declareProperty(name,hndl,doc);
230  }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleKeyArray hndArr,
const std::string &  doc,
const SG::VarHandleKeyArrayType  
)
inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

263  {
264 
265  // std::ostringstream ost;
266  // ost << Algorithm::name() << " VHKA declareProp: " << name
267  // << " size: " << hndArr.keys().size()
268  // << " mode: " << hndArr.mode()
269  // << " vhka size: " << m_vhka.size()
270  // << "\n";
271  // debug() << ost.str() << endmsg;
272 
273  hndArr.setOwner(this);
274  m_vhka.push_back(&hndArr);
275 
276  Gaudi::Details::PropertyBase* p = PBASE::declareProperty(name, hndArr, doc);
277  if (p != 0) {
278  p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
279  } else {
280  ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray "
281  << name);
282  }
283 
284  return p;
285 
286  }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc,
const SG::NotHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

337  {
338  return PBASE::declareProperty(name, property, doc);
339  }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc = "none" 
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

355  {
356  typedef typename SG::HandleClassifier<T>::type htype;
357  return declareProperty (name, property, doc, htype());
358  }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  t)
inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

145  {
146  typedef typename SG::HandleClassifier<T>::type htype;
148  }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const
inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )
inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const
inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase &  ExtraDeps)
protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ initialize()

StatusCode Muon::STGC_RawDataProviderToolMT::initialize ( )
overridevirtual

Standard AlgTool method.

Reimplemented from Muon::STGC_RawDataProviderToolCore.

Definition at line 23 of file STGC_RawDataProviderToolMT.cxx.

24 {
25  // generate all the Source Identifiers to request the fragments.
26  // assume 16 RODs per side (one per sector) and that ROB ID = ROD ID.
27  for (uint32_t detID : {eformat::MUON_STGC_ENDCAP_A_SIDE, eformat::MUON_STGC_ENDCAP_C_SIDE}) { //0x6D, 0x6E
28  for (uint8_t sectorID(0); sectorID < 16; ++sectorID) {
29  // for now lets build all the possible ROB ids of all possible readout configurations
30  // maybe later we can come up with a smart way to detect which readout sheme is running and only request the relevant ROB ids from the ROBDataProviderSvc
31  // reference: slide 6 of https://indico.cern.ch/event/1260377/contributions/5294286/attachments/2603399/4495810/NSW-SwRod-Felix-v3.pdf
32 
33  uint16_t moduleID = (0x0 << 8) | sectorID; // combined/single ROB
34  SourceIdentifier sid(static_cast<eformat::SubDetector>(detID), moduleID);
35  m_allRobIds.push_back(sid.simple_code());
36 
37  moduleID = (0x1 << 8) | sectorID; // full device ROB (split configuration)
38  sid = SourceIdentifier(static_cast<eformat::SubDetector>(detID), moduleID);
39  m_allRobIds.push_back(sid.simple_code());
40 
41  moduleID = (0x2 << 8) | sectorID; // shared device ROB (split configuration)
42  sid = SourceIdentifier(static_cast<eformat::SubDetector>(detID), moduleID);
43  m_allRobIds.push_back(sid.simple_code());
44 
45  moduleID = (0x3 << 8) | sectorID; // spare device ROB (split configuration)
46  sid = SourceIdentifier(static_cast<eformat::SubDetector>(detID), moduleID);
47  m_allRobIds.push_back(sid.simple_code());
48  }
49  }
50 
51  ATH_CHECK(m_rdoContainerCacheKey.initialize(!m_rdoContainerCacheKey.key().empty()));
53  return StatusCode::SUCCESS;
54 }

◆ initRdoContainer()

StatusCode Muon::STGC_RawDataProviderToolMT::initRdoContainer ( const EventContext &  ctx,
STGC_RawDataContainer *&  rdoContainer 
) const
protected

Definition at line 58 of file STGC_RawDataProviderToolMT.cxx.

59 {
60  // Create the identifiable RdoContainer in StoreGate to be filled with decoded fragment contents.
62 
63  const bool externalCacheRDO = !m_rdoContainerCacheKey.key().empty();
64  if(!externalCacheRDO){
65  ATH_CHECK(rdoContainerHandle.record(std::make_unique<STGC_RawDataContainer>(m_maxhashtoUse)));
66  ATH_MSG_DEBUG("Created STGC RDO container");
67  } else {
69  ATH_CHECK(update.isValid());
70  ATH_CHECK(rdoContainerHandle.record(std::make_unique<STGC_RawDataContainer>(update.ptr())));
71  ATH_MSG_DEBUG("Created STGC RDO container using cache for " << m_rdoContainerCacheKey.key());
72  }
73 
74  // this should never happen, but since we dereference the pointer, we should check
75  if (!(rdoContainer = rdoContainerHandle.ptr())) {
76  ATH_MSG_ERROR("The STGC RDO container is null, cannot decode STGC data");
77  return StatusCode::FAILURE;
78  }
79 
80  return StatusCode::SUCCESS;
81 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const
overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

24  {
25  return this->msgStream();
26  }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl) const
inlineinherited

Definition at line 27 of file AthCommonMsg.h.

27  {
28  return this->msgStream(lvl);
29  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level  lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30  {
31  return this->msgLevel(lvl);
32  }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const
overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T &  h)
inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

381  {
382  h.renounce();
383  PBASE::renounce (h);
384  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364  {
365  handlesArray.renounce();
366  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )
overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )
overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase &  )
inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

308  {
309  // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310  // << " size: " << m_vhka.size() << endmsg;
311  for (auto &a : m_vhka) {
312  std::vector<SG::VarHandleKey*> keys = a->keys();
313  for (auto k : keys) {
314  k->setOwner(this);
315  }
316  }
317  }

Member Data Documentation

◆ m_allRobIds

std::vector<uint32_t> Muon::STGC_RawDataProviderToolMT::m_allRobIds
protected

Definition at line 48 of file STGC_RawDataProviderToolMT.h.

◆ m_decoder

ToolHandle<ISTGC_ROD_Decoder> Muon::STGC_RawDataProviderToolCore::m_decoder {this, "Decoder", "Muon::STGC_ROD_Decoder/STGC_ROD_Decoder"}
protectedinherited

Decoder for ROB fragment RDO conversion.

Definition at line 47 of file STGC_RawDataProviderToolCore.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> Muon::STGC_RawDataProviderToolCore::m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
protectedinherited

The ID helper.

Definition at line 44 of file STGC_RawDataProviderToolCore.h.

◆ m_maxhashtoUse

unsigned int Muon::STGC_RawDataProviderToolCore::m_maxhashtoUse {0}
protectedinherited

Definition at line 52 of file STGC_RawDataProviderToolCore.h.

◆ m_rdoContainerCacheKey

SG::UpdateHandleKey<STGC_RawDataCollection_Cache> Muon::STGC_RawDataProviderToolMT::m_rdoContainerCacheKey
protected
Initial value:
{this, "sTgcContainerCacheKey", "" ,
"Optional external cache for the sTGC container"}

Definition at line 50 of file STGC_RawDataProviderToolMT.h.

◆ m_rdoContainerKey

SG::WriteHandleKey<STGC_RawDataContainer> Muon::STGC_RawDataProviderToolCore::m_rdoContainerKey { this, "RdoLocation", "sTGCRDO", "Name of the sTGCRDO produced by RawDataProvider"}
protectedinherited

RDO container key.

Definition at line 50 of file STGC_RawDataProviderToolCore.h.

◆ m_robDataProvider

ServiceHandle<IROBDataProviderSvc> Muon::STGC_RawDataProviderToolCore::m_robDataProvider
protectedinherited

Rob Data Provider handle.

Definition at line 55 of file STGC_RawDataProviderToolCore.h.

◆ m_skipDecoding

Gaudi::Property<bool> Muon::STGC_RawDataProviderToolCore::m_skipDecoding {this, "SkipDecoding", false, "Skip the decoding but still write the container"}
protectedinherited

Flag to skip decoding and write empty container.

Definition at line 58 of file STGC_RawDataProviderToolCore.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
privateinherited

Definition at line 398 of file AthCommonDataStore.h.


The documentation for this class was generated from the following files:
Muon::STGC_RawDataProviderToolMT::m_rdoContainerCacheKey
SG::UpdateHandleKey< STGC_RawDataCollection_Cache > m_rdoContainerCacheKey
Definition: STGC_RawDataProviderToolMT.h:50
IdentifiableContainerMT::IDC_WriteHandle
friend class IDC_WriteHandle
Definition: IdentifiableContainerMT.h:140
xAOD::uint8_t
uint8_t
Definition: Muon_v1.cxx:557
Muon::STGC_RawDataProviderToolCore::m_decoder
ToolHandle< ISTGC_ROD_Decoder > m_decoder
Decoder for ROB fragment RDO conversion.
Definition: STGC_RawDataProviderToolCore.h:47
xAOD::uint32_t
setEventNumber uint32_t
Definition: EventInfo_v1.cxx:127
AthCommonDataStore::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
Muon::STGC_RawDataProviderToolCore::convertIntoContainer
virtual StatusCode convertIntoContainer(const EventContext &ctx, const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &, const std::vector< IdentifierHash > &, STGC_RawDataContainer &) const
Method that converts the ROBFragments into the passed container.
Definition: STGC_RawDataProviderToolCore.cxx:28
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
Muon::STGC_RawDataProviderToolCore::m_skipDecoding
Gaudi::Property< bool > m_skipDecoding
Flag to skip decoding and write empty container.
Definition: STGC_RawDataProviderToolCore.h:58
Muon::STGC_RawDataProviderToolCore::m_maxhashtoUse
unsigned int m_maxhashtoUse
Definition: STGC_RawDataProviderToolCore.h:52
Muon::STGC_RawDataProviderToolMT::m_allRobIds
std::vector< uint32_t > m_allRobIds
Definition: STGC_RawDataProviderToolMT.h:48
Muon::STGC_RawDataProviderToolMT::initRdoContainer
StatusCode initRdoContainer(const EventContext &, STGC_RawDataContainer *&) const
Definition: STGC_RawDataProviderToolMT.cxx:58
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
IDTPMcnv.htype
htype
Definition: IDTPMcnv.py:29
python.utils.AtlRunQueryDQUtils.p
p
Definition: AtlRunQueryDQUtils.py:210
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
xAOD::uint16_t
setWord1 uint16_t
Definition: eFexEMRoI_v1.cxx:93
eformat::ROBFragment
Definition: L1CaloBsDecoderUtil.h:12
beamspotman.n
n
Definition: beamspotman.py:731
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
SG::VarHandleKeyArray::renounce
virtual void renounce()=0
SG::HandleClassifier::type
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Definition: HandleClassifier.h:54
Muon::STGC_RawDataProviderToolCore::STGC_RawDataProviderToolCore
STGC_RawDataProviderToolCore(const std::string &t, const std::string &n, const IInterface *p)
Default constructor.
Definition: STGC_RawDataProviderToolCore.cxx:10
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:228
SG::UpdateHandle
Definition: UpdateHandle.h:94
Muon::STGC_RawDataProviderToolCore::initialize
virtual StatusCode initialize() override
Standard AlgTool method.
Definition: STGC_RawDataProviderToolCore.cxx:16
SG::WriteHandle
Definition: StoreGate/StoreGate/WriteHandle.h:76
a
TList * a
Definition: liststreamerinfos.cxx:10
h
CaloCondBlobAlgs_fillNoiseFromASCII.hash
dictionary hash
Definition: CaloCondBlobAlgs_fillNoiseFromASCII.py:109
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
Muon::STGC_RawDataProviderToolCore::m_robDataProvider
ServiceHandle< IROBDataProviderSvc > m_robDataProvider
Rob Data Provider handle.
Definition: STGC_RawDataProviderToolCore.h:55
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:623
Muon::STGC_RawDataProviderToolCore::m_rdoContainerKey
SG::WriteHandleKey< STGC_RawDataContainer > m_rdoContainerKey
RDO container key.
Definition: STGC_RawDataProviderToolCore.h:50
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:798
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
WriteBchToCool.update
update
Definition: WriteBchToCool.py:67
fitman.k
k
Definition: fitman.py:528