DataObjectReadHandle< T > Class Template Reference

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

Inheritance diagram for DataObjectReadHandle< T >:

Collaboration diagram for DataObjectReadHandle< T >:

Public Member Functions
	DataObjectReadHandle (const DataObjID &k, IDataHandleHolder *owner)
template<std::derived_from< IProperty > OWNER, typename K>
	DataObjectReadHandle (OWNER *owner, std::string propertyName, K key={}, std::string doc="")
	Autodeclaring constructor with property name, mode, key and documentation.
template<typename... Args>
	DataObjectReadHandle (std::tuple< Args... > &&args)
Public Member Functions inherited from DataObjectHandle< Payload_t< Gaudi::DataHandle::Reader, T, U > >
T *	get () const
	Retrieve object from transient data store.
T *	getIfExists () const
	Bypass check of existence of object in transient store Only uses main location of the.
bool	exist () const
	Check the existence of the object in the transient store.
T *	getOrCreate () const
	Get object from store or create a new one if it doesn't exist.
T *	put (std::unique_ptr< T > object) const
	Register object in transient store.
std::string	pythonRepr () const override
	DataObjectHandleBase (DataObjID k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	DataObjectHandleBase (std::string k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	DataObjectHandleBase (const DataObjectHandleBase &)=delete
	DataObjectHandleBase (DataObjectHandleBase &&)
	DataObjectHandleBase (OWNER *owner, Gaudi::DataHandle::Mode m, std::string name, K key={}, std::string doc="")
	Autodeclaring constructor with property name, mode, key and documentation.
T *	get () const
	Retrieve object from transient data store.
T *	getIfExists () const
	Bypass check of existence of object in transient store Only uses main location of the.
bool	exist () const
	Check the existence of the object in the transient store.
T *	getOrCreate () const
	Get object from store or create a new one if it doesn't exist.
T *	put (std::unique_ptr< T > object) const
	Register object in transient store.
std::string	pythonRepr () const override
	DataObjectHandleBase (DataObjID k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	DataObjectHandleBase (std::string k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	DataObjectHandleBase (const DataObjectHandleBase &)=delete
	DataObjectHandleBase (DataObjectHandleBase &&)
	DataObjectHandleBase (OWNER *owner, Gaudi::DataHandle::Mode m, std::string name, K key={}, std::string doc="")
	Autodeclaring constructor with property name, mode, key and documentation.
Public Member Functions inherited from DataObjectHandleBase
	DataObjectHandleBase (DataObjID k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	DataObjectHandleBase (std::string k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
	~DataObjectHandleBase () override
	DataObjectHandleBase (const DataObjectHandleBase &)=delete
	DataObjectHandleBase (DataObjectHandleBase &&)
DataObjectHandleBase &	operator= (const DataObjectHandleBase &)
template<std::derived_from< IProperty > OWNER, class K>
	DataObjectHandleBase (OWNER *owner, Gaudi::DataHandle::Mode m, std::string name, K key={}, std::string doc="")
	Autodeclaring constructor with property name, mode, key and documentation.
bool	isOptional () const
	Check if the data object declared is optional for the algorithm.
void	setOptional (bool optional=true)
bool	isValid () const
Public Member Functions inherited from Gaudi::DataHandle
	DataHandle (DataObjID k, Mode a=Reader, IDataHandleHolder *owner=nullptr)
	DataHandle (DataObjID k, 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 (DataObjID key)
virtual void	updateKey (std::string key)
virtual const std::string &	objKey () const
virtual const DataObjID &	fullKey () const
virtual void	reset (bool)
virtual bool	isCondition () const

Private Member Functions
template<typename... Args, std::size_t... Is>
	DataObjectReadHandle (std::tuple< Args... > &&args, std::index_sequence< Is... >)

Additional Inherited Members
Public Types inherited from Gaudi::DataHandle
enum	Mode { Reader = 1 << 2 , Writer = 1 << 4 }
using	PropertyType = DataHandleProperty
Protected Member Functions inherited from DataObjectHandleBase
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
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.
IDataHandleHolder *	m_owner = nullptr
Static Protected Attributes inherited from Gaudi::DataHandle
static const std::string	default_type = "unknown_t"

Detailed Description

template<typename T>
class DataObjectReadHandle< T >

Definition at line 442 of file DataObjectHandle.h.

Constructor & Destructor Documentation

DataObjectReadHandle() [1/4]

template<typename T>

template<typename... Args, std::size_t... Is>

DataObjectReadHandle< T >::DataObjectReadHandle ( std::tuple< Args... > && args, std::index_sequence< Is... >  )

inlineprivate

Definition at line 444 of file DataObjectHandle.h.

      : DataObjectReadHandle( std::get<Is>( std::move( args ) )... ) {}

DataObjectReadHandle() [2/4]

template<typename T>

DataObjectReadHandle< T >::DataObjectReadHandle ( const DataObjID & k, IDataHandleHolder * owner )

inline

Definition at line 448 of file DataObjectHandle.h.

      : ::details::ReadHandle<T>{ k, Gaudi::DataHandle::Reader, owner } {}

DataObjectReadHandle() [3/4]

template<typename T>

template<std::derived_from< IProperty > OWNER, typename K>

DataObjectReadHandle< T >::DataObjectReadHandle ( OWNER * owner, std::string propertyName, K key = {}, std::string doc = "" )

inline

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

Note

the use of requires is required to avoid ambiguities

Definition at line 454 of file DataObjectHandle.h.

                                                                      {}, std::string doc = "" )
      : ::details::ReadHandle<T>( owner, Gaudi::DataHandle::Reader, std::move( propertyName ), std::move( key ),
                                  std::move( doc ) ) {}

DataObjectReadHandle() [4/4]

template<typename T>

template<typename... Args>

DataObjectReadHandle< T >::DataObjectReadHandle ( std::tuple< Args... > && args )

inline

Definition at line 459 of file DataObjectHandle.h.

      : DataObjectReadHandle( std::move( args ), std::index_sequence_for<Args...>{} ) {}

---

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

• GaudiKernel/include/GaudiKernel/DataObjectHandle.h