DataHistory Class Reference

DataHistory class definition. More...

#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 CLID &	clID () const override
	Retrieve reference to class definition structure.
const std::string &	dataKey () const
const CLID &	dataClassID () const
AlgorithmHistory *	algorithmHistory () const
std::ostream &	dump (std::ostream &, const bool isXML, int indent) const override
Public Member Functions inherited from HistoryObj
virtual	~HistoryObj ()=default
const CLID &	clID () const override
	Retrieve reference to class definition structure.
Public Member Functions inherited from DataObject
	DataObject ()
	Standard Constructor.
	DataObject (const DataObject &rhs)
	Copy Constructor.
DataObject &	operator= (const DataObject &rhs)
	Assignment Operator.
	DataObject (DataObject &&rhs)
	Move Constructor.
DataObject &	operator= (DataObject &&rhs)
	Move Assignment Operator.
virtual	~DataObject ()
	Standard Destructor.
virtual unsigned long	addRef ()
	Add reference to object.
virtual unsigned long	release ()
	release reference to object
const std::string &	name () const
	Retreive DataObject name. It is the name when registered in the store.
virtual StatusCode	update ()
	Provide empty placeholder for internal object reconfiguration callback.
void	setRegistry (IRegistry *pRegistry)
	Set pointer to Registry.
IRegistry *	registry () const
	Get pointer to Registry.
LinkManager *	linkMgr ()
	Retrieve Link manager.
const LinkManager *	linkMgr () const
unsigned char	version () const
	Retrieve version number of this object representation.
void	setVersion (unsigned char vsn)
	Set version number of this object representation.
unsigned long	refCount () const
	Return the refcount.
virtual std::ostream &	fillStream (std::ostream &s) const
	Fill the output stream (ASCII)

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

Private Attributes
CLID	m_dataClassID
std::string	m_dataKey
AlgorithmHistory *	m_algHist
std::string	m_dummy = "none"

Friends
std::ostream &	operator<< (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 32 of file DataHistory.h.

Constructor & Destructor Documentation

DataHistory()

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

Definition at line 18 of file DataHistory.cpp.

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

Member Function Documentation

algorithmHistory()

AlgorithmHistory * DataHistory::algorithmHistory ( ) const

inline

Definition at line 52 of file DataHistory.h.

{ return m_algHist; }

classID()

const CLID & DataHistory::classID ( )

static

Definition at line 21 of file DataHistory.cpp.

                                 {
  static const CLID CLID_DataHistory = 83814411; // from `clid DataHistory`
 
  return CLID_DataHistory;
}

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 46 of file DataHistory.h.

{ return DataHistory::classID(); }

dataClassID()

const CLID & DataHistory::dataClassID ( ) const

inline

Definition at line 50 of file DataHistory.h.

{ return m_dataClassID; }

dataKey()

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

inline

Definition at line 49 of file DataHistory.h.

{ return m_dataKey; }

dump()

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

overridevirtual

Implements HistoryObj.

Definition at line 27 of file DataHistory.cpp.

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

Friends And Related Symbol Documentation

operator<<

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

friend

Definition at line 55 of file DataHistory.h.

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

Member Data Documentation

m_algHist

AlgorithmHistory* DataHistory::m_algHist

private

Definition at line 60 of file DataHistory.h.

m_dataClassID

CLID DataHistory::m_dataClassID

private

Definition at line 58 of file DataHistory.h.

m_dataKey

std::string DataHistory::m_dataKey

private

Definition at line 59 of file DataHistory.h.

m_dummy

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

private

Definition at line 61 of file DataHistory.h.

---

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

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