The Gaudi Framework  v30r4 (9b837755)
Gaudi::EventReadHandle< T > Class Template Reference

Reentrant read handle for event data. More...

#include <GaudiKernel/EventDataHandle.h>

Inheritance diagram for Gaudi::EventReadHandle< T >:
Collaboration diagram for Gaudi::EventReadHandle< T >:

Public Member Functions

template<typename Owner >
 EventReadHandle (Owner *owner, const std::string &propertyName, DataObjID defaultID, const std::string &docString="")
 Create a ReadHandle and set up the associated Gaudi property. More...
 
- Public Member Functions inherited from Gaudi::EventDataHandle
void initialize (const IDataHandleHolder &owner) final override
 Initialize the data handle. More...
 
- Public Member Functions inherited from Gaudi::v2::DataHandle
 DataHandle (const DataHandle &)=delete
 
DataHandleoperator= (const DataHandle &)=delete
 
 DataHandle (DataHandle &&)=default
 
DataHandleoperator= (DataHandle &&)=delete
 
AccessMode access () const
 
const DataObjIDtargetKey () const
 (Configurable) ID of the data being accessed via this handle More...
 
void setTargetKey (const DataObjID &id)
 Change the ID of the target data. More...
 
bool ownerSetupDone () const
 Truth that owner setup has been performed. More...
 
template<typename Owner , std::enable_if_t< std::is_base_of< IDataHandleHolder, Owner >::value > * = nullptr>
void setOwner (Owner &owner)
 Setup the owner of this DataHandle. More...
 

Protected Types

using AccessMode = DataHandle::AccessMode
 
- Protected Types inherited from Gaudi::EventDataHandle
using AccessMode = DataHandle::AccessMode
 

Additional Inherited Members

- Public Types inherited from Gaudi::v2::DataHandle
using AccessMode = IDataHandleMetadata::AccessMode
 
- Protected Member Functions inherited from Gaudi::EventDataHandle
template<typename Owner >
 EventDataHandle (Owner &owner, const std::string &propertyName, DataObjID &&defaultID, const std::string &docString, const Metadata &metadata)
 Handles are constructed like a Gaudi property (and effectively behave as one, which sets the associated data object identifier) More...
 
- Protected Member Functions inherited from Gaudi::v2::DataHandle
template<typename Owner , typename T = DataObjID, std::enable_if_t< std::is_base_of< IDataHandleHolder, Owner >::value > * = nullptr>
 DataHandle (Owner &owner, const std::string &propertyName, T &&defaultID, const std::string &docString, const IDataHandleMetadata &metadata)
 Handles are constructed like a Gaudi property (and effectively behave as one, which sets the associated data object identifier) More...
 
template<typename T = DataObjID>
 DataHandle (const std::string &propertyName, T &&defaultID, const std::string &docString, const IDataHandleMetadata &metadata)
 The above constructor is easier to use correctly, and therefore preferred. More...
 
- Protected Attributes inherited from Gaudi::EventDataHandle
IDataProviderSvcm_whiteBoard = nullptr
 Pointer to the whiteboard, set during initialize() More...
 
- Static Protected Attributes inherited from Gaudi::EventDataHandle
static const Metadata s_readHandleMetadata
 
static const Metadata s_writeHandleMetadata
 

Detailed Description

template<typename T>
class Gaudi::EventReadHandle< T >

Reentrant read handle for event data.

Definition at line 82 of file EventDataHandle.h.

Member Typedef Documentation

template<typename T >
using Gaudi::EventReadHandle< T >::AccessMode = DataHandle::AccessMode
protected

Definition at line 85 of file EventDataHandle.h.

Constructor & Destructor Documentation

template<typename T >
template<typename Owner >
Gaudi::EventReadHandle< T >::EventReadHandle ( Owner *  owner,
const std::string propertyName,
DataObjID  defaultID,
const std::string docString = "" 
)
inline

Create a ReadHandle and set up the associated Gaudi property.

Definition at line 90 of file EventDataHandle.h.

92  : EventDataHandle{*owner, propertyName, std::move( defaultID ), docString, s_readHandleMetadata}
93  {
94  }
static const Metadata s_readHandleMetadata
EventDataHandle(Owner &owner, const std::string &propertyName, DataObjID &&defaultID, const std::string &docString, const Metadata &metadata)
Handles are constructed like a Gaudi property (and effectively behave as one, which sets the associat...
T move(T...args)

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