DataObjectHandle< T > Class Template Reference

DataObjectHandle.h GaudiKernel/DataObjectHandle.h. More...

#include <GaudiKernel/AlgTool.h>

Inheritance diagram for DataObjectHandle< T >:

Collaboration diagram for DataObjectHandle< T >:

Public Member Functions
T *	get () const
	Retrieve object from transient data store. More...
T *	getIfExists () const
	Bypass check of existence of object in transient store Only uses main location of the. More...
bool	exist () const
	Check the existence of the object in the transient store. More...
T *	getOrCreate () const
	Get object from store or create a new one if it doesn't exist. More...
T *	put (std::unique_ptr< T > object) const
	Register object in transient store. More...
T *	put (T *object) const
std::string	pythonRepr () const override
	DataObjectHandleBase (const DataObjID &k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	DataObjectHandleBase (const std::string &k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	DataObjectHandleBase (const DataObjectHandleBase &)=delete
	DataObjectHandleBase (DataObjectHandleBase &&)
template<class OWNER , class K , typename = std::enable_if_t<std::is_base_of_v<IProperty, OWNER>>>
	DataObjectHandleBase (OWNER *owner, Gaudi::DataHandle::Mode m, std::string name, const K &key={}, std::string doc="")
	Autodeclaring constructor with property name, mode, key and documentation. More...
Public Member Functions inherited from DataObjectHandleBase
	DataObjectHandleBase (const DataObjID &k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	DataObjectHandleBase (const std::string &k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
virtual	~DataObjectHandleBase ()
	DataObjectHandleBase (const DataObjectHandleBase &)=delete
	DataObjectHandleBase (DataObjectHandleBase &&)
DataObjectHandleBase &	operator= (const DataObjectHandleBase &)
template<class OWNER , class K , typename = std::enable_if_t<std::is_base_of_v<IProperty, OWNER>>>
	DataObjectHandleBase (OWNER *owner, Gaudi::DataHandle::Mode m, std::string name, const K &key={}, std::string doc="")
	Autodeclaring constructor with property name, mode, key and documentation. More...
std::string	toString () const
std::string	pythonRepr () const override
void	fromString (const std::string &s)
bool	isOptional () const
	Check if the data object declared is optional for the algorithm. More...
void	setOptional (bool optional=true)
bool	initialized () const
bool	wasRead () const
bool	wasWritten () const
bool	isValid () const
Public Member Functions inherited from Gaudi::DataHandle
	DataHandle (const DataObjID &k, Mode a=Reader, IDataHandleHolder *owner=nullptr)
	DataHandle (const DataObjID &k, const bool &isCond, Mode a=Reader, IDataHandleHolder *owner=nullptr)
virtual	~DataHandle ()=default
virtual void	setOwner (IDataHandleHolder *o)
virtual IDataHandleHolder *	owner () const
virtual Mode	mode () const
virtual void	setKey (const DataObjID &key) const
virtual void	updateKey (const std::string &key) const
virtual const std::string &	objKey () const
virtual const DataObjID &	fullKey () const
virtual void	reset (bool)
virtual bool	isCondition () const

Private Member Functions
T *	get (bool mustExist) const
	Try to retrieve from the transient store. More...

Private Attributes
bool	m_goodType = false

Additional Inherited Members
Public Types inherited from DataObjectHandleBase
using	PropertyType = DataObjectHandleProperty
Public Types inherited from Gaudi::DataHandle
enum	Mode { Reader = 1 << 2, Writer = 1 << 4, Updater = Reader | Writer }
Protected Member Functions inherited from DataObjectHandleBase
void	setRead (bool wasRead=true)
void	setWritten (bool wasWritten=true)
bool	init () override
DataObject *	fetch () const
Protected Attributes inherited from DataObjectHandleBase
SmartIF< IDataProviderSvc >	m_EDS
SmartIF< IMessageSvc >	m_MS
bool	m_init = false
bool	m_optional = false
bool	m_wasRead = false
bool	m_wasWritten = false
bool	m_searchDone = false
	Whether the search part of the fetch method (so dealing with alt names was already executed or not. More...
std::mutex	m_searchMutex
	A Mutex protecting the calls to the search part of the fetch method, so that we are sure that we only call it once. More...
Protected Attributes inherited from Gaudi::DataHandle
DataObjID	m_key = {"NONE"}
	The key of the object behind this DataHandle Although it may look strange to have it mutable, this can actually change in case the object had alternative names, and it should not be visible to the end user, for which the Handle is still the same. More...
IDataHandleHolder *	m_owner = nullptr
Static Protected Attributes inherited from DataObjectHandleBase
static const std::string	default_type = "unknown_t"

Detailed Description

template<typename T>
class DataObjectHandle< T >

DataObjectHandle.h GaudiKernel/DataObjectHandle.h.

Templated Handle class for objects in the event store

Inheritance: DataHandle->DataObjectHandleBase->DataObjectHandle<T>

Author

Charles Leggett

Date

2015-09-01

Definition at line 26 of file AlgTool.h.

Member Function Documentation

DataObjectHandleBase() [1/5]

template<typename T>

DataObjectHandleBase::DataObjectHandleBase

Definition at line 47 of file DataObjectHandleBase.cpp.

    : Gaudi::DataHandle( k, a, owner ) {
  m_owner->declare( *this );
}

DataObjectHandleBase() [2/5]

template<typename T>

DataObjectHandleBase::DataObjectHandleBase

Definition at line 54 of file DataObjectHandleBase.cpp.

    : DataObjectHandleBase( DataObjID( k ), a, owner ) {}

DataObjectHandleBase() [3/5]

template<typename T>

DataObjectHandleBase::DataObjectHandleBase

delete

DataObjectHandleBase() [4/5]

template<typename T>

DataObjectHandleBase::DataObjectHandleBase

Definition at line 18 of file DataObjectHandleBase.cpp.

    : Gaudi::DataHandle( other )
    , m_EDS( std::move( other.m_EDS ) )
    , m_MS( std::move( other.m_MS ) )
    , m_init( other.m_init )
    , m_optional( other.m_optional )
    , m_wasRead( other.m_wasRead )
    , m_wasWritten( other.m_wasWritten )
    , m_searchDone( other.m_searchDone ) {
  m_owner->declare( *this );
}

DataObjectHandleBase() [5/5]

template<typename T>

template<class OWNER , class K , typename = std::enable_if_t<std::is_base_of_v<IProperty, OWNER>>>

DataObjectHandleBase::DataObjectHandleBase ( class OWNER  , class K  , typename  = std::enable_if_t<std::is_base_of_v<IProperty, OWNER>>  )

inline

Autodeclaring constructor with property name, mode, key and documentation.

Note

the use std::enable_if is required to avoid ambiguities

Definition at line 40 of file DataObjectHandleBase.h.

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

exist()

template<typename T>

bool DataObjectHandle< T >::exist ( ) const

inline

Check the existence of the object in the transient store.

Definition at line 109 of file DataObjectHandle.h.

{ return get( false ) != nullptr; }

get() [1/2]

template<typename ValueType >

auto DataObjectHandle< ValueType >::get ( ) const

inline

Retrieve object from transient data store.

Definition at line 98 of file DataObjectHandle.h.

{ return get( true ); }

get() [2/2]

template<typename T >

T * DataObjectHandle< T >::get ( bool  mustExist ) const

private

Try to retrieve from the transient store.

If the retrieval succeded and this is the first time we retrieve, perform a dynamic cast to the desired object. Then finally set the handle as Read. If this is not the first time we cast and the cast worked, just use the static cast: we do not need the checks of the dynamic cast for every access!

Definition at line 145 of file DataObjectHandle.h.

                                                  {
  auto dataObj = fetch();
  if ( UNLIKELY( !dataObj ) ) {
    if ( mustExist ) { // Problems in getting from the store
      throw GaudiException( "Cannot retrieve " + objKey() + " from transient store.",
                            m_owner ? owner()->name() : "no owner", StatusCode::FAILURE );
    }
    return nullptr;
  }
  if ( UNLIKELY( !m_goodType ) ) m_goodType = ::details::verifyType<T>( dataObj );
  return static_cast<T*>( dataObj );
}

getIfExists()

template<typename T>

T* DataObjectHandle< T >::getIfExists ( ) const

inline

Bypass check of existence of object in transient store Only uses main location of the.

Definition at line 104 of file DataObjectHandle.h.

{ return get( false ); }

getOrCreate()

template<typename T >

T * DataObjectHandle< T >::getOrCreate

(

)

const

Get object from store or create a new one if it doesn't exist.

Definition at line 171 of file DataObjectHandle.h.

                                          {
  T* obj = get( false );
  return obj ? obj : put( std::make_unique<T>() );
}

put() [1/2]

template<typename T>

T * DataObjectHandle< T >::put

(

std::unique_ptr< T >

object

)

const

Register object in transient store.

Definition at line 160 of file DataObjectHandle.h.

                                                            {
  assert( m_init );
  StatusCode rc = m_EDS->registerObject( objKey(), objectp.get() );
  if ( !rc.isSuccess() ) {
    throw GaudiException( "Error in put of " + objKey(), "DataObjectHandle<T>::put", StatusCode::FAILURE );
  }
  return objectp.release();
}

put() [2/2]

template<typename T>

T* DataObjectHandle< T >::put ( T *  object ) const

inline

Definition at line 122 of file DataObjectHandle.h.

{ return put( std::unique_ptr<T>( object ) ); }

pythonRepr()

template<typename T>

std::string DataObjectHandle< T >::pythonRepr ( ) const

inlineoverridevirtual

Reimplemented from Gaudi::DataHandle.

Definition at line 124 of file DataObjectHandle.h.

                                        {
    auto repr = DataObjectHandleBase::pythonRepr();
    boost::replace_all( repr, default_type, System::typeinfoName( typeid( T ) ) );
    return repr;
  }

Member Data Documentation

m_goodType

template<typename T>

bool DataObjectHandle< T >::m_goodType = false

mutableprivate

Definition at line 132 of file DataObjectHandle.h.

---

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

• GaudiKernel/GaudiKernel/AlgTool.h
• GaudiKernel/GaudiKernel/DataObjectHandle.h