ATLAS Offline Software
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
SG::ThinningHandleKey< T > Class Template Reference

HandleKey object for adding thinning to an object. More...

#include <ThinningHandleKey.h>

Inheritance diagram for SG::ThinningHandleKey< T >:
Collaboration diagram for SG::ThinningHandleKey< T >:

Public Types

typedef ReadHandleKey< T > Base
 
using PropertyType = SG::VarHandleKeyProperty
 Declare corresponding property type. More...
 

Public Member Functions

 ThinningHandleKey (const std::string &key="", const std::string &storeName=StoreID::storeName(StoreID::EVENT_STORE))
 Constructor. More...
 
 ThinningHandleKey (const ThinningHandleKey &)=default
 
template<class OWNER , typename = typename std::enable_if<std::is_base_of<IProperty, OWNER>::value>::type>
 ThinningHandleKey (OWNER *owner, const std::string &name, const std::string &key, const std::string &doc)
 Auto-declaring Property constructor. More...
 
ThinningHandleKeyoperator= (const ThinningHandleKey &other)
 Assignment. More...
 
ThinningHandleKeyoperator= (const std::string &sgkey)
 Change the key of the object to which we're referring. More...
 
StatusCode initialize (const std::string &stream, const std::string &qualifier, bool used=true)
 Should be called during the initialize phase. More...
 
StatusCode initialize (const std::string &stream, const char *qualifier, bool used=true)
 Should be called during the initialize phase. More...
 
StatusCode initialize (const std::string &stream, bool used=true)
 Should be called during the initialize phase. More...
 
const WriteHandleKey< ThinningDecision > & decisionHandleKey () const
 Return the write key for the thinning decision. More...
 
virtual StatusCode assign (const std::string &sgkey)
 Change the key of the object to which we're referring. More...
 
StatusCode initialize (bool used=true)
 If this object is used as a property, then this should be called during the initialize phase. More...
 
StatusCode initialize (AllowEmptyEnum)
 If this object is used as a property, then this should be called during the initialize phase. More...
 
CLID clid () const
 Return the class ID for the referenced object. More...
 
const std::string & key () const
 Return the StoreGate ID for the referenced object. More...
 
bool empty () const
 Test if the key is blank. More...
 
const ServiceHandle< IProxyDict > & storeHandle () const
 Return handle to the referenced store. More...
 
VarHandleBaseowningHandle ()
 Return the VarHandle that owns this key, if any. More...
 
bool isEventStore () const
 Does this key reference the primary event store? More...
 
virtual StatusCode start ()
 Called by the owning algorithm during the START transition. More...
 
SG::sgkey_t hashedKey () const
 Return the hashed StoreGate key. More...
 

Protected Member Functions

virtual std::string pythonRepr () const override
 Python representation of Handle. More...
 

Private Member Functions

void setOwningHandle (VarHandleBase *handle)
 
virtual void setKey (DataObjID key) override final
 Don't allow calling these. More...
 
virtual void updateKey (std::string key) override final
 Prevent this method from being called. More...
 
void parseKey (const std::string &sgkey, const std::string &storeName)
 Handle assignment/construction from a string key. More...
 
void updateHandle (const std::string &name)
 Update the name of the store to which we're referring. More...
 

Private Attributes

WriteHandleKey< ThinningDecisionm_decisionKey
 Thinning decision write key. More...
 
ServiceHandle< IProxyDictm_storeHandle
 Handle to the referenced store. More...
 
std::string m_sgKey
 StoreGate key, that doesn't include the storename. More...
 
SG::sgkey_t m_hashedKey = 0
 The hashed StoreGate key. May be 0 if not yet initialized. More...
 
bool m_isEventStore = false
 Cache test for whether we're referencing the event store. More...
 
VarHandleBasem_owningHandle = nullptr
 Handle that owns this key, or nullptr if it is not owned. More...
 

Detailed Description

template<class T>
class SG::ThinningHandleKey< T >

HandleKey object for adding thinning to an object.

This key object goes with ThinningHandle to allow adding thinning for an object. See ThinningHandle for more details.

Using this key will make a read dependency on the object of type T given by the requested key, and a write dependency on the corresponding ThinningDecision object.

Definition at line 36 of file ThinningHandleKey.h.

Member Typedef Documentation

◆ Base

template<class T >
typedef ReadHandleKey<T> SG::ThinningHandleKey< T >::Base

Definition at line 40 of file ThinningHandleKey.h.

◆ PropertyType

Declare corresponding property type.

Definition at line 91 of file StoreGate/StoreGate/VarHandleKey.h.

Constructor & Destructor Documentation

◆ ThinningHandleKey() [1/3]

