The Gaudi Framework  master (37c0b60a)
DataHistory Class Reference

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

Inheritance diagram for DataHistory:
Collaboration diagram for DataHistory:

Classes

class  DataHistoryOrder
 

Public Member Functions

 DataHistory (const CLID &id, std::string key, AlgorithmHistory *alg)
 
const CLIDclID () const override
 Retrieve reference to class definition structure. More...
 
const std::stringdataKey () const
 
const CLIDdataClassID () const
 
AlgorithmHistoryalgorithmHistory () const
 
std::ostreamdump (std::ostream &, const bool isXML, int indent) const override
 
- Public Member Functions inherited from HistoryObj
virtual ~HistoryObj ()=default
 
const CLIDclID () const override
 Retrieve reference to class definition structure. More...
 
- Public Member Functions inherited from DataObject
 DataObject ()
 Standard Constructor. More...
 
 DataObject (const DataObject &rhs)
 Copy Constructor. More...
 
DataObjectoperator= (const DataObject &rhs)
 Assignment Operator. More...
 
 DataObject (DataObject &&rhs)
 Move Constructor. More...
 
DataObjectoperator= (DataObject &&rhs)
 Move Assignment Operator. More...
 
virtual ~DataObject ()
 Standard Destructor. More...
 
virtual unsigned long addRef ()
 Add reference to object. More...
 
virtual unsigned long release ()
 release reference to object More...
 
const std::stringname () const
 Retreive DataObject name. It is the name when registered in the store. More...
 
virtual StatusCode update ()
 Provide empty placeholder for internal object reconfiguration callback. More...
 
void setRegistry (IRegistry *pRegistry)
 Set pointer to Registry. More...
 
IRegistryregistry () const
 Get pointer to Registry. More...
 
LinkManagerlinkMgr ()
 Retrieve Link manager. More...
 
const LinkManagerlinkMgr () const
 
unsigned char version () const
 Retrieve version number of this object representation. More...
 
void setVersion (unsigned char vsn)
 Set version number of this object representation. More...
 
unsigned long refCount () const
 Return the refcount. More...
 
virtual std::ostreamfillStream (std::ostream &s) const
 Fill the output stream (ASCII) More...
 

Static Public Member Functions

static const CLIDclassID ()
 
- Static Public Member Functions inherited from HistoryObj
static const CLIDclassID ()
 
static std::string convert_string (const std::string &)
 
- Static Public Member Functions inherited from DataObject
static const CLIDclassID ()
 Retrieve reference to class definition structure (static access) More...
 

Private Attributes

CLID m_dataClassID
 
std::string m_dataKey
 
AlgorithmHistorym_algHist
 
std::string m_dummy = "none"
 

Friends

std::ostreamoperator<< (std::ostream &lhs, const DataHistory &rhs)
 

Additional Inherited Members

- Protected Member Functions inherited from HistoryObj
virtual void indent (std::ostream &, int) const
 

Detailed Description

DataHistory class definition

Author
: Charles Leggett

Definition at line 33 of file DataHistory.h.

Constructor & Destructor Documentation

◆ DataHistory()

DataHistory::DataHistory ( const CLID id,
std::string  key,
AlgorithmHistory alg 
)

Definition at line 35 of file DataHistory.cpp.

36  : m_dataClassID( id ), m_dataKey( std::move( key ) ), m_algHist( alg ) {}

Member Function Documentation

◆ algorithmHistory()

AlgorithmHistory* DataHistory::algorithmHistory ( ) const
inline

Definition at line 53 of file DataHistory.h.

53 { return m_algHist; }

◆ classID()

const CLID & DataHistory::classID ( )
static

Definition at line 40 of file DataHistory.cpp.

40  {
41  static const CLID CLID_DataHistory = 83814411; // from `clid DataHistory`
42 
43  return CLID_DataHistory;
44 }

◆ clID()

const CLID& DataHistory::clID ( ) const
inlineoverridevirtual

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented from DataObject.

Definition at line 47 of file DataHistory.h.

47 { return DataHistory::classID(); }

◆ dataClassID()

const CLID& DataHistory::dataClassID ( ) const
inline

Definition at line 51 of file DataHistory.h.

51 { return m_dataClassID; }

◆ dataKey()

const std::string& DataHistory::dataKey ( ) const
inline

Definition at line 50 of file DataHistory.h.

50 { return m_dataKey; }

◆ dump()

std::ostream & DataHistory::dump ( std::ostream ost,
const bool  isXML,
int  indent 
) const
overridevirtual

Implements HistoryObj.

Definition at line 48 of file DataHistory.cpp.

48  {
49  return ost << "ClassID: " << dataClassID() << '\n'
50  << "Key: " << dataKey() << '\n'
51  << "AlgorithmHistory: " << (void*)algorithmHistory() << endl;
52 }

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream lhs,
const DataHistory rhs 
)
friend

Definition at line 56 of file DataHistory.h.

56 { return rhs.dump( lhs, false, 0 ); }

Member Data Documentation

◆ m_algHist

AlgorithmHistory* DataHistory::m_algHist
private

Definition at line 61 of file DataHistory.h.

◆ m_dataClassID

CLID DataHistory::m_dataClassID
private

Definition at line 59 of file DataHistory.h.

◆ m_dataKey

std::string DataHistory::m_dataKey
private

Definition at line 60 of file DataHistory.h.

◆ m_dummy

std::string DataHistory::m_dummy = "none"
private

Definition at line 62 of file DataHistory.h.


The documentation for this class was generated from the following files:
DataHistory::algorithmHistory
AlgorithmHistory * algorithmHistory() const
Definition: DataHistory.h:53
std::move
T move(T... args)
DataHistory::classID
static const CLID & classID()
Definition: DataHistory.cpp:40
DataHistory::m_algHist
AlgorithmHistory * m_algHist
Definition: DataHistory.h:61
ManySmallAlgs.alg
alg
Definition: ManySmallAlgs.py:81
DataHistory::dump
std::ostream & dump(std::ostream &, const bool isXML, int indent) const override
Definition: DataHistory.cpp:48
CLID
unsigned int CLID
Class ID definition.
Definition: ClassID.h:18
DataHistory::m_dataClassID
CLID m_dataClassID
Definition: DataHistory.h:59
DataHistory::dataClassID
const CLID & dataClassID() const
Definition: DataHistory.h:51
std::endl
T endl(T... args)
DataHistory::dataKey
const std::string & dataKey() const
Definition: DataHistory.h:50
DataHistory::m_dataKey
std::string m_dataKey
Definition: DataHistory.h:60
ProduceConsume.key
key
Definition: ProduceConsume.py:84