SG::WriteCondHandleKey< T > Class Template Reference

#include <WriteCondHandleKey.h>

Inheritance diagram for SG::WriteCondHandleKey< T >:

Collaboration diagram for SG::WriteCondHandleKey< T >:

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

Public Member Functions
	WriteCondHandleKey (const std::string &key, const std::string &dbKey)
	Constructor for WriteCondHandle @key StoreGate key @dbKey key in the database. More...
	WriteCondHandleKey (const std::string &key)
	Constructor for WriteCondHandle that takes just a SG key @key StoreGate key. More...
template<class OWNER , typename = typename std::enable_if<std::is_base_of<IProperty, OWNER>::value>::type>
	WriteCondHandleKey (OWNER *owner, std::string name, const std::string &key={}, std::string doc="")
	auto-declaring Property Constructor. More...
WriteCondHandleKey &	operator= (const std::string &sgkey)
	Change the key of the object to which we're referring. More...
StatusCode	initialize (bool used=true)
StatusCode	initialize (AllowEmptyEnum)
const std::string &	dbKey () const
void	setDbKey (const std::string &dbKey)
virtual StatusCode	start () override
	Called by the owning algorithm during the START transition. More...
virtual StatusCode	assign (const std::string &sgkey)
	Change the key of the object to which we're referring. 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...
VarHandleBase *	owningHandle ()
	Return the VarHandle that owns this key, if any. More...
bool	isEventStore () const
	Does this key reference the primary event store? More...
SG::sgkey_t	hashedKey () const
	Return the hashed StoreGate key. More...

Protected Member Functions
bool	isInit () const
CondCont< T > *getCC	ATLAS_NOT_CONST_THREAD_SAFE () const
StoreGateSvc *	getCS () const
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
ServiceHandle< StoreGateSvc >	m_cs
CondCont< T > *	m_cc {0}
std::string	m_dbKey {""}
bool	m_isInit {false}
ServiceHandle< IProxyDict >	m_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...
VarHandleBase *	m_owningHandle = nullptr
	Handle that owns this key, or nullptr if it is not owned. More...

Friends
class	WriteCondHandle< T >

Detailed Description

template<class T>
class SG::WriteCondHandleKey< T >

Definition at line 18 of file WriteCondHandleKey.h.

Member Typedef Documentation

PropertyType

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

inherited

Declare corresponding property type.

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

Constructor & Destructor Documentation

WriteCondHandleKey() [1/3]

template<class T >

SG::WriteCondHandleKey< T >::WriteCondHandleKey ( const std::string &  key, const std::string &  dbKey  )

inline

Constructor for WriteCondHandle @key StoreGate key @dbKey key in the database.

Definition at line 31 of file WriteCondHandleKey.h.

                                                                     :
      CondHandleKey<T>(key, dbKey, Gaudi::DataHandle::Writer)
    {}

WriteCondHandleKey() [2/3]

template<class T >

SG::WriteCondHandleKey< T >::WriteCondHandleKey ( const std::string &  key )

inlineexplicit

Constructor for WriteCondHandle that takes just a SG key @key StoreGate key.

the value of the dbKey is the same as the StoreGate key

Definition at line 41 of file WriteCondHandleKey.h.

                                                      :
      CondHandleKey<T>(key, key, Gaudi::DataHandle::Writer)
    {}

WriteCondHandleKey() [3/3]

template<class T >

template<class OWNER , typename = typename std::enable_if<std::is_base_of<IProperty, OWNER>::value>::type>

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

inline

auto-declaring Property Constructor.

Parameters

name	name of the Property
key	default StoreGate key for the object.
doc	documentation string

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

Definition at line 60 of file WriteCondHandleKey.h.

                                                    {},
                               std::string doc="") :
      WriteCondHandleKey<T>(key) {
      auto p = owner->declareProperty(std::move(name), *this, std::move(doc));
      p->template setOwnerType<OWNER>();
    }

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.

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< xAOD::TruthParticleContainer >, SG::WriteDecorHandleKey< C >, SG::WriteDecorHandleKey< DMTest::PLinks_v1 >, SG::WriteDecorHandleKey< NEW >, SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >, SG::WriteDecorHandleKey< xAOD::EventInfo_v1 >, SG::WriteDecorHandleKey< CONTAINER >, SG::WriteDecorHandleKey< xAOD::JetContainer >, 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.

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

ATLAS_NOT_CONST_THREAD_SAFE()

template<class T >

CondCont<T>* getCC SG::CondHandleKey< T >::ATLAS_NOT_CONST_THREAD_SAFE ( ) const

inlineprotectedinherited

Definition at line 52 of file CondHandleKey.h.

{ return m_cc; }

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

dbKey()

template<class T >

const std::string& SG::CondHandleKey< T >::dbKey ( ) const

inlineinherited

Definition at line 31 of file CondHandleKey.h.

{ return m_dbKey; }

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

getCS()

template<class T >

StoreGateSvc* SG::CondHandleKey< T >::getCS ( ) const

protectedinherited

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::CondHandleKey< T >::initialize ( AllowEmptyEnum  )

inherited

initialize() [2/2]

template<class T >

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

inherited

isEventStore()

bool SG::VarHandleKey::isEventStore ( ) const

inherited

Does this key reference the primary event store?

isInit()

template<class T >

bool SG::CondHandleKey< T >::isInit ( ) const

inlineprotectedinherited

Definition at line 46 of file CondHandleKey.h.

{ return m_isInit; }

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 >

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

inline

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.

Definition at line 78 of file WriteCondHandleKey.h.

                                                                  {
      VarHandleKey::operator= (sgkey);
      return *this;
    }

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

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

overrideprotectedvirtualinherited

Python representation of Handle.

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

Definition at line 317 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();
}

setDbKey()

template<class T >

void SG::CondHandleKey< T >::setDbKey ( const std::string &  dbKey )

inlineinherited

Definition at line 32 of file CondHandleKey.h.

{ m_dbKey = dbKey; }

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

template<class T >

virtual StatusCode SG::CondHandleKey< T >::start ( )

overridevirtualinherited

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.

Reimplemented from SG::VarHandleKey.

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

Friends And Related Function Documentation

WriteCondHandle< T >

template<class T >

friend class WriteCondHandle< T >

friend

Definition at line 1 of file WriteCondHandleKey.h.

Member Data Documentation

m_cc

template<class T >

CondCont<T>* SG::CondHandleKey< T >::m_cc {0}

privateinherited

Definition at line 59 of file CondHandleKey.h.

m_cs

template<class T >

ServiceHandle<StoreGateSvc> SG::CondHandleKey< T >::m_cs

privateinherited

Definition at line 58 of file CondHandleKey.h.

m_dbKey

template<class T >

std::string SG::CondHandleKey< T >::m_dbKey {""}

privateinherited

Definition at line 61 of file CondHandleKey.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_isInit

template<class T >

bool SG::CondHandleKey< T >::m_isInit {false}

privateinherited

Definition at line 63 of file CondHandleKey.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:

• WriteCondHandleKey.h