template<class T >
SG::ThinningHandleKey< T >::ThinningHandleKey ( const std::string &  key = "",
const std::string &  storeName = StoreID::storeName(StoreID::EVENT_STORE) 
)

Constructor.

Parameters
keyThe StoreGate key for the object.
storeNameName to use for the store, if it's not encoded in sgkey.

The provided key may actually start with the name of the store, separated by a "+": "MyStore+Obj". If no "+" is present the store named by storeName is used.

◆ ThinningHandleKey() [2/3]

template<class T >
SG::ThinningHandleKey< T >::ThinningHandleKey ( const ThinningHandleKey< T > &  )
default

◆ ThinningHandleKey() [3/3]

template<class T >
template<class OWNER , typename = typename std::enable_if<std::is_base_of<IProperty, OWNER>::value>::type>
SG::ThinningHandleKey< T >::ThinningHandleKey ( OWNER *  owner,
const std::string &  name,
const std::string &  key,
const std::string &  doc 
)

Auto-declaring Property constructor.

Parameters
ownerOwning component.
nameName of the Property.
keyDefault StoreGate key for the object.
docDocumentation string.

Will associate the named Property with this key via declareProperty.

The provided key may actually start with the name of the store, separated by a "+": "MyStore+Obj". If no "+" is present the store named by storeName is used.

Member Function Documentation

◆ assign()

StatusCode SG::VarHandleKey::assign ( const std::string &  sgkey)
virtualinherited

Change the key of the object to which we're referring.

Parameters
sgkeyThe StoreGate key for the object.

The provided key may actually start with the name of the store, separated by a "+": "MyStore+Obj". If no "+" is present the store is not changed. A key name that starts with a slash is interpreted as a hierarchical key name, not an empty store name.

Returns failure the key string format is bad.

Reimplemented in SG::WriteDecorHandleKey< T >, SG::WriteDecorHandleKey< xAOD::ElectronContainer >, SG::WriteDecorHandleKey< DMTest::CVecWithData_v1 >, SG::WriteDecorHandleKey< DMTest::JVec_v1 >, SG::WriteDecorHandleKey< DataVector >, SG::WriteDecorHandleKey< xAOD::EventInfo >, SG::WriteDecorHandleKey< C >, SG::WriteDecorHandleKey< DMTest::PLinks_v1 >, SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >, SG::WriteDecorHandleKey< NEW >, SG::WriteDecorHandleKey< xAOD::EventInfo_v1 >, SG::WriteDecorHandleKey< CONTAINER >, SG::WriteDecorHandleKey< MyDataObj >, SG::WriteDecorHandleKey< T_RoIContainer >, SG::WriteDecorHandleKey< DMTest::C_v1 >, SG::WriteDecorHandleKey< container_t >, SG::WriteDecorHandleKey< SG::AuxElement >, SG::ReadDecorHandleKey< T >, SG::ReadDecorHandleKey< DMTest::JVec_v1 >, SG::ReadDecorHandleKey< DataVector >, SG::ReadDecorHandleKey< CONSTITUENTS >, SG::ReadDecorHandleKey< C >, SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >, SG::ReadDecorHandleKey< DMTest::PLinks_v1 >, SG::ReadDecorHandleKey< xAOD::EventInfo_v1 >, SG::ReadDecorHandleKey< xAOD::FlowElement_v1 >, SG::ReadDecorHandleKey< CONTAINER >, SG::ReadDecorHandleKey< JetContainer >, SG::ReadDecorHandleKey< xAOD::PFO_v1 >, SG::ReadDecorHandleKey< MyDataObj >, SG::ReadDecorHandleKey< T_RoIContainer >, SG::ReadDecorHandleKey< DMTest::C_v1 >, SG::ReadDecorHandleKey< T_Cont >, SG::ReadDecorHandleKey< SG::AuxElement >, SG::ReadDecorHandleKey< OLD >, and SG::TypelessWriteHandleKey.

Definition at line 88 of file AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx.

89 {
90  m_sgKey = sgkey;
91  return StatusCode::SUCCESS;
92 }

◆ clid()

CLID SG::VarHandleKey::clid ( ) const
inherited

Return the class ID for the referenced object.

Definition at line 177 of file StoreGate/src/VarHandleKey.cxx.

178 {
179  return Gaudi::DataHandle::fullKey().clid();
180 }

◆ decisionHandleKey()

template<class T >
const WriteHandleKey<ThinningDecision>& SG::ThinningHandleKey< T >::decisionHandleKey ( ) const

Return the write key for the thinning decision.

◆ empty()

bool SG::VarHandleKey::empty ( ) const
inherited

Test if the key is blank.

