| The Gaudi Framework v28r2p1 (f1a77ff4)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Types | Public Member Functions | Protected Attributes | Private Attributes | List of all members
Gaudi::DataHandle Class Reference

`#include <GaudiKernel/DataHandle.h>`

Inheritance diagram for Gaudi::DataHandle:
[legend]
Collaboration diagram for Gaudi::DataHandle:
[legend]

## 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.

30 {
31 Reader = 1<<2,
32 Writer = 1<<4,
33 Updater = Reader | Writer
34 };
Gaudi::DataHandle::Reader
Definition: DataHandle.h:31
Gaudi::DataHandle::Writer
Definition: DataHandle.h:32
Gaudi::DataHandle::Updater
Definition: DataHandle.h:33

## Constructor & Destructor Documentation

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

Definition at line 37 of file DataHandle.h.

38 :
39 m_key(k), m_owner(owner), m_mode(a) {};
Gaudi::DataHandle::m_mode
Mode m_mode
Definition: DataHandle.h:80
Gaudi::DataHandle::m_key
DataObjID m_key
The key of the object behind this DataHandle Although it may look strange to have it mutable...
Definition: DataHandle.h:76
Gaudi::DataHandle::m_owner
IDataHandleHolder * m_owner
Definition: DataHandle.h:77

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

Definition at line 41 of file DataHandle.h.

42 :
43 m_key(k), m_owner(owner), m_mode(a), m_isCond(isCond) {};
Gaudi::DataHandle::m_mode
Mode m_mode
Definition: DataHandle.h:80
Gaudi::DataHandle::m_key
DataObjID m_key
The key of the object behind this DataHandle Although it may look strange to have it mutable...
Definition: DataHandle.h:76
Gaudi::DataHandle::m_owner
IDataHandleHolder * m_owner
Definition: DataHandle.h:77
Gaudi::DataHandle::m_isCond
bool m_isCond
Definition: DataHandle.h:81

virtual Gaudi::DataHandle::~DataHandle | ( |  | ) |
| virtual default

## Member Function Documentation

virtual StatusCode Gaudi::DataHandle::commit | ( |  | ) |
| inline virtual

Definition at line 60 of file DataHandle.h.

60 { return StatusCode::SUCCESS; }
StatusCode::SUCCESS
Definition: StatusCode.h:30

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

Definition at line 57 of file DataHandle.h.

57 { return m_key; }
Gaudi::DataHandle::m_key
DataObjID m_key
The key of the object behind this DataHandle Although it may look strange to have it mutable...
Definition: DataHandle.h:76

virtual bool Gaudi::DataHandle::init | ( |  | ) |
| inline virtual

Reimplemented in DataObjectHandleBase.

Definition at line 63 of file DataHandle.h.

63 { return true; }

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

Definition at line 66 of file DataHandle.h.

66 { return m_isCond; }
Gaudi::DataHandle::m_isCond
bool m_isCond
Definition: DataHandle.h:81

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

Definition at line 51 of file DataHandle.h.

51 { return m_mode; }
Gaudi::DataHandle::m_mode
Mode m_mode
Definition: DataHandle.h:80

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

Definition at line 56 of file DataHandle.h.

56 { return m_key.key(); }
Gaudi::DataHandle::m_key
DataObjID m_key
The key of the object behind this DataHandle Although it may look strange to have it mutable...
Definition: DataHandle.h:76
DataObjID::key
const std::string & key() const
Definition: DataObjID.h:49

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

Definition at line 49 of file DataHandle.h.

49 { return m_owner; }
Gaudi::DataHandle::m_owner
IDataHandleHolder * m_owner
Definition: DataHandle.h:77

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

Reimplemented in DataObjectHandleBase.

Definition at line 10 of file DataHandle.cpp.

10 {
11 std::ostringstream ost;
12 ost << "DataHandle(\"" << fullKey() << "||"
13 << std::to_string(mode()) << "\")";
14 return ost.str();
15 }
Gaudi::DataHandle::mode
virtual Mode mode() const
Definition: DataHandle.h:51
std::to_string
T to_string(T...args)
Gaudi::DataHandle::fullKey
virtual const DataObjID & fullKey() const
Definition: DataHandle.h:57
std::ostringstream
STL class.
std::ostringstream::str
T str(T...args)

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

Definition at line 59 of file DataHandle.h.

59 {};

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

Definition at line 53 of file DataHandle.h.

53 { m_key = key; }
Gaudi::DataHandle::m_key
DataObjID m_key
The key of the object behind this DataHandle Although it may look strange to have it mutable...
Definition: DataHandle.h:76

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

Definition at line 48 of file DataHandle.h.

48 { m_owner = o; }
Gaudi::DataHandle::m_owner
IDataHandleHolder * m_owner
Definition: DataHandle.h:77

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

Definition at line 54 of file DataHandle.h.

54 { m_key.updateKey(key); }
DataObjID::updateKey
void updateKey(const std::string &key)
Definition: DataObjID.h:109
Gaudi::DataHandle::m_key
DataObjID m_key
The key of the object behind this DataHandle Although it may look strange to have it mutable...
Definition: DataHandle.h:76

## Member Data Documentation

bool Gaudi::DataHandle::m_isCond = false
| private

Definition at line 81 of file DataHandle.h.

DataObjID Gaudi::DataHandle::m_key = { "NONE" }
| mutable 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 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