Gaudi::DataHandle Class Reference

#include <GaudiKernel/DataHandle.h>

Inheritance diagram for Gaudi::DataHandle:

Collaboration diagram for Gaudi::DataHandle:

Public Types
enum	Mode { Reader = 1<<2, Writer = 1<<4, Updater = Reader | Writer }

Public Member Functions
	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 std::string	pythonRepr () const
virtual bool	init ()
virtual bool	isCondition () const

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

Private Attributes
Mode	m_mode = Reader
bool	m_isCond = false

Detailed Description

Definition at line 27 of file DataHandle.h.

Member Enumeration Documentation

enum Gaudi::DataHandle::Mode

Enumerator
Reader
Writer
Updater

Definition at line 30 of file DataHandle.h.

            {
    Reader = 1<<2,
    Writer = 1<<4,
    Updater = Reader | Writer
  };

Constructor & Destructor Documentation

Gaudi::DataHandle::DataHandle ( const DataObjID &  k, Mode  a = Reader, IDataHandleHolder *  owner = nullptr  )

inline

Definition at line 37 of file DataHandle.h.

                                          :
    m_key(k), m_owner(owner), m_mode(a) {};

Gaudi::DataHandle::DataHandle ( const DataObjID &  k, const bool &  isCond, Mode  a = Reader, IDataHandleHolder *  owner = nullptr  )

inline

Definition at line 41 of file DataHandle.h.

                                          :
    m_key(k), m_owner(owner), m_mode(a), m_isCond(isCond) {};

virtual Gaudi::DataHandle::~DataHandle ( )

virtualdefault

Member Function Documentation

virtual StatusCode Gaudi::DataHandle::commit ( )

inlinevirtual

Definition at line 60 of file DataHandle.h.

{ return StatusCode::SUCCESS; }

virtual const DataObjID& Gaudi::DataHandle::fullKey ( ) const

inlinevirtual

Definition at line 57 of file DataHandle.h.

{ return m_key; }

virtual bool Gaudi::DataHandle::init ( )

inlinevirtual

Reimplemented in DataObjectHandleBase.

Definition at line 63 of file DataHandle.h.

{ return true; }

virtual bool Gaudi::DataHandle::isCondition ( ) const

inlinevirtual

Definition at line 66 of file DataHandle.h.

{ return m_isCond; }

virtual Mode Gaudi::DataHandle::mode ( ) const

inlinevirtual

Definition at line 51 of file DataHandle.h.

{ return m_mode; }

virtual const std::string& Gaudi::DataHandle::objKey ( ) const

inlinevirtual

Definition at line 56 of file DataHandle.h.

{ return m_key.key(); }

virtual IDataHandleHolder* Gaudi::DataHandle::owner ( ) const

inlinevirtual

Definition at line 49 of file DataHandle.h.

{ return m_owner; }

std::string Gaudi::DataHandle::pythonRepr ( ) const

virtual

Reimplemented in DataObjectHandleBase.

Definition at line 10 of file DataHandle.cpp.

                               {
    std::ostringstream ost;
    ost << "DataHandle(\""  << fullKey()  <<  "||"
        << std::to_string(mode()) <<  "\")";
    return ost.str();
  }

virtual void Gaudi::DataHandle::reset ( bool  )

inlinevirtual

Definition at line 59 of file DataHandle.h.

{};

virtual void Gaudi::DataHandle::setKey ( const DataObjID &  key ) const

inlinevirtual

Definition at line 53 of file DataHandle.h.

{ m_key = key; }

virtual void Gaudi::DataHandle::setOwner ( IDataHandleHolder *  o )

inlinevirtual

Definition at line 48 of file DataHandle.h.

{ m_owner = o; }

virtual void Gaudi::DataHandle::updateKey ( const std::string &  key ) const

inlinevirtual

Definition at line 54 of file DataHandle.h.

{ m_key.updateKey(key); }

Member Data Documentation

bool Gaudi::DataHandle::m_isCond = false

private

Definition at line 81 of file DataHandle.h.

DataObjID Gaudi::DataHandle::m_key = { "NONE" }

mutableprotected

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.

Definition at line 76 of file DataHandle.h.

Mode Gaudi::DataHandle::m_mode = Reader

private

Definition at line 80 of file DataHandle.h.

IDataHandleHolder* Gaudi::DataHandle::m_owner = nullptr

protected

Definition at line 77 of file DataHandle.h.

---

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

• GaudiKernel/GaudiKernel/DataHandle.h
• GaudiKernel/src/Lib/DataHandle.cpp