Definition at line 150 of file AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx.

151 {
152  return m_sgKey.empty();
153 }

◆ hashedKey()

SG::sgkey_t SG::VarHandleKey::hashedKey ( ) const
inherited

Return the hashed StoreGate key.

May be 0 if not yet initialized.

◆ initialize() [1/5]

StatusCode SG::VarHandleKey::initialize ( AllowEmptyEnum  )
inherited

If this object is used as a property, then this should be called during the initialize phase.

This variant will allow the key to be blank.

Parameters
Flagto select this variant. Call like
ATH_CHECK( key.initialize (SG::AllowEmpty) );

Definition at line 129 of file AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx.

130 {
131  if (key().empty()) {
132  return StatusCode::SUCCESS;
133  }
134  return initialize (true);
135 }

◆ initialize() [2/5]

StatusCode SG::VarHandleKey::initialize ( bool  used = true)
inherited

If this object is used as a property, then this should be called during the initialize phase.

It will fail if the requested StoreGate service cannot be found or if the key is blank.

Parameters
usedIf false, then this handle is not to be used. Instead of normal initialization, the key will be cleared.

Definition at line 103 of file AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx.

104 {
105  if (!used) {
106  m_sgKey = "";
107  return StatusCode::SUCCESS;
108  }
109 
110  if (key() == "") {
111  // REPORT_ERROR (StatusCode::FAILURE)
112  // << "Cannot initialize a Read/Write/Update handle with a null key.";
113  return StatusCode::FAILURE;
114  }
115 
116  return StatusCode::SUCCESS;
117 }

◆ initialize() [3/5]

template<class T >
StatusCode SG::ThinningHandleKey< T >::initialize ( const std::string &  stream,
bool  used = true 
)

Should be called during the initialize phase.

It will fail if the requested StoreGate service cannot be found or if the key is blank.

Parameters
streamThe name of the stream for which thinning is being applied.
usedIf false, then this handle is not to be used. Instead of normal initialization, the key will be cleared.

◆ initialize() [4/5]

template<class T >
StatusCode SG::ThinningHandleKey< T >::initialize ( const std::string &  stream,
const char *  qualifier,
bool  used = true 
)

Should be called during the initialize phase.

It will fail if the requested StoreGate service cannot be found or if the key is blank.

Parameters
streamThe name of the stream for which thinning is being applied.
qualifierQualifier to add on to the key for the decision object. If there are multiple algorithms thinning the same object, this can be used to keep them from interfering with each other. (The thinning decisions will be merged with AND at the end.)
usedIf false, then this handle is not to be used. Instead of normal initialization, the key will be cleared.

◆ initialize() [5/5]

template<class T >
StatusCode SG::ThinningHandleKey< T >::initialize ( const std::string &  stream,
const std::string &  qualifier,
bool  used = true 
)

Should be called during the initialize phase.

It will fail if the requested StoreGate service cannot be found or if the key is blank.

Parameters
streamThe name of the stream for which thinning is being applied.
qualifierQualifier to add on to the key for the decision object. If there are multiple algorithms thinning the same object, this can be used to keep them from interfering with each other. (The thinning decisions will be merged with AND at the end.)
usedIf false, then this handle is not to be used. Instead of normal initialization, the key will be cleared.

◆ isEventStore()

bool SG::VarHandleKey::isEventStore ( ) const
inherited

Does this key reference the primary event store?

◆ key()

const std::string & SG::VarHandleKey::key ( ) const
inherited

Return the StoreGate ID for the referenced object.

Definition at line 141 of file AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx.

142 {
143  return m_sgKey;
144 }

◆ operator=() [1/2]

template<class T >
ThinningHandleKey& SG::ThinningHandleKey< T >::operator= ( const std::string &  sgkey)

Change the key of the object to which we're referring.

Parameters
sgkeyThe StoreGate key for the object.

The provided key may actually start with the name of the store, separated by a "+": "MyStore+Obj". If no "+" is present, the store is not changed.

◆ operator=() [2/2]

template<class T >
ThinningHandleKey& SG::ThinningHandleKey< T >::operator= ( const ThinningHandleKey< T > &  other)

Assignment.

Parameters
otherKey to assign.

◆ owningHandle()

VarHandleBase* SG::VarHandleKey::owningHandle ( )
inherited

Return the VarHandle that owns this key, if any.

This should only be non-null for keys that are created automatically by a VarHandle when it is not created from a VarHandleKey. This should always be null for keys that are created explicitly.

◆ parseKey()

void SG::VarHandleKey::parseKey ( const std::string &  key,
const std::string &  storeName 
)
privateinherited

Handle assignment/construction from a string key.

