Property holding a SG store/key/clid from which a WriteHandle is made. More...

#include <WriteHandleKey.h>

Inherited by SG::WriteDecorHandleKey< xAOD::MuonSegmentContainer >, SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >, SG::WriteDecorHandleKey< xAOD::UncalibratedMeasurementContainer >, SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >, SG::WriteDecorHandleKey< xAOD::EventInfo >, SG::WriteDecorHandleKey< xAOD::JetContainer >, SG::WriteDecorHandleKey< xAOD::ElectronContainer >, SG::WriteDecorHandleKey< DataVector< T > >, and SG::WriteDecorHandleKey< T >.

Collaboration diagram for SG::WriteHandleKey< T >:

Public Types
using	PropertyType = SG::VarHandleKeyProperty
	Declare corresponding property type.

Public Member Functions
	WriteHandleKey (const std::string &key="", const std::string &storeName=StoreID::storeName(StoreID::EVENT_STORE))
	Constructor.
template<std::derived_from< IProperty > OWNER>
	WriteHandleKey (OWNER *owner, std::string name, const std::string &key={}, std::string doc="")
	auto-declaring Property Constructor.
WriteHandleKey &	operator= (const std::string &sgkey)
	Change the key of the object to which we're referring.
virtual StatusCode	assign (const std::string &sgkey)
	Change the key of the object to which we're referring.
StatusCode	initialize (bool used=true)
	If this object is used as a property, then this should be called during the initialize phase.
StatusCode	initialize (AllowEmptyEnum)
	If this object is used as a property, then this should be called during the initialize phase.
CLID	clid () const
	Return the class ID for the referenced object.
const std::string &	key () const
	Return the StoreGate ID for the referenced object.
bool	empty () const
	Test if the key is blank.
const ServiceHandle< IProxyDict > &	storeHandle () const
	Return handle to the referenced store.
VarHandleBase *	owningHandle ()
	Return the VarHandle that owns this key, if any.
bool	isEventStore () const
	Does this key reference the primary event store?
virtual StatusCode	start ()
	Called by the owning algorithm during the START transition.
SG::sgkey_t	hashedKey () const
	Return the hashed StoreGate key.

Static Public Attributes
static constexpr bool	isDecorHandleKey = false

Protected Member Functions
virtual std::string	pythonRepr () const override
	Python representation of Handle.

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

Private Attributes
ServiceHandle< IProxyDict >	m_storeHandle
	Handle to the referenced store.
std::string	m_sgKey
	StoreGate key, that doesn't include the storename.
SG::sgkey_t	m_hashedKey = 0
	The hashed StoreGate key. May be 0 if not yet initialized.
bool	m_isEventStore = false
	Cache test for whether we're referencing the event store.
VarHandleBase *	m_owningHandle = nullptr
	Handle that owns this key, or nullptr if it is not owned.

Detailed Description

template<class T>
class SG::WriteHandleKey< T >

Property holding a SG store/key/clid from which a WriteHandle is made.

This class holds the key part of a WriteHandle. For a reentrant algorithm, you would use this as the algorithm property and construct the actual ReadHandle on the stack from this key object (and optionally the event context).

See VarHandleKey for more details.

Definition at line 38 of file StoreGate/StoreGate/WriteHandleKey.h.

Member Typedef Documentation

◆ PropertyType

using SG::VarHandleKey::PropertyType = SG::VarHandleKeyProperty

inherited

Declare corresponding property type.

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

Constructor & Destructor Documentation

◆ WriteHandleKey() [1/2]

template<class T>

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

explicit

Constructor.

Parameters

key	The StoreGate key for the object.
storeName	Name 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.

◆ WriteHandleKey() [2/2]

template<class T>

template<std::derived_from< IProperty > OWNER>

SG::WriteHandleKey< T >::WriteHandleKey	(	OWNER *	owner,
		std::string	name,
		const std::string &	key = {},
		std::string	doc = "" )

inline

auto-declaring Property Constructor.

Parameters

owner	Owning component.
name	name of the Property
key	default StoreGate key for the object.
doc	Documentation string.

will associate the named Property with this WHK 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

sgkey The 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.

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

{
  m_sgKey = sgkey;
  return StatusCode::SUCCESS;
}

◆ clid()

CLID SG::VarHandleKey::clid ( ) const

inherited

Return the class ID for the referenced object.

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

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

◆ empty()

bool SG::VarHandleKey::empty ( ) const

inherited

Test if the key is blank.

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

{
  return m_sgKey.empty();
}

◆ hashedKey()

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

inherited

Return the hashed StoreGate key.

May be 0 if not yet initialized.

◆ initialize() [1/2]

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

Flag

to select this variant. Call like

ATH_CHECK( key.initialize (SG::AllowEmpty) );

ATH_CHECK

#define ATH_CHECK

Evaluate an expression and check for errors.

Definition AthCheckMacros.h:40

SG::VarHandleKey::key

const std::string & key() const

Return the StoreGate ID for the referenced object.

Definition AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:141

SG::AllowEmpty

@ AllowEmpty

Definition StoreGate/StoreGate/VarHandleKey.h:27

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

{
  if (key().empty()) {
    return StatusCode::SUCCESS;
  }
  return initialize (true);
}

◆ initialize() [2/2]

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

used	If 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.

