HistoryObj Class Reference

Base class for History Objects. More...

#include <GaudiKernel/HistoryObj.h>

Inheritance diagram for HistoryObj:

Collaboration diagram for HistoryObj:

Public Member Functions
virtual	~HistoryObj ()=default
const CLID &	clID () const override
	Retrieve reference to class definition structure.
virtual std::ostream &	dump (std::ostream &, bool isXML=false, int indent=0) const =0
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 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)

Protected Member Functions
virtual void	indent (std::ostream &, int) const

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

Detailed Description

Base class for History Objects.

Author

Charles Leggett

Date

Jul 13 2004

Definition at line 30 of file HistoryObj.h.

Constructor & Destructor Documentation

~HistoryObj()

virtual HistoryObj::~HistoryObj ( )

virtualdefault

Member Function Documentation

classID()

const CLID & HistoryObj::classID ( )

static

Definition at line 44 of file HistoryObj.cpp.

                                {
  static const CLID CLID_HistoryObj = 86452397;
  return CLID_HistoryObj;
}

clID()

const CLID & HistoryObj::clID ( ) const

inlineoverridevirtual

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented from DataObject.

Reimplemented in JobHistory, and ServiceHistory.

Definition at line 34 of file HistoryObj.h.

{ return classID(); }

convert_string()

std::string HistoryObj::convert_string ( const std::string & input_string )

static

Definition at line 14 of file HistoryObj.cpp.

                                                                    {
  // Conversion of special characteres into xml language
 
  std::string modified_string;
 
  for ( const auto& itr : input_string ) {
    if ( itr == '&' )
      modified_string.append( "&" );
    else if ( itr == '<' )
      modified_string.append( "&lt;" );
    else if ( itr == '>' )
      modified_string.append( "&gt;" );
    else if ( itr == '"' )
      modified_string.append( "&quot;" );
    else if ( itr == '\'' )
      modified_string.append( "&apos;" );
    else
      modified_string += itr;
  }
 
  return modified_string;
}

dump()

virtual std::ostream & HistoryObj::dump ( std::ostream & , bool isXML = false, int indent = 0 ) const

pure virtual

Implemented in AlgorithmHistory, AlgToolHistory, DataHistory, JobHistory, and ServiceHistory.

indent()

void HistoryObj::indent ( std::ostream & ost, int i ) const

protectedvirtual

Definition at line 37 of file HistoryObj.cpp.

                                                      {
  while ( i > 0 ) {
    ost << " ";
    --i;
  }
}

Friends And Related Symbol Documentation

operator<<

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

friend

Definition at line 41 of file HistoryObj.h.

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

---

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

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