Parameters
sgkeyThe StoreGate key for the referenced object.

The provided key may actually start with the name of the store, separated by a "+": "MyStore+Obj". If no "+" is present, the store named by storeName is used. A key name that starts with a slash is interpreted as a hierarchical key name, not an empty store name.

see implementation comments for further details

Parameters
sgkeyThe StoreGate key for the referenced object.

The provided key may actually start with the name of the store, separated by a "+": "MyStore+Obj". If no "+" is present the store named by storeName is used. A key name that starts with a slash is interpreted as a hierarchical key name, not an empty store name.

we also have to check that if the key contains the store name, it matches the store name that they Handle was constructed with

blank keys result in blank DataObjIDs

Definition at line 217 of file StoreGate/src/VarHandleKey.cxx.

219 {
220  m_hashedKey = 0;
221 
222  std::string sn;
223  // test if storeName has classname
224  std::string::size_type sp = storeName.find('/');
225  if (sp == std::string::npos) {
226  sn = storeName;
227  } else {
228  sn = storeName.substr(sp+1,storeName.length()-sp+1);
229  }
230 
231  if (key.empty()) {
232  this->updateHandle(sn);
233  Gaudi::DataHandle::updateKey("");
234  m_sgKey.clear();
235  return;
236  }
237 
238  // StoreName separator is "+"
239  sp = key.find(storeSeparator);
240  if(sp == std::string::npos) {
241  m_sgKey = key;
242  } else {
243  sn = key.substr(0,sp);
244  m_sgKey = key.substr(sp+1,key.length()-sp-1);
245  }
246 
247 
248  this->updateHandle(sn);
249 
250  StoreID::type st;
251  // would be nice if we could get the storeID from the storeHandle, but
252  // we can't be sure that the store has been created when the VHK is
253  // constructed.
254  //
255 
256  st = StoreID::findStoreID(sn);
257 
259  if (m_sgKey.find('/') != std::string::npos) {
260  throw SG::ExcBadHandleKey("key \"" + key
261  + "\": keys with \"/\" only allowed for "
263  + " - store is \""
264  + sn + "\"");
265  }
266  } else {
267  sp = m_sgKey.rfind('/');
268  if (sp != std::string::npos) {
269  if (sp == 0
270  && m_sgKey.size() == 1) {
271  // Replace '\' with blank key
272  m_sgKey.clear();
273  } else if ( sp == m_sgKey.length()-1) {
274  throw SG::ExcBadHandleKey("key \"" + key
275  + "\": must not end with a \"/\"");
276  }
277  }
278  }
279 
280  if (m_sgKey.empty()) {
281  Gaudi::DataHandle::updateKey("");
282  } else {
283  Gaudi::DataHandle::updateKey(sn + storeSeparator + m_sgKey);
284  }
285 
286 
287 }

◆ pythonRepr()

std::string SG::VarHandleKey::pythonRepr ( ) const
overrideprotectedvirtualinherited

Python representation of Handle.

Reimplemented in SG::WriteDecorHandleKey< T >, and SG::ReadDecorHandleKey< T >.

Definition at line 309 of file StoreGate/src/VarHandleKey.cxx.

310 {
311  const std::string& className = fullKey().className().empty() ?
312  Gaudi::DataHandle::default_type : fullKey().className();
313 
314  std::ostringstream ost;
315  ost << "DataHandle(";
317  ost << ",";
318  switch (mode()) {
320  Gaudi::Utils::toStream("W", ost); break;
321  default:
322  Gaudi::Utils::toStream("R", ost); break;
323  }
325  ost << ","; Gaudi::Utils::toStream(isCondition(), ost);
326  ost << ")";
327 
328  return ost.str();
329 }

◆ setKey()

void SG::VarHandleKey::setKey ( DataObjID  key)
finaloverrideprivatevirtualinherited

Don't allow calling these.

Prevent this method from being called.

Definition at line 186 of file StoreGate/src/VarHandleKey.cxx.

187 {
188  throw SG::ExcForbiddenMethod ("VarHandleKey::setKey");
189 }

◆ setOwningHandle()

void SG::VarHandleKey::setOwningHandle ( VarHandleBase handle)
privateinherited

◆ start()

virtual StatusCode SG::VarHandleKey::start ( )
virtualinherited

Called by the owning algorithm during the START transition.

AthAlgorithm and friends will call this during START. This allows for extra initialization that we can't do during initialize(), such as retrieving a conditions container from the store.

The default implementation is a no-op.

