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

#include <GaudiKernel/AlgTool.h>

Inheritance diagram for DataObjectHandle< T >:

[legend]

Collaboration diagram for DataObjectHandle< T >:

[legend]

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 ()
	Get object from store or create a new one if it doesn't exist. More...

T *	put (T *object)
	Register object in transient store. 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 = typename std::enable_if<std::is_base_of<IProperty, OWNER>::value>::type>
	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 StatusCode	commit ()

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

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

Member Function Documentation

template<typename T>

bool DataObjectHandle< T >::exist ( ) const

inline

Check the existence of the object in the transient store.

Definition at line 47 of file DataObjectHandle.h.

47 { return get( false ) != nullptr; }

template<typename T>

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

inline

Retrieve object from transient data store.

Definition at line 36 of file DataObjectHandle.h.

36 { return get( true ); }

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 115 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 ) ) { // Check type compatibility once
 
     T* obj     = dynamic_cast<T*>( dataObj );
     m_goodType = ( obj != nullptr );
 
     if ( UNLIKELY( !m_goodType ) ) {
 
       std::string errorMsg( "The type provided for " + objKey() + " is " + System::typeinfoName( typeid( T ) ) +
                             " and is different from the one of the object in the store." );
       // log << MSG::ERROR << errorMsg << endmsg;
       throw GaudiException( errorMsg, "Wrong DataObjectType", StatusCode::FAILURE );
     }
     // log << MSG::DEBUG <<  "The data type (" <<  typeid(T).name()
     //    << ") specified for the handle of " << dataProductName()
     //    << " is the same of the object in the store. "
     //    << "From now on the result of a static_cast will be returned." << endmsg;
     return obj;
   }
 
   //  setRead();
   // From the second read on, this is safe
   return static_cast<T*>( dataObj );
 }

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 42 of file DataObjectHandle.h.

42 { return get( false ); }

template<typename T >

T * DataObjectHandle< T >::getOrCreate ( )

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

Definition at line 166 of file DataObjectHandle.h.

 {
 
   // this process needs to be locking for multi-threaded applications
   // lock(); --> done in caller
 
   T* obj = get( false );
 
   // object exists, we are done
   if ( obj ) {
     // unlock();
     return obj;
   }
 
   // create it
   return put( new T{} );
 
   // unlock();
 }

template<typename T>

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

Register object in transient store.

Definition at line 154 of file DataObjectHandle.h.

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

Member Data Documentation

template<typename T>

bool DataObjectHandle< T >::m_goodType = false

mutableprivate

Definition at line 61 of file DataObjectHandle.h.

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<typename T> class DataObjectHandle< T >

Member Function Documentation

Member Data Documentation

template<typename T>
class DataObjectHandle< T >