DataObjectHandle< T > Class Template Reference

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

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/AlgTool.h>

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

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

Private Attributes
bool	m_goodType = false

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 36 of file AlgTool.h.

Member Function Documentation

DataObjectHandleBase() [1/5]

template<typename T >

DataObjectHandleBase::DataObjectHandleBase

delete

DataObjectHandleBase() [2/5]

template<typename T >

DataObjectHandleBase::DataObjectHandleBase

Definition at line 38 of file DataObjectHandleBase.cpp.

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

DataObjectHandleBase() [3/5]

template<typename T >

DataObjectHandleBase::DataObjectHandleBase

Definition at line 39 of file DataObjectHandleBase.cpp.

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

DataObjectHandleBase() [4/5]

template<typename T >

DataObjectHandleBase::DataObjectHandleBase

Definition at line 43 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 49 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 123 of file DataObjectHandle.h.

{ return get( false ) != nullptr; }

get() [1/2]

template<typename ValueType >

auto DataObjectHandle< ValueType >::get

inline

Retrieve object from transient data store.

Definition at line 112 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 160 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 118 of file DataObjectHandle.h.

{ return get( false ); }

getOrCreate()

template<typename T >

T * DataObjectHandle< T >::getOrCreate

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

Definition at line 184 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 175 of file DataObjectHandle.h.

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

put() [2/2]

template<typename T >

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

inline

Definition at line 135 of file DataObjectHandle.h.

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

pythonRepr()

template<typename T >

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

inlineoverride

Definition at line 139 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 147 of file DataObjectHandle.h.

---

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

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