The Gaudi Framework  v30r3 (a5ef0a68)
DataObjectWriteHandle< T > Class Template Reference

#include <GaudiKernel/DataObjectHandle.h>

Inheritance diagram for DataObjectWriteHandle< T >:
Collaboration diagram for DataObjectWriteHandle< T >:

Public Member Functions

 DataObjectWriteHandle (const DataObjID &k, IDataHandleHolder *owner)
 
- Public Member Functions inherited from DataObjectHandle< details::Payload_t< T > >
details::Payload_t< T > * get () const
 Retrieve object from transient data store. More...
 
details::Payload_t< 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...
 
details::Payload_t< T > * getOrCreate ()
 Get object from store or create a new one if it doesn't exist. More...
 
details::Payload_t< T > * put (std::unique_ptr< details::Payload_t< T > > object)
 Register object in transient store. More...
 
details::Payload_t< T > * put (details::Payload_t< T > *object)
 
- 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 &&)
 
DataObjectHandleBaseoperator= (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 IDataHandleHolderowner () const
 
virtual Mode mode () const
 
virtual void setKey (const DataObjID &key) const
 
virtual void updateKey (const std::string &key) const
 
virtual const std::stringobjKey () const
 
virtual const DataObjIDfullKey () const
 
virtual void reset (bool)
 
virtual bool isCondition () const
 

Private Member Functions

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

Additional Inherited Members

- Public Types inherited from DataObjectHandleBase
using PropertyType = DataObjectHandleProperty
 
- 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
 
DataObjectfetch () const
 
- Protected Attributes inherited from DataObjectHandleBase
SmartIF< IDataProviderSvcm_EDS
 
SmartIF< IMessageSvcm_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...
 
IDataHandleHolderm_owner = nullptr
 

Detailed Description

template<typename T>
class DataObjectWriteHandle< T >

Definition at line 305 of file DataObjectHandle.h.

Constructor & Destructor Documentation

template<typename T >
template<typename... Args, std::size_t... Is>
DataObjectWriteHandle< T >::DataObjectWriteHandle ( const std::tuple< Args... > &  args,
std::index_sequence< Is... >   
)
inlineprivate

Definition at line 308 of file DataObjectHandle.h.

309  : DataObjectWriteHandle( std::get<Is>( args )... )
310  {
311  }
DataObjectWriteHandle(const std::tuple< Args... > &args, std::index_sequence< Is... >)
template<typename T >
DataObjectWriteHandle< T >::DataObjectWriteHandle ( const DataObjID k,
IDataHandleHolder owner 
)
inline

Definition at line 314 of file DataObjectHandle.h.

DataObjectHandle.h GaudiKernel/DataObjectHandle.h.
Definition: AlgTool.h:26

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