The Gaudi Framework  master (37c0b60a)
HistoryObj Class Referenceabstract

#include <GaudiKernel/HistoryObj.h>

Inheritance diagram for HistoryObj:
Collaboration diagram for HistoryObj:

Public Member Functions

virtual ~HistoryObj ()=default
 
const CLIDclID () const override
 Retrieve reference to class definition structure. More...
 
virtual std::ostreamdump (std::ostream &, bool isXML=false, int indent=0) const =0
 
- 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 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...
 

Protected Member Functions

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

Friends

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

Detailed Description

Base class for History Objects

Author
Charles Leggett
Date
Jul 13 2004

Definition at line 31 of file HistoryObj.h.

Constructor & Destructor Documentation

◆ ~HistoryObj()

virtual HistoryObj::~HistoryObj ( )
virtualdefault

Member Function Documentation

◆ classID()

const CLID & HistoryObj::classID ( )
static

Definition at line 65 of file HistoryObj.cpp.

65  {
66 
67  static const CLID CLID_HistoryObj = 86452397;
68  return CLID_HistoryObj;
69 }

◆ 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 35 of file HistoryObj.h.

35 { return classID(); }

◆ convert_string()

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

Definition at line 30 of file HistoryObj.cpp.

30  {
31 
32  // Conversion of special characteres into xml language
33 
34  std::string modified_string;
35 
36  for ( const auto& itr : input_string ) {
37  if ( itr == '&' )
38  modified_string.append( "&amp;" );
39  else if ( itr == '<' )
40  modified_string.append( "&lt;" );
41  else if ( itr == '>' )
42  modified_string.append( "&gt;" );
43  else if ( itr == '"' )
44  modified_string.append( "&quot;" );
45  else if ( itr == '\'' )
46  modified_string.append( "&apos;" );
47  else
48  modified_string += itr;
49  }
50 
51  return modified_string;
52 }

◆ dump()

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

◆ indent()

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

Definition at line 56 of file HistoryObj.cpp.

56  {
57  while ( i > 0 ) {
58  ost << " ";
59  --i;
60  }
61 }

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 42 of file HistoryObj.h.

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

The documentation for this class was generated from the following files:
HistoryObj::classID
static const CLID & classID()
Definition: HistoryObj.cpp:65
std::string
STL class.
CLID
unsigned int CLID
Class ID definition.
Definition: ClassID.h:18
std::string::append
T append(T... args)
HistoryObj::dump
virtual std::ostream & dump(std::ostream &, bool isXML=false, int indent=0) const =0