Reimplemented in SG::CondHandleKey< T >, SG::CondHandleKey< LArDSPThresholdsComplete >, SG::CondHandleKey< TRTCond::AliveStraws >, SG::CondHandleKey< DMTest::S3 >, SG::CondHandleKey< TileSampleNoise >, SG::CondHandleKey< CaloBCIDLumi >, SG::CondHandleKey< CaloTowerGeometry >, SG::CondHandleKey< ALineContainer >, SG::CondHandleKey< SCT_ConfigurationCondData >, SG::CondHandleKey< CondAttrListVec >, SG::CondHandleKey< InDet::SiliconPropertiesVector >, SG::CondHandleKey< TRTCond::StrawT0MultChanContainer >, SG::CondHandleKey< Analysis::JetTagCalibCondData >, SG::CondHandleKey< PixeldEdxData >, SG::CondHandleKey< PixelDCSHVData >, SG::CondHandleKey< ILArPedestal >, SG::CondHandleKey< LArHVPathology >, SG::CondHandleKey< L1CaloReadoutConfigContainer >, SG::CondHandleKey< L1CaloPprConditionsContainerRun2 >, SG::CondHandleKey< external_detector_element_collection_t >, SG::CondHandleKey< DMTest::S2 >, SG::CondHandleKey< NswDcsDbData >, SG::CondHandleKey< MuonCalib::MdtCalibDataContainer >, SG::CondHandleKey< CondDataObj >, SG::CondHandleKey< IdentifierSet >, SG::CondHandleKey< LArADC2MeV >, SG::CondHandleKey< JGTowerMappingData >, SG::CondHandleKey< BunchCrossingCondData >, SG::CondHandleKey< TGCTriggerData >, SG::CondHandleKey< TilePulse >, SG::CondHandleKey< TileCalibData< TileCalibDrawerOfc > >, SG::CondHandleKey< DMTest::S1 >, SG::CondHandleKey< CaloBCIDCoeffs >, SG::CondHandleKey< TileCalibData< T > >, SG::CondHandleKey< Trk::TrackingGeometry >, SG::CondHandleKey< SCT_ModuleVetoCondData >, SG::CondHandleKey< PixelDCSStatusData >, SG::CondHandleKey< PixelDistortionData >, SG::CondHandleKey< SiDetElementsLayerVectors_xk >, SG::CondHandleKey< ILArShape >, SG::CondHandleKey< CondAttrListCollection >, SG::CondHandleKey< Muon::TwinTubeMap >, SG::CondHandleKey< RtRelationContainer >, SG::CondHandleKey< PixelReadoutSpeedData >, SG::CondHandleKey< OnlineLumiCalibrationCondData >, SG::CondHandleKey< TileTiming >, SG::CondHandleKey< ActsTrk::DetectorElementToActsGeometryIdMap >, SG::CondHandleKey< SCT_MajorityCondData >, SG::CondHandleKey< MuonMDT_CablingMap >, SG::CondHandleKey< CondMultChanCollection >, SG::CondHandleKey< LArFebConfig >, SG::CondHandleKey< LArHVIdMapping >, SG::CondHandleKey< LArOnOffIdMapping >, SG::CondHandleKey< InDetDD::HGTD_DetectorElementCollection >, SG::CondHandleKey< InDet::SiElementPropertiesTable >, SG::CondHandleKey< ITk::PixelOfflineCalibData >, SG::CondHandleKey< ILArMinBias >, SG::CondHandleKey< StrawT0Container >, SG::CondHandleKey< TgcDigitCrosstalkData >, SG::CondHandleKey< LBDurationCondData >, SG::CondHandleKey< SCT_AllGoodStripInfo >, SG::CondHandleKey< PixelRadiationDamageFluenceMapData >, SG::CondHandleKey< TgcCondDbData >, SG::CondHandleKey< ILAruA2MeV >, SG::CondHandleKey< LArFebRodMapping >, SG::CondHandleKey< ILArNoise >, SG::CondHandleKey< Muon::MuonIntersectGeoData >, SG::CondHandleKey< L1CaloPprChanDefaultsContainer >, SG::CondHandleKey< L1CaloPprChanCalibContainer >, SG::CondHandleKey< MuonGM::MuonDetectorManager >, SG::CondHandleKey< TGCTriggerLUTs >, SG::CondHandleKey< Muon::RpcCablingMap >, SG::CondHandleKey< LArHVNMap >, SG::CondHandleKey< AtlasFieldMapCondObj >, SG::CondHandleKey< LArAutoCorrNoise >, SG::CondHandleKey< TileHid2RESrcID >, SG::CondHandleKey< DetCondKeyTrans >, SG::CondHandleKey< PixelDCSStateData >, SG::CondHandleKey< TileCalibData >, SG::CondHandleKey< ILArMinBiasAverage >, SG::CondHandleKey< TrigConf::L1BunchGroupSet >, SG::CondHandleKey< LArXTalkWeightGlobal >, SG::CondHandleKey< BunchCrossingIntensityCondData >, SG::CondHandleKey< ITkStripCablingData >, SG::CondHandleKey< TileBadChannels >, SG::CondHandleKey< CondDataObjZ >, SG::CondHandleKey< SCT_CondParameterData >, SG::CondHandleKey< Muon::DigitEffiData >, SG::CondHandleKey< SCT_CablingData >, SG::CondHandleKey< DetCondCFloat >, SG::CondHandleKey< PixelHitDiscCnfgData >, SG::CondHandleKey< InDetDD::TRT_DetElementContainer >, SG::CondHandleKey< ILArfSampl >, SG::CondHandleKey< ILArOFC >, SG::CondHandleKey< LArLATOMEMapping >, SG::CondHandleKey< T_DefectsData >, SG::CondHandleKey< LArOFCweightSC >, SG::CondHandleKey< NswErrorCalibData >, SG::CondHandleKey< SCT_DCSFloatCondData >, SG::CondHandleKey< LuminosityCondData >, SG::CondHandleKey< InDetDD::SiDetectorElementCollection >, SG::CondHandleKey< SYM_t >, SG::CondHandleKey< LArOFC >, SG::CondHandleKey< TgcDigitTimeOffsetData >, SG::CondHandleKey< TRTCond::ActiveFraction >, SG::CondHandleKey< TgcDigitJitterData >, SG::CondHandleKey< TRTDedxcorrection >, SG::CondHandleKey< PixelCalib::PixelOfflineCalibData >, SG::CondHandleKey< InDet::TRT_DetElementsRoadData_xk >, SG::CondHandleKey< CaloAffectedRegionInfoVec >, SG::CondHandleKey< RpcCablingCondData >, SG::CondHandleKey< Trk::SolenoidParametrization >, SG::CondHandleKey< BunchLumisCondData >, SG::CondHandleKey< BunchCrossingAverageCondData >, SG::CondHandleKey< ILArAutoCorr >, SG::CondHandleKey< CscCondDbData >, SG::CondHandleKey< LArAutoCorrTotal >, SG::CondHandleKey< SCT_GainCalibData >, SG::CondHandleKey< MdtAsBuiltContainer >, SG::CondHandleKey< ActsTrk::DetectorAlignStore >, SG::CondHandleKey< InDet::SiDetElementBoundaryLinks_xk >, SG::CondHandleKey< MdtCondDbData >, SG::CondHandleKey< SiLorentzAngleCondData >, SG::CondHandleKey< RIO_OnTrackErrorScaling >, SG::CondHandleKey< LArCalibLineMapping >, SG::CondHandleKey< L1CaloPprChanStrategyContainer >, SG::CondHandleKey< L1CaloDerivedRunParsContainer >, SG::CondHandleKey< CONDDATA >, SG::CondHandleKey< Nsw_CablingMap >, SG::CondHandleKey< calib_data_t >, SG::CondHandleKey< LArCaliWaveContainer >, SG::CondHandleKey< REFCONTAINER >, SG::CondHandleKey< NswPassivationDbData >, SG::CondHandleKey< BLineContainer >, SG::CondHandleKey< SCT_MonitorCondData >, SG::CondHandleKey< InDet::SiDetectorElementStatus >, SG::CondHandleKey< RegSelCondData >, SG::CondHandleKey< InDet::BeamSpotData >, SG::CondHandleKey< NswCalibDbTimeChargeData >, SG::CondHandleKey< RpcCondDbData >, SG::CondHandleKey< BunchGroupCondData >, SG::CondHandleKey< LArRoIMap >, SG::CondHandleKey< SCT_NoiseCalibData >, SG::CondHandleKey< TRTCond::HWMap >, SG::CondHandleKey< TRTCond::AverageT0 >, SG::CondHandleKey< InDet::TRTPIDNN >, SG::CondHandleKey< ILArOFCBin >, SG::CondHandleKey< LVL1::gFEXDBCondData >, SG::CondHandleKey< L1CaloRunParametersContainer >, SG::CondHandleKey< AthenaAttributeList >, SG::CondHandleKey< PixelTDAQData >, SG::CondHandleKey< PixelDeadMapCondData >, SG::CondHandleKey< CaloRec::CaloCellPositionShift >, SG::CondHandleKey< PixelDCSTempData >, SG::CondHandleKey< PixelChargeCalibCondData >, SG::CondHandleKey< LVL1::jFEXDBCondData >, SG::CondHandleKey< CaloNoiseSigmaDiff >, SG::CondHandleKey< CaloDetDescrManager >, SG::CondHandleKey< L1CaloPpmFineTimeRefsContainer >, SG::CondHandleKey< AtlasFieldCacheCondObj >, SG::CondHandleKey< TileSamplingFraction >, SG::CondHandleKey< TgcDigitThresholdData >, SG::CondHandleKey< NswT0Data >, SG::CondHandleKey< MC_t >, SG::CondHandleKey< FillParamsCondData >, SG::CondHandleKey< CaloCellPedShift >, SG::CondHandleKey< CondDataObjY >, SG::CondHandleKey< TTrainedNetworkCollection >, SG::CondHandleKey< LArFEBTempData >, SG::CondHandleKey< NswCalibDbThresholdData >, SG::CondHandleKey< LArMCSym >, SG::CondHandleKey< PixelCablingCondData >, SG::CondHandleKey< sTGCAsBuiltData2 >, SG::CondHandleKey< PixelModuleData >, SG::CondHandleKey< L1CaloPprDisabledChannelContainerRun2 >, SG::CondHandleKey< L1CaloReadoutConfigContainerJSON >, SG::CondHandleKey< Trk::LayerMaterialMap >, SG::CondHandleKey< SCT_TdaqEnabledCondData >, SG::CondHandleKey< TrigLiveFractionCondData >, SG::CondHandleKey< ILArMphysOverMcal >, SG::CondHandleKey< SCT_DCSStatCondData >, SG::CondHandleKey< ILArRamp >, SG::CondHandleKey< LWTNNCollection >, SG::CondHandleKey< TRTCond::StrawStatusSummary >, SG::CondHandleKey< TRTCond::StrawStatusMultChanContainer >, SG::CondHandleKey< LArBadXCont >, SG::CondHandleKey< CaloRec::ToolConstants >, SG::CondHandleKey< LArXTalkWeight >, SG::CondHandleKey< ITkPixelCablingData >, SG::CondHandleKey< TgcDigitASDposData >, SG::CondHandleKey< CaloLocalHadCoeff >, SG::CondHandleKey< NswAsBuiltDbData >, SG::CondHandleKey< SCT_SensorsCondData >, SG::CondHandleKey< TRTCond::RtRelationMultChanContainer >, SG::CondHandleKey< TRTCond::StrawStatusData >, SG::CondHandleKey< ILArHVScaleCorr >, SG::CondHandleKey< TrigConf::L1PrescalesSet >, SG::CondHandleKey< TrigConf::HLTPrescalesSet >, SG::CondHandleKey< L1CaloDisabledTowersContainer >, SG::CondHandleKey< LArfSamplSC >, SG::CondHandleKey< MuonAlignmentErrorData >, SG::CondHandleKey< SCT_CalibDefectData >, SG::CondHandleKey< InDet::PixelEmulatedDefects >, SG::CondHandleKey< TileEMScale >, SG::CondHandleKey< TileDCSState >, SG::CondHandleKey< ILArDAC2uA >, SG::CondHandleKey< GeoAlignmentStore >, SG::CondHandleKey< HTcalculator >, SG::CondHandleKey< InDet::TRT_TrackSegmentsToolCondData_xk >, SG::CondHandleKey< LArHVCorr >, SG::CondHandleKey< CaloSuperCellDetDescrManager >, SG::CondHandleKey< CaloNoise >, and SG::CondHandleKey< L1CaloPpmDeadChannelsContainer >.

