an iterator over instances of a given type in an IProxyDict (such as StoreGateSvc). More...

#include <DataHandleBase.h>

Inheritance diagram for DataHandleBase:

Collaboration diagram for DataHandleBase:

Public Types
typedef std::string	ID_type

Public Member Functions
	DataHandleBase ()
	Default constructor:
	DataHandleBase (const DataHandleBase &rhs)
	Copy constructor:
DataHandleBase &	operator= (const DataHandleBase &rhs)
	Assignment operator:
	DataHandleBase (SG::DataProxy *proxy)
	Constructor with parameters:
	DataHandleBase (const SG::ConstProxyIterator &itr1, const SG::ConstProxyIterator &itr2)
virtual	~DataHandleBase ()
	Destructor:
virtual void	reset (bool hard)=0
	Clear cached data from this object.
virtual void	finalReset ()
	optional special action on final reset call (e.g. in caller destructor)

validity checks
SG::ConstProxyIterator	m_itr
	iterator pointing at the beginning of the range of proxies
SG::ConstProxyIterator	m_itrEnd
	iterator pointing at the end of the range of proxies
SG::DataProxy *	m_proxy
	the proxy holding the object we are bound to
bool	m_useItr
	use the proxy-iterator or just the proxy ?
bool	isConst () const
bool	isInitialized () const
	weaker test but it does not touch the disk!
virtual bool	isSet () const override
virtual const std::string &	key () const override
	Get the key string with which the current object was stored.
StatusCode	setState (SG::DataProxy *proxy) const
StatusCode	setState (IProxyDict *store, const ID_type &name) const
StatusCode	setState (SG::ConstProxyIterator &itr1, const SG::ConstProxyIterator &itr2) const
virtual CLID	clid () const =0
	the CLID of the object we are bound to
ID_type	ID () const
	get the data object key (ID)
StatusCode	setState (SG::DataProxy *proxy)
StatusCode	setState (IProxyDict *store, const ID_type &name)

Detailed Description

an iterator over instances of a given type in an IProxyDict (such as StoreGateSvc).

It d-casts and caches locally the pointed-at object, to speed-up subsequent accesses. It can be reset by the store for asynchronous updates (IOVSvc)

Definition at line 37 of file DataHandleBase.h.

Member Typedef Documentation

◆ ID_type

typedef std::string DataHandleBase::ID_type

Definition at line 44 of file DataHandleBase.h.

Constructor & Destructor Documentation

◆ DataHandleBase() [1/4]

DataHandleBase::DataHandleBase ( )

Default constructor:

Definition at line 27 of file DataHandleBase.cxx.

                               :
  IResetable(),
  m_itr(), 
  m_itrEnd(), 
  m_proxy(0),
  //m_ptr(0),
  m_useItr(false)
{}

◆ DataHandleBase() [2/4]

DataHandleBase::DataHandleBase ( const DataHandleBase & rhs )

Copy constructor:

Definition at line 37 of file DataHandleBase.cxx.

                                                          :
  IResetable(),
  m_itr(rhs.m_itr), 
  m_itrEnd(rhs.m_itrEnd),
  m_proxy(rhs.m_proxy), 
  //m_ptr(rhs.m_ptr),
  m_useItr(rhs.m_useItr)
{
  if (m_proxy) {
    m_proxy->addRef();
  }
}

◆ DataHandleBase() [3/4]

DataHandleBase::DataHandleBase ( SG::DataProxy * proxy )

Constructor with parameters:

Definition at line 74 of file DataHandleBase.cxx.

                                                 :
  IResetable(),
  m_itr(), 
  m_itrEnd(), 
  m_proxy(proxy), 
  //m_ptr(0),
  m_useItr(false)
{
  if (m_proxy) {
    m_proxy->addRef();
  }
}

◆ DataHandleBase() [4/4]

DataHandleBase::DataHandleBase	(	const SG::ConstProxyIterator &	itr1,
		const SG::ConstProxyIterator &	itr2 )

Definition at line 87 of file DataHandleBase.cxx.

                                                                   :
  IResetable(),
  m_itr(itr), 
  m_itrEnd(itrEnd),
  m_proxy(0), 
  //m_ptr(0),
  m_useItr(true)
{
  if (m_itr != m_itrEnd) {
    m_proxy = m_itr->second;
  }
 
  if (m_proxy) {
    m_proxy->addRef();
  }
}