{
  if (!used) {
    m_sgKey = "";
    return StatusCode::SUCCESS;
  }
 
  if (key() == "") {
    // REPORT_ERROR (StatusCode::FAILURE)
    //   << "Cannot initialize a Read/Write/Update handle with a null key.";
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

◆ 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.

{
  return m_sgKey;
}

◆ operator=()

template<class T>

WriteHandleKey & SG::WriteHandleKey< T >::operator= ( const std::string & sgkey )

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

Parameters

sgkey The 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.

◆ 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

sgkey The 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

sgkey The 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 228 of file StoreGate/src/VarHandleKey.cxx.

{
  std::string sn;
  // test if storeName has classname
  std::string::size_type sp = storeName.find('/');
  if (sp == std::string::npos) {
    sn = storeName;
  } else {
    sn = storeName.substr(sp+1,storeName.length()-sp+1);
  }
 
  if (key.empty()) {
    this->updateHandle(sn);
    Gaudi::DataHandle::updateKey("");
    m_sgKey.clear();
    m_hashedKey = 0;
    return;
  }
 
  // StoreName separator is "+"
  sp = key.find(storeSeparator);
  if(sp == std::string::npos) {
    m_sgKey = key;
  } else {
    sn = key.substr(0,sp);
    m_sgKey = key.substr(sp+1,key.length()-sp-1);
  }
 
 
  this->updateHandle(sn);
 
  StoreID::type st;
  // would be nice if we could get the storeID from the storeHandle, but
  // we can't be sure that the store has been created when the VHK is
  // constructed.
  //
 
  st = StoreID::findStoreID(sn);
 
  if (st != StoreID::CONDITION_STORE && st != StoreID::METADATA_STORE) {
    if (m_sgKey.find('/') != std::string::npos) {
      throw SG::ExcBadHandleKey("key \"" + key
                                + "\": keys with \"/\" only allowed for "
                                + StoreID::storeName(StoreID::CONDITION_STORE)
                                + " - store is \""
                                + sn + "\"");
    }
  } else {
    sp = m_sgKey.rfind('/');
    if (sp != std::string::npos) {
      if (sp == 0
      && m_sgKey.size() == 1) {
        // Replace '\' with blank key
        m_sgKey.clear();
        m_hashedKey = 0;
      } else if ( sp == m_sgKey.length()-1) {
        throw SG::ExcBadHandleKey("key \"" + key
                                  + "\": must not end with a \"/\"");
      }
    }
  }
 
  if (m_sgKey.empty()) {
    Gaudi::DataHandle::updateKey("");
  } else {
    Gaudi::DataHandle::updateKey(sn + storeSeparator + m_sgKey);
  }
 
 
}

◆ pythonRepr()

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

overrideprotectedvirtualinherited

Python representation of Handle.

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

{
  const std::string& className = fullKey().className().empty() ?
    Gaudi::DataHandle::default_type : fullKey().className();
 
  std::ostringstream ost;
  ost << "DataHandle(";
  Gaudi::Utils::toStream(m_storeHandle.name() + storeSeparator + m_sgKey, ost);
  ost << ",";
  switch (mode()) {
  case Gaudi::DataHandle::Writer:
    Gaudi::Utils::toStream("W", ost); break;
  default:
    Gaudi::Utils::toStream("R", ost); break;
  }
  ost << ","; Gaudi::Utils::toStream(className, ost);
  ost << ","; Gaudi::Utils::toStream(isCondition(), ost);
  ost << ")";
 
  return ost.str();
}

◆ setKey()

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

finaloverrideprivatevirtualinherited

Don't allow calling these.

Prevent this method from being called.

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

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

◆ 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.

◆ 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

name	The new store name.

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

{
  // Don't invalidate a stored pointer if the handle is already pointing
  // at the desired service.
  if (m_storeHandle.name() != name) {
    m_hashedKey = 0;
    m_storeHandle = ServiceHandle<IProxyDict>(name, "VarHandleKey");
    m_isEventStore =  (name == StoreID::storeName(StoreID::EVENT_STORE) ||
                       name == StoreID::storeName(StoreID::PILEUP_STORE));
  }
}

◆ updateKey()

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

finaloverrideprivatevirtualinherited

Prevent this method from being called.

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

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

Member Data Documentation

◆ isDecorHandleKey

bool SG::VarHandleKey::isDecorHandleKey = false

staticconstexprinherited

Definition at line 61 of file StoreGate/StoreGate/VarHandleKey.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 249 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 252 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 255 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 246 of file StoreGate/StoreGate/VarHandleKey.h.

◆ m_storeHandle

ServiceHandle<IProxyDict> SG::VarHandleKey::m_storeHandle

privateinherited

Handle to the referenced store.

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

The documentation for this class was generated from the following file:

StoreGate/StoreGate/WriteHandleKey.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ PropertyType

Constructor & Destructor Documentation

◆ WriteHandleKey() [1/2]

◆ WriteHandleKey() [2/2]

Member Function Documentation

◆ assign()

◆ clid()

◆ empty()

◆ hashedKey()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ isEventStore()

◆ key()

◆ operator=()

◆ owningHandle()

◆ parseKey()

◆ pythonRepr()

◆ setKey()

◆ setOwningHandle()

◆ start()

◆ storeHandle()

◆ updateHandle()

◆ updateKey()

Member Data Documentation

◆ isDecorHandleKey

◆ m_hashedKey

◆ m_isEventStore

◆ m_owningHandle

◆ m_sgKey

◆ m_storeHandle