| The Gaudi Framework v29r0 (ff2e7097)

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

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

Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ServiceHistory Class Reference

ServiceHistory class definition. More...

`#include <GaudiKernel/ServiceHistory.h>`

Inheritance diagram for ServiceHistory:
[legend]
Collaboration diagram for ServiceHistory:
[legend]

## Public Member Functions
| ServiceHistory ()
| ServiceHistory (const IService *, const JobHistory *)
| ServiceHistory (const IService &, const JobHistory *)
virtual | ~ServiceHistory ()=default
const CLID & | clID () const override
| Retrieve reference to class definition structure. More...
const PropertyList & | properties () const override
const IService * | service () const
const JobHistory * | jobHistory () const
void | dump (std::ostream &, const bool isXML=false, int indent=0) const override
const std::string & | name () const override
const std::string & | type () const override
const std::string & | version () const override
Public Member Functions inherited from HistoryObj
| HistoryObj ()=default
virtual | ~HistoryObj ()=default
Public Member Functions inherited from DataObject
| DataObject ()
| Standard Constructor. More...
| DataObject (const DataObject &rhs)
| Copy Constructor. More...
DataObject & | operator= (const DataObject &rhs)
| Assignment Operator. More...
| DataObject (DataObject &&rhs)
| Move Constructor. More...
DataObject & | operator= (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::string & | name () 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...
IRegistry * | registry () const
| Get pointer to Registry. More...
LinkManager * | linkMgr () const
| Retrieve Link manager. More...
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::ostream & | fillStream (std::ostream &s) const
| Fill the output stream (ASCII) More...
Public Member Functions inherited from IVersHistoryObj
virtual | ~IVersHistoryObj ()=default

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

## Private Attributes
const IService * | m_pService
const JobHistory * | m_jobHistory
std::string | m_name
std::string | m_type
std::string | m_version
PropertyList | m_properties

## Additional Inherited Members
Public Types inherited from IVersHistoryObj
typedef std::vector< Gaudi::Details::PropertyBase * > | PropertyList
Protected Member Functions inherited from HistoryObj
virtual void | indent (std::ostream &, int) const

## Detailed Description

ServiceHistory class definition.

Author
  : Charles Leggett

Definition at line 21 of file ServiceHistory.h.

## Constructor & Destructor Documentation

ServiceHistory::ServiceHistory | ( |  | ) |

Definition at line 25 of file ServiceHistory.cpp.

26 : // HistoryObj(),
27 m_pService( nullptr )
28 , m_name( "none" )
29 , m_type( "none" )
30 , m_version( "none" )
31 {
32 }
ServiceHistory::m_name
std::string m_name
Definition: ServiceHistory.h:51
ServiceHistory::m_type
std::string m_type
Definition: ServiceHistory.h:51
ServiceHistory::m_version
std::string m_version
Definition: ServiceHistory.h:51
ServiceHistory::m_pService
const IService * m_pService
Definition: ServiceHistory.h:49

ServiceHistory::ServiceHistory | ( | const IService * | isv,
|  | const JobHistory * | job
| ) |  |

Definition at line 35 of file ServiceHistory.cpp.

36 : // HistoryObj(),
37 m_pService( isv )
38 , m_jobHistory( job )
39 , m_name( isv->name() )
40 , m_version( "none" )
41 {
42
43 const Service* svc = dynamic_cast<const Service*>( isv );
44 m_type = System::typeinfoName( typeid( *svc ) );
45 m_properties = svc->getProperties();
46 }
PropertyHolder::getProperties
const std::vector< Gaudi::Details::PropertyBase * > & getProperties() const override
get all properties
Definition: PropertyHolder.h:329
System::typeinfoName
GAUDI_API const std::string typeinfoName(const std::type_info &)
Get platform independent information about the class type.
Definition: System.cpp:329
ServiceHistory::m_name
std::string m_name
Definition: ServiceHistory.h:51
ServiceHistory::m_properties
PropertyList m_properties
Definition: ServiceHistory.h:52
ServiceHistory::m_type
std::string m_type
Definition: ServiceHistory.h:51
ServiceHistory::m_jobHistory
const JobHistory * m_jobHistory
Definition: ServiceHistory.h:50
ServiceHistory::m_version
std::string m_version
Definition: ServiceHistory.h:51
Service
Base class for all services.
Definition: Service.h:36
ServiceHistory::m_pService
const IService * m_pService
Definition: ServiceHistory.h:49

ServiceHistory::ServiceHistory | ( | const IService & | isv,
|  | const JobHistory * | job
| ) |  |

Definition at line 50 of file ServiceHistory.cpp.

51 : // HistoryObj(),
52 m_pService( &isv )
53 , m_jobHistory( job )
54 , m_name( isv.name() )
55 , m_version( "none" )
56 {
57
58 const Service* svc = dynamic_cast<const Service*>( &isv );
59 m_type = System::typeinfoName( typeid( *svc ) );
60 m_properties = svc->getProperties();
61 }
PropertyHolder::getProperties
const std::vector< Gaudi::Details::PropertyBase * > & getProperties() const override
get all properties
Definition: PropertyHolder.h:329
System::typeinfoName
GAUDI_API const std::string typeinfoName(const std::type_info &)
Get platform independent information about the class type.
Definition: System.cpp:329
ServiceHistory::m_name
std::string m_name
Definition: ServiceHistory.h:51
ServiceHistory::m_properties
PropertyList m_properties
Definition: ServiceHistory.h:52
ServiceHistory::m_type
std::string m_type
Definition: ServiceHistory.h:51
ServiceHistory::m_jobHistory
const JobHistory * m_jobHistory
Definition: ServiceHistory.h:50
ServiceHistory::m_version
std::string m_version
Definition: ServiceHistory.h:51
Service
Base class for all services.
Definition: Service.h:36
ServiceHistory::m_pService
const IService * m_pService
Definition: ServiceHistory.h:49

virtual ServiceHistory::~ServiceHistory | ( |  | ) |
| virtual default

## Member Function Documentation

const CLID & ServiceHistory::classID | ( |  | ) |
| static

Definition at line 65 of file ServiceHistory.cpp.

66 {
67
68 static const CLID CLID_ServiceHistory = 187225489; // from `clid ServiceHistory`
69 return CLID_ServiceHistory;
70 }
CLID
unsigned int CLID
Class ID definition.
Definition: ClassID.h:8

const CLID& ServiceHistory::clID | ( |  | ) | const
| inline override virtual

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented from HistoryObj.

Definition at line 32 of file ServiceHistory.h.

32 { return classID(); }
ServiceHistory::classID
static const CLID & classID()
Definition: ServiceHistory.cpp:65

void ServiceHistory::dump | ( | std::ostream & | ost,
|  | const bool | isXML = `false`,
|  | int | indent = `0`
| ) |  | const
| override virtual

Implements HistoryObj.

Definition at line 74 of file ServiceHistory.cpp.

75 {
76
77 if ( !isXML ) {
78
79 ost << "Name: " << name() << endl;
80 ost << "Type: " << type() << endl;
81 ost << "Version: " << version() << endl;
82
83 // Properties
84 ost << "Properties: [" << endl;
85
86 for ( const auto& ipprop : properties() ) {
87 const PropertyBase& prop = *ipprop;
88 prop.fillStream( ost );
89 ost << endl;
90 }
91 ost << "]" << endl;
92
93 } else {
94
95 ind += 2;
96 indent( ost, ind );
97 ost << "<COMPONENT name=\"" << name() << "\" class=\"" << convert_string( type() ) << "\" version=\""
98 << convert_string( version() ) << "\">" << endl;
99
100 for ( const auto& ipprop : properties() ) {
101 const PropertyBase& prop = *ipprop;
102
103 indent( ost, ind + 2 );
104 ost << "<PROPERTY name=\"" << prop.name() << "\" value=\"" << convert_string( prop.toString() )
105 << "\" documentation=\"" << convert_string( prop.documentation() ) << "\">" << endl;
106 }
107
108 indent( ost, ind );
109 ost << "</COMPONENT>" << endl;
110 }
111 }
Gaudi::Details::PropertyBase::name
const std::string name() const
property name
Definition: Property.h:40
std::endl
T endl(T...args)
Gaudi::Details::PropertyBase::toString
virtual std::string toString() const =0
value -> string
ServiceHistory::properties
const PropertyList & properties() const override
Definition: ServiceHistory.h:36
ServiceHistory::name
const std::string & name() const override
Definition: ServiceHistory.h:44
HistoryObj::indent
virtual void indent(std::ostream &, int) const
Definition: HistoryObj.cpp:49
Gaudi::Details::PropertyBase
PropertyBase base class allowing PropertyBase* collections to be "homogeneous".
Definition: Property.h:32
Gaudi::Details::PropertyBase::fillStream
virtual std::ostream & fillStream(std::ostream &) const
the printout of the property value
Definition: Property.cpp:52
ServiceHistory::version
const std::string & version() const override
Definition: ServiceHistory.h:46
HistoryObj::convert_string
static std::string convert_string(const std::string &)
Definition: HistoryObj.cpp:20
Gaudi::Details::PropertyBase::documentation
std::string documentation() const
property documentation
Definition: Property.h:42
ServiceHistory::type
const std::string & type() const override
Definition: ServiceHistory.h:45

const JobHistory* ServiceHistory::jobHistory | ( |  | ) | const
| inline

Definition at line 40 of file ServiceHistory.h.

40 { return m_jobHistory; }
ServiceHistory::m_jobHistory
const JobHistory * m_jobHistory
Definition: ServiceHistory.h:50

const std::string& ServiceHistory::name | ( |  | ) | const
| inline override virtual

Implements IVersHistoryObj.

Definition at line 44 of file ServiceHistory.h.

44 { return m_name; }
ServiceHistory::m_name
std::string m_name
Definition: ServiceHistory.h:51

const PropertyList& ServiceHistory::properties | ( |  | ) | const
| inline override virtual

Implements IVersHistoryObj.

Definition at line 36 of file ServiceHistory.h.

36 { return m_properties; }
ServiceHistory::m_properties
PropertyList m_properties
Definition: ServiceHistory.h:52

const IService* ServiceHistory::service | ( |  | ) | const
| inline

Definition at line 38 of file ServiceHistory.h.

38 { return m_pService; }
ServiceHistory::m_pService
const IService * m_pService
Definition: ServiceHistory.h:49

const std::string& ServiceHistory::type | ( |  | ) | const
| inline override virtual

Implements IVersHistoryObj.

Definition at line 45 of file ServiceHistory.h.

45 { return m_type; }
ServiceHistory::m_type
std::string m_type
Definition: ServiceHistory.h:51

const std::string& ServiceHistory::version | ( |  | ) | const
| inline override virtual

Implements IVersHistoryObj.

Definition at line 46 of file ServiceHistory.h.

46 { return m_version; }
ServiceHistory::m_version
std::string m_version
Definition: ServiceHistory.h:51

## Member Data Documentation

const JobHistory* ServiceHistory::m_jobHistory
| private

Definition at line 50 of file ServiceHistory.h.

std::string ServiceHistory::m_name
| private

Definition at line 51 of file ServiceHistory.h.

PropertyList ServiceHistory::m_properties
| private

Definition at line 52 of file ServiceHistory.h.

const IService* ServiceHistory::m_pService
| private

Definition at line 49 of file ServiceHistory.h.

std::string ServiceHistory::m_type
| private

Definition at line 51 of file ServiceHistory.h.

std::string ServiceHistory::m_version
| private

Definition at line 51 of file ServiceHistory.h.

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

- GaudiKernel/GaudiKernel/ServiceHistory.h
- GaudiKernel/src/Lib/ServiceHistory.cpp