◆ ~DataHandleBase()

DataHandleBase::~DataHandleBase ( )

virtual

Destructor:

Definition at line 107 of file DataHandleBase.cxx.

{
  if (m_proxy != 0) {
    m_proxy->unbindHandle(this);
    m_proxy->release();
  }
}

Member Function Documentation

◆ clid()

virtual CLID DataHandleBase::clid ( ) const

pure virtual

the CLID of the object we are bound to

Implemented in DataHandle< DATA >, DataHandle< AthenaAttributeList >, DataHandle< CondMultChanCollection< AlignableTransform > >, DataHandle< GenericDbTable >, DataHandle< ILArPedestal >, DataHandle< ILArShape >, and DataHandle< StrawDxContainer >.

◆ finalReset()

virtual void IResetable::finalReset ( )

inlinevirtualinherited

optional special action on final reset call (e.g. in caller destructor)

Reimplemented in SG::VarHandleBase.

Definition at line 33 of file IResetable.h.

33{};

◆ ID()

ID_type DataHandleBase::ID ( ) const

inline

get the data object key (ID)

Definition at line 94 of file DataHandleBase.h.

94{ return isInitialized() ? m_proxy->name() : "NONE"; }

DataHandleBase::isInitialized

bool isInitialized() const

weaker test but it does not touch the disk!

Definition DataHandleBase.cxx:207

◆ isConst()

bool DataHandleBase::isConst ( ) const

Definition at line 196 of file DataHandleBase.cxx.

{
  return 0 != m_proxy 
    ? m_proxy->isConst() 
    : false;
}

◆ isInitialized()

bool DataHandleBase::isInitialized ( ) const

weaker test but it does not touch the disk!

Definition at line 207 of file DataHandleBase.cxx.

{
  return (0 != m_proxy);
}

◆ isSet()

virtual bool DataHandleBase::isSet ( ) const

inlineoverridevirtual

Implements IResetable.

Definition at line 77 of file DataHandleBase.h.

77{ return isInitialized(); }

◆ key()

const std::string & DataHandleBase::key ( ) const

overridevirtual

Get the key string with which the current object was stored.

Implements IResetable.

Definition at line 186 of file DataHandleBase.cxx.

{
  if (m_itr == m_itrEnd) {
    return m_proxy->name();
  } else {
    return m_itr->first;
  }
}

◆ operator=()

DataHandleBase & DataHandleBase::operator= ( const DataHandleBase & rhs )

Assignment operator:

Definition at line 53 of file DataHandleBase.cxx.

{
  if (this != &rhs) {
    if (m_proxy) {
      m_proxy->release();
    }
 
    m_itr =    rhs.m_itr;
    m_itrEnd = rhs.m_itrEnd;
    m_useItr = rhs.m_useItr;
    m_proxy =  rhs.m_proxy;
    //m_ptr =    rhs.m_ptr;
    if (m_proxy) {
      m_proxy->addRef();
    }
  }
 
  return *this;
}

◆ reset()

virtual void IResetable::reset ( bool hard )

pure virtualinherited

Clear cached data from this object.

If HARD is true, then also clear any data that depends on the identity of the current event store. HARD will be set if the handle could potentially be looking at a different store the next time it is used. (This happens in Hive.)

For example, a VarHandle caches both a pointer to the referenced object and a pointer to the DataProxy used to reference it. If HARD is false, then only the object pointer need be cleared; but if it is true, then the DataProxy pointer should be cleared as well (and the object deregistered from the store).

Implemented in DataHandle< DATA >, DataHandle< AthenaAttributeList >, DataHandle< CondMultChanCollection< AlignableTransform > >, DataHandle< GenericDbTable >, DataHandle< ILArPedestal >, DataHandle< ILArShape >, DataHandle< StrawDxContainer >, SG::UpdateHandle< T >, SG::UpdateHandle< IDCBackend >, and SG::VarHandleBase.

◆ setState() [1/5]

StatusCode DataHandleBase::setState	(	IProxyDict *	store,
		const ID_type &	name )

Definition at line 235 of file DataHandleBase.cxx.

