Loading [MathJax]/extensions/tex2jax.js
The Gaudi Framework  master (f31105fd)
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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. More...
 
template<typename... Args>
 DataObjectReadHandle (std::tuple< Args... > &&args)
 
- Public Member Functions inherited from DataObjectHandle< T >
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...
 
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 &&)
 
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. More...
 

Private Member Functions

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

Detailed Description

template<typename T>
class DataObjectReadHandle< T >

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

451  : 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 454 of file DataObjectHandle.h.

◆ DataObjectReadHandle() [3/4]

template<typename T >
template<std::derived_from< IProperty > OWNER, typename K >
DataObjectReadHandle< T >::DataObjectReadHandle ( OWNER *  owner,
std::string  propertyName,
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 460 of file DataObjectHandle.h.

460  {}, std::string doc = "" )
462  std::move( doc ) ) {}

◆ DataObjectReadHandle() [4/4]

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

Definition at line 465 of file DataObjectHandle.h.

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

The documentation for this class was generated from the following file:
std::string
STL class.
std::move
T move(T... args)
DataObjectHandle
DataObjectHandle.h GaudiKernel/DataObjectHandle.h.
Definition: AlgTool.h:36
gaudirun.args
args
Definition: gaudirun.py:336
Gaudi::DataHandle::Reader
@ Reader
Definition: DataHandle.h:40
ProduceConsume.key
key
Definition: ProduceConsume.py:84
DataObjectReadHandle::DataObjectReadHandle
DataObjectReadHandle(std::tuple< Args... > &&args, std::index_sequence< Is... >)
Definition: DataObjectHandle.h:450