Gaudi::DataHandle Class Reference

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

Inheritance diagram for Gaudi::DataHandle:

Collaboration diagram for Gaudi::DataHandle:

Public Types
enum	Mode { Reader = 1 << 2 , Writer = 1 << 4 }
using	PropertyType = DataHandleProperty

Public Member Functions
	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 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.
IDataHandleHolder *	m_owner = nullptr

Static Protected Attributes
static const std::string	default_type = "unknown_t"

Private Attributes
Mode	m_mode = Reader
bool	m_isCond = false

Friends
std::ostream &	operator<< (std::ostream &str, const DataHandle &d)

Detailed Description

Definition at line 43 of file DataHandle.h.

Member Typedef Documentation

PropertyType

using Gaudi::DataHandle::PropertyType = DataHandleProperty

Definition at line 53 of file DataHandle.h.

Member Enumeration Documentation

Mode

enum Gaudi::DataHandle::Mode

Enumerator
Reader
Writer

Definition at line 45 of file DataHandle.h.

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

Constructor & Destructor Documentation

DataHandle() [1/2]

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

inline

Definition at line 47 of file DataHandle.h.

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

DataHandle() [2/2]

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

inline

Definition at line 50 of file DataHandle.h.

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

~DataHandle()

virtual Gaudi::DataHandle::~DataHandle ( )

virtualdefault

Member Function Documentation

fullKey()

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

inlinevirtual

Definition at line 66 of file DataHandle.h.

{ return m_key; }

init()

virtual bool Gaudi::DataHandle::init ( )

inlinevirtual

Reimplemented in DataObjectHandleBase.

Definition at line 71 of file DataHandle.h.

{ return true; }

isCondition()

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

inlinevirtual

Definition at line 74 of file DataHandle.h.

{ return m_isCond; }

mode()

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

inlinevirtual

Definition at line 60 of file DataHandle.h.

{ return m_mode; }

objKey()

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

inlinevirtual

Definition at line 65 of file DataHandle.h.

{ return m_key.key(); }

owner()

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

inlinevirtual

Definition at line 58 of file DataHandle.h.

{ return m_owner; }

pythonRepr()

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

virtual

Reimplemented in DataObjectHandle< T >, DataObjectHandle< AnyDataWithViewWrapper< View, Owned > >, DataObjectHandle< AnyDataWrapper< T > >, DataObjectHandle< DataObject >, DataObjectHandle< Gaudi::NamedRange_< T > >, DataObjectHandle< Gaudi::Range_< T > >, DataObjectHandle< Payload_t< Gaudi::DataHandle::Reader, T, U > >, DataObjectHandle< Payload_t< Gaudi::DataHandle::Writer, T, U > >, and DataObjectHandle< std::optional< Gaudi::NamedRange_< T > > >.

Definition at line 19 of file DataHandle.cpp.

                                         {
    std::ostringstream ost;
    ost << "DataHandle(" << fullKey() << ", '";
    switch ( mode() ) {
    case DataHandle::Mode::Reader:
      ost << "R";
      break;
    case DataHandle::Mode::Writer:
      ost << "W";
      break;
    default:
      ost << "UNKNOWN";
      break;
    }
    ost << "', '" + default_type + "')";
    return ost.str();
  }

reset()

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

inlinevirtual

Definition at line 68 of file DataHandle.h.

{}

setKey()

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

inlinevirtual

Definition at line 62 of file DataHandle.h.

{ m_key = std::move( key ); }

setOwner()

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

inlinevirtual

Definition at line 57 of file DataHandle.h.

{ m_owner = o; }

updateKey()

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

inlinevirtual

Definition at line 63 of file DataHandle.h.

{ m_key.updateKey( std::move( key ) ); }

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & str, const DataHandle & d )

friend

Definition at line 72 of file DataHandle.cpp.

                                                                 {
    str << d.fullKey() << "  m: " << d.mode();
    if ( d.owner() ) str << "  o: " << d.owner()->name();
    return str;
  }

Member Data Documentation

default_type

std::string const Gaudi::DataHandle::default_type = "unknown_t"

staticprotected

Definition at line 88 of file DataHandle.h.

m_isCond

bool Gaudi::DataHandle::m_isCond = false

private

Definition at line 92 of file DataHandle.h.

m_key

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

protected

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 85 of file DataHandle.h.

{ "NONE" };

m_mode

Mode Gaudi::DataHandle::m_mode = Reader

private

Definition at line 91 of file DataHandle.h.

m_owner

IDataHandleHolder* Gaudi::DataHandle::m_owner = nullptr

protected

Definition at line 86 of file DataHandle.h.

---

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

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