Property holding a SG store/key/clid/attr name from which a WriteDecorHandle is made. More...

#include <WriteDecorHandleKey.h>

Inheritance diagram for SG::WriteDecorHandleKey< T >:

Collaboration diagram for SG::WriteDecorHandleKey< T >:

Public Types
typedef WriteHandleKey< T >	Base
using	PropertyType = SG::VarHandleKeyProperty
	Declare corresponding property type.

Public Member Functions
	WriteDecorHandleKey (const std::string &key="", const std::string &storeName=StoreID::storeName(StoreID::EVENT_STORE))
	Constructor.
	WriteDecorHandleKey (const VarHandleKey &contKey, const std::string &decorKey="", const std::string &storeName=StoreID::storeName(StoreID::EVENT_STORE))
	Constructor with associated container.
template<std::derived_from< IProperty > OWNER>
	WriteDecorHandleKey (OWNER *owner, const std::string &name, const std::string &key={}, const std::string &doc="")
	auto-declaring Property Constructor.
template<std::derived_from< IProperty > OWNER>
	WriteDecorHandleKey (OWNER *owner, const std::string &name, const VarHandleKey &contKey, const std::string &decorKey={}, const std::string &doc="")
	auto-declaring Property Constructor.
WriteDecorHandleKey &	operator= (const std::string &sgkey)
	Change the key of the object to which we're referring.
virtual StatusCode	assign (const std::string &sgkey) override
	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.
const ReadHandleKey< T > &	contHandleKey () const
	Return the handle key for the container.
void	renounce ()
	Declare that this item does not participate in scheduling.
bool	renounced () const
	Return the renounced flag.
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 = true

Private Member Functions
virtual std::string	pythonRepr () const override
	Python representation of Handle.
ReadHandleKey< T > &	contHandleKey_nc ()
	Return the handle key for the container.
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
ReadHandleKey< T >	m_contHandleKey
	The container handle.
const VarHandleKey *	m_contKey = nullptr
	Optional container on which decorations are applied.
bool	m_renounced = false
	True if this key has been the target of a renounce().
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.

Friends
class	::AthAlgorithm
class	::AthReentrantAlgorithm
class	::AthAlgTool

Detailed Description

template<class T>
class SG::WriteDecorHandleKey< T >

Property holding a SG store/key/clid/attr name from which a WriteDecorHandle is made.

This class holds the key part of a WriteDecorHandle.

Use this to add a decoration to an object such that the scheduler is aware of it. This is used just like a WriteHandleKey (which see) except that the key string is of the form CCC.DDD, where CCC is the name of the container in StoreGate and DDD is the name of the decoration.

Example:

class MyAlgorithm : public AthReentrantAlgorithm {
  ...
  SG::WriteDecorHandleKey<MyCont> m_key{this, "Key",  "container.decor"};
};
 
StatusCode MyAlgorithm::initialize()
{
  ATH_CHECK( m_key.initialize() );
  ...
}
 