{
  if (0 == store) {
    return StatusCode::FAILURE;
  }
  CLID cid = this->clid();
  SG::DataProxy* proxy = store->proxy(cid, key);
  return this->setState(proxy);
}

◆ setState() [2/5]

StatusCode DataHandleBase::setState	(	IProxyDict *	store,
		const ID_type &	name ) const

Definition at line 175 of file DataHandleBase.cxx.

{
  if (0 == store) {
    return StatusCode::FAILURE;
  }
  CLID cid = this->clid();
  SG::DataProxy* proxy = store->proxy(cid, key);
  return this->setState(proxy);
}

◆ setState() [3/5]

StatusCode DataHandleBase::setState	(	SG::ConstProxyIterator &	itr1,
		const SG::ConstProxyIterator &	itr2 ) const

Definition at line 123 of file DataHandleBase.cxx.

{
  if (m_proxy) m_proxy->release();
 
  m_itr = itr;
  m_itrEnd = itrEnd;
  m_useItr = true;
 
  // ouch! FIXME ?
  // we could have a void* m_ptr data member and have a
  // typeless_dataPointer method using the typeless machinery of
  // DataProxy+DataBucketBase...
  const_cast<DataHandleBase*>(this)->reset (false);
 
  // scan from itr to itrEnd and set m_itr to the first valid iterator:
 
  for (; itr != itrEnd; ++itr) {
    if (itr->second->isValid()) {
      m_itr = itr;
      m_proxy = m_itr->second;
      if (m_proxy) m_proxy->addRef();
      return StatusCode::SUCCESS;
    }
  }
 
  m_itr = itrEnd;
  m_proxy = 0;
  
  return StatusCode::FAILURE; 
}

◆ setState() [4/5]

StatusCode DataHandleBase::setState ( SG::DataProxy * proxy )

Definition at line 217 of file DataHandleBase.cxx.

{
  if (0 == proxy || !proxy->isValid() || proxy->isConst()) {
    return StatusCode::FAILURE;
  }
 
  if (m_proxy != proxy) {
    if (m_proxy) m_proxy->release();
    m_proxy = proxy;
    m_proxy->addRef();
  }
 
  m_useItr = false;
  this->reset (false);
  return StatusCode::SUCCESS;
}

◆ setState() [5/5]

StatusCode DataHandleBase::setState ( SG::DataProxy * proxy ) const

Definition at line 156 of file DataHandleBase.cxx.

{
  if (0 == proxy || !proxy->isValid()) {
    return StatusCode::FAILURE;
  }
 
  if (m_proxy != proxy) {
    if (m_proxy) m_proxy->release();
    m_proxy = proxy;
    m_proxy->addRef();
  }
 
  m_useItr = false;
  const_cast<DataHandleBase*>(this)->reset (false);
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_itr

SG::ConstProxyIterator DataHandleBase::m_itr

mutableprotected

iterator pointing at the beginning of the range of proxies

Definition at line 109 of file DataHandleBase.h.

◆ m_itrEnd

SG::ConstProxyIterator DataHandleBase::m_itrEnd

mutableprotected

iterator pointing at the end of the range of proxies

Definition at line 112 of file DataHandleBase.h.

◆ m_proxy

SG::DataProxy* DataHandleBase::m_proxy

mutableprotected

the proxy holding the object we are bound to

Definition at line 115 of file DataHandleBase.h.

◆ m_useItr

bool DataHandleBase::m_useItr

mutableprotected

use the proxy-iterator or just the proxy ?

Definition at line 118 of file DataHandleBase.h.

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

Public Types

Public Member Functions

validity checks

Detailed Description

Member Typedef Documentation

◆ ID_type

Constructor & Destructor Documentation

◆ DataHandleBase() [1/4]

◆ DataHandleBase() [2/4]

◆ DataHandleBase() [3/4]

◆ DataHandleBase() [4/4]

◆ ~DataHandleBase()

Member Function Documentation

◆ clid()

◆ finalReset()

◆ ID()

◆ isConst()

◆ isInitialized()

◆ isSet()

◆ key()

◆ operator=()

◆ reset()

◆ setState() [1/5]

◆ setState() [2/5]

◆ setState() [3/5]

◆ setState() [4/5]

◆ setState() [5/5]

Member Data Documentation

◆ m_itr

◆ m_itrEnd

◆ m_proxy

◆ m_useItr