◆ storeHandle()

const ServiceHandle<IProxyDict>& SG::VarHandleKey::storeHandle ( ) const
inherited

Return handle to the referenced store.

◆ updateHandle()

void SG::VarHandleKey::updateHandle ( const std::string &  name)
privateinherited

Update the name of the store to which we're referring.

Parameters
nameThe new store name.

Definition at line 294 of file StoreGate/src/VarHandleKey.cxx.

295 {
296  // Don't invalidate a stored pointer if the handle is already pointing
297  // at the desired service.
298  if (m_storeHandle.name() != name) {
299  m_hashedKey = 0;
300  m_storeHandle = ServiceHandle<IProxyDict>(name, "VarHandleKey");
303  }
304 }

◆ updateKey()

void SG::VarHandleKey::updateKey ( std::string  key)
finaloverrideprivatevirtualinherited

Prevent this method from being called.

Definition at line 195 of file StoreGate/src/VarHandleKey.cxx.

196 {
197  throw SG::ExcForbiddenMethod ("VarHandleKey::updateKey");
198 }

Member Data Documentation

◆ m_decisionKey

template<class T >
WriteHandleKey<ThinningDecision> SG::ThinningHandleKey< T >::m_decisionKey
private

Thinning decision write key.

Definition at line 151 of file ThinningHandleKey.h.

◆ m_hashedKey

SG::sgkey_t SG::VarHandleKey::m_hashedKey = 0
privateinherited

The hashed StoreGate key. May be 0 if not yet initialized.

Definition at line 250 of file StoreGate/StoreGate/VarHandleKey.h.

◆ m_isEventStore

bool SG::VarHandleKey::m_isEventStore = false
privateinherited

Cache test for whether we're referencing the event store.

Definition at line 253 of file StoreGate/StoreGate/VarHandleKey.h.

◆ m_owningHandle

VarHandleBase* SG::VarHandleKey::m_owningHandle = nullptr
privateinherited

Handle that owns this key, or nullptr if it is not owned.

Definition at line 256 of file StoreGate/StoreGate/VarHandleKey.h.

◆ m_sgKey

std::string SG::VarHandleKey::m_sgKey
privateinherited

StoreGate key, that doesn't include the storename.

Definition at line 247 of file StoreGate/StoreGate/VarHandleKey.h.

◆ m_storeHandle

ServiceHandle<IProxyDict> SG::VarHandleKey::m_storeHandle
privateinherited

Handle to the referenced store.

Definition at line 244 of file StoreGate/StoreGate/VarHandleKey.h.


The documentation for this class was generated from the following file:
used
common.sgkey
def sgkey(tool)
Definition: common.py:1028
python.trigbs_prescaleL1.ost
ost
Definition: trigbs_prescaleL1.py:104
SG::VarHandleKey::m_isEventStore
bool m_isEventStore
Cache test for whether we're referencing the event store.
Definition: StoreGate/StoreGate/VarHandleKey.h:253
Gaudi::Utils::toStream
std::ostream & toStream(const SG::VarHandleKeyArray &v, std::ostream &o)
Gaudi function used to convert a property to a string.
Definition: StoreGate/src/VarHandleKeyArray.cxx:47
SG::VarHandleKey::m_storeHandle
ServiceHandle< IProxyDict > m_storeHandle
Handle to the referenced store.
Definition: StoreGate/StoreGate/VarHandleKey.h:244
SG::VarHandleKey::updateHandle
void updateHandle(const std::string &name)
Update the name of the store to which we're referring.
Definition: StoreGate/src/VarHandleKey.cxx:294
SG::VarHandleKey::m_hashedKey
SG::sgkey_t m_hashedKey
The hashed StoreGate key. May be 0 if not yet initialized.
Definition: StoreGate/StoreGate/VarHandleKey.h:250
SG::VarHandleKey::key
const std::string & key() const
Return the StoreGate ID for the referenced object.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:141
SG::VarHandleKey::empty
bool empty() const
Test if the key is blank.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:150
storeSeparator
constexpr char const storeSeparator
Definition: StoreGate/src/VarHandleKey.cxx:27
JetTagCalibConfig.className
string className
Definition: JetTagCalibConfig.py:36
StoreID::CONDITION_STORE
@ CONDITION_STORE
Definition: StoreID.h:28
StoreID::PILEUP_STORE
@ PILEUP_STORE
Definition: StoreID.h:31
SG::ExcBadHandleKey
Exception — Bad key format for VarHandleKey.
Definition: Control/StoreGate/StoreGate/exceptions.h:62
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
Preparation.mode
mode
Definition: Preparation.py:94
StoreID::METADATA_STORE
@ METADATA_STORE
Definition: StoreID.h:29
SG::ExcForbiddenMethod
Exception — Forbidden method called.
Definition: Control/StoreGate/StoreGate/exceptions.h:77
SG::VarHandleKey::initialize
StatusCode initialize(bool used=true)
If this object is used as a property, then this should be called during the initialize phase.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:103
SG::VarHandleKey::m_sgKey
std::string m_sgKey
StoreGate key, that doesn't include the storename.
Definition: StoreGate/StoreGate/VarHandleKey.h:247
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:228
StoreID::type
type
Definition: StoreID.h:24
StoreID::findStoreID
static StoreID::type findStoreID(const std::string &storeName)
Definition: StoreID.cxx:21
LHEF::Writer
Pythia8::Writer Writer
Definition: Prophecy4fMerger.cxx:12
StoreID::EVENT_STORE
@ EVENT_STORE
Definition: StoreID.h:26
SG::AllowEmpty
@ AllowEmpty
Definition: StoreGate/StoreGate/VarHandleKey.h:30
StoreID::storeName
static const std::string & storeName(const StoreID::type &s)
Definition: StoreID.cxx:77
ServiceHandle< IProxyDict >