StatusCode MyAlgorithm::execute (const EventContext& ctx) const
{
  SG::WriteDecorHandle<MyCont, float> h (m_key, ctx);
  for (const MyObj& o : *h) {  // Access the container.
    h (o) = calculate (o);  // Add the decoration.
    ...

Alternatively, one can construct the key with an additional VarHandleKey that represents the container and the key then only holds the decoration name. This is useful to avoid hard-coding the container name twice in case the algorithm also has a ReadHandleKey or WriteHandleKey for the container:

Example:

class MyAlgorithm : public AthReentrantAlgorithm {
  ...
  SG::WriteHandleKey<MyCont> m_whkey{this, "WHKey", "container"};
  SG::WriteDecorHandleKey<MyCont> m_wdhkey{this, "Key", m_whkey, "decor"};
};
...

Implementation note: We want to make two dependencies from this key: a read dependency on the container itself, and a write dependency on the decoration. This class derives from WriteHandleKey, which provides the output dependency on the decoration. We also hold as a member a ReadHandleKey for the container. This extra dependency is added at initialize time via registerWriteDecorHandleKey(), which see.

Definition at line 88 of file StoreGate/StoreGate/WriteDecorHandleKey.h.

Member Typedef Documentation

◆ Base

template<class T>

typedef WriteHandleKey<T> SG::WriteDecorHandleKey< T >::Base

Definition at line 92 of file StoreGate/StoreGate/WriteDecorHandleKey.h.

◆ 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

◆ WriteDecorHandleKey() [1/4]

template<class T>

SG::WriteDecorHandleKey< T >::WriteDecorHandleKey	(	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.

◆ WriteDecorHandleKey() [2/4]

template<class T>

SG::WriteDecorHandleKey< T >::WriteDecorHandleKey	(	const VarHandleKey &	contKey,
		const std::string &	decorKey = "",
		const std::string &	storeName = StoreID::storeName(StoreID::EVENT_STORE) )

explicit

Constructor with associated container.

Parameters

contKey	VarHandleKey of the associated container
decorKey	The decoration name.
storeName	Name to use for the store.

The decoration @decorKey will be applied on the container referenced by @contKey.

◆ WriteDecorHandleKey() [3/4]

template<class T>

template<std::derived_from< IProperty > OWNER>

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

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

◆ WriteDecorHandleKey() [4/4]

template<class T>

template<std::derived_from< IProperty > OWNER>

SG::WriteDecorHandleKey< T >::WriteDecorHandleKey	(	OWNER *	owner,
		const std::string &	name,
		const VarHandleKey &	contKey,
		const std::string &	decorKey = {},
		const std::string &	doc = "" )

auto-declaring Property Constructor.

Parameters

owner	Owning component.
name	name of the Property
contKey	VarHandleKey of the associated container
decorKey	name The decoration name.
doc	Documentation string.

Will associate the named Property with this WDHK via declareProperty The container part of the decoration key will be taken from contKey, while decorKey gives the name of the decoration itself. If decorKey is blank, then the overall key will be blank.

Member Function Documentation

◆ assign()

template<class T>

virtual StatusCode SG::WriteDecorHandleKey< T >::assign ( const std::string & sgkey )

overridevirtual

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.

Reimplemented from SG::VarHandleKey.

◆ clid()

CLID SG::VarHandleKey::clid ( ) const

inherited

Return the class ID for the referenced object.

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

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

◆ contHandleKey()

template<class T>

const ReadHandleKey< T > & SG::WriteDecorHandleKey< T >::contHandleKey ( ) const

Return the handle key for the container.

◆ contHandleKey_nc()

template<class T>

ReadHandleKey< T > & SG::WriteDecorHandleKey< T >::contHandleKey_nc ( )

private

Return the handle key for the container.

Should be used only by AthAlgorithm/AthAlgTool.

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

template<class T>

StatusCode SG::WriteDecorHandleKey< T >::initialize ( AllowEmptyEnum )

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) );

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

◆ initialize() [2/2]

template<class T>

StatusCode SG::WriteDecorHandleKey< T >::initialize ( bool used = true )

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.

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

WriteDecorHandleKey & SG::WriteDecorHandleKey< 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 225 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()

template<class T>

virtual std::string SG::WriteDecorHandleKey< T >::pythonRepr ( ) const

overrideprivatevirtual

Python representation of Handle.

Reimplemented from SG::VarHandleKey.

◆ renounce()

template<class T>

void SG::WriteDecorHandleKey< T >::renounce ( )

Declare that this item does not participate in scheduling.

If a WriteDataHandleKey is renounced, then we skip creating the output alias. Further, we skip the check that the element provided is a member of the declared container. A WriteDataHandle initialized from a renounced key will effectively behave like a simple Decorator.

◆ renounced()

template<class T>

bool SG::WriteDecorHandleKey< T >::renounced ( ) const

Return the renounced flag.

◆ setKey()

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

finaloverrideprivatevirtualinherited

Don't allow calling these.

Prevent this method from being called.

Definition at line 194 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 302 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 203 of file StoreGate/src/VarHandleKey.cxx.

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

◆ ::AthAlgorithm

template<class T>

friend class ::AthAlgorithm

friend

Definition at line 238 of file StoreGate/StoreGate/WriteDecorHandleKey.h.

◆ ::AthAlgTool

template<class T>

friend class ::AthAlgTool

friend

Definition at line 240 of file StoreGate/StoreGate/WriteDecorHandleKey.h.

◆ ::AthReentrantAlgorithm

template<class T>

friend class ::AthReentrantAlgorithm

friend

Definition at line 239 of file StoreGate/StoreGate/WriteDecorHandleKey.h.

Member Data Documentation

◆ isDecorHandleKey

template<class T>

bool SG::WriteDecorHandleKey< T >::isDecorHandleKey = true

staticconstexpr

Definition at line 95 of file StoreGate/StoreGate/WriteDecorHandleKey.h.

◆ m_contHandleKey

template<class T>

ReadHandleKey<T> SG::WriteDecorHandleKey< T >::m_contHandleKey

private

The container handle.

Definition at line 255 of file StoreGate/StoreGate/WriteDecorHandleKey.h.

◆ m_contKey

template<class T>

const VarHandleKey* SG::WriteDecorHandleKey< T >::m_contKey = nullptr

private

Optional container on which decorations are applied.

Definition at line 258 of file StoreGate/StoreGate/WriteDecorHandleKey.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_renounced

template<class T>

bool SG::WriteDecorHandleKey< T >::m_renounced = false

private

True if this key has been the target of a renounce().

(In that case, we don't make the output alias.)

Definition at line 262 of file StoreGate/StoreGate/WriteDecorHandleKey.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/WriteDecorHandleKey.h

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Base

◆ PropertyType

Constructor & Destructor Documentation

◆ WriteDecorHandleKey() [1/4]

◆ WriteDecorHandleKey() [2/4]

◆ WriteDecorHandleKey() [3/4]

◆ WriteDecorHandleKey() [4/4]

Member Function Documentation

◆ assign()

◆ clid()

◆ contHandleKey()

◆ contHandleKey_nc()

◆ empty()

◆ hashedKey()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ isEventStore()

◆ key()

◆ operator=()

◆ owningHandle()

◆ parseKey()

◆ pythonRepr()

◆ renounce()

◆ renounced()

◆ setKey()

◆ setOwningHandle()

◆ start()

◆ storeHandle()

◆ updateHandle()

◆ updateKey()

Friends And Related Symbol Documentation

◆ ::AthAlgorithm

◆ ::AthAlgTool

◆ ::AthReentrantAlgorithm

Member Data Documentation

◆ isDecorHandleKey

◆ m_contHandleKey

◆ m_contKey

◆ m_hashedKey

◆ m_isEventStore

◆ m_owningHandle

◆ m_renounced

◆ m_sgKey

◆ m_storeHandle