#include </builds/gaudi/Gaudi/GaudiKernel/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 *)

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

std::ostream &	dump (std::ostream &, const bool isXML, int indent) 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
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 ()
	Retrieve Link manager. More...

const LinkManager *	linkMgr () 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::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 { nullptr }

std::string	m_name

std::string	m_type

std::string	m_version

PropertyList	m_properties

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

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 31 of file ServiceHistory.h.

Constructor & Destructor Documentation

◆ ServiceHistory() [1/3]

ServiceHistory::ServiceHistory ( )

Definition at line 35 of file ServiceHistory.cpp.

     : //  HistoryObj(),
     m_pService( nullptr )
     , m_name( "none" )
     , m_type( "none" )
     , m_version( "none" ) {}

◆ ServiceHistory() [2/3]

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

Definition at line 43 of file ServiceHistory.cpp.

     : //  HistoryObj(),
     m_pService( isv )
     , m_jobHistory( job )
     , m_name( isv->name() )
     , m_version( "none" ) {
  
   const Service* svc = dynamic_cast<const Service*>( isv );
   if ( !svc ) throw GaudiException( "Cannot dynamic cast to Service class", name(), StatusCode::FAILURE );
   m_type       = System::typeinfoName( typeid( *svc ) );
   m_properties = svc->getProperties();
 }

◆ ServiceHistory() [3/3]

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

Definition at line 58 of file ServiceHistory.cpp.

     : //  HistoryObj(),
     m_pService( &isv )
     , m_jobHistory( job )
     , m_name( isv.name() )
     , m_version( "none" ) {
  
   const Service* svc = dynamic_cast<const Service*>( &isv );
   if ( svc ) {
     m_type       = System::typeinfoName( typeid( *svc ) );
     m_properties = svc->getProperties();
   } else {
     throw GaudiException( "Cannot dynamic cast to Service class", name(), StatusCode::FAILURE );
   }
 }

Member Function Documentation

◆ classID()

const CLID & ServiceHistory::classID ( )

static

Definition at line 76 of file ServiceHistory.cpp.

                                     {
  
   static const CLID CLID_ServiceHistory = 187225489; // from `clid ServiceHistory`
   return CLID_ServiceHistory;
 }

◆ clID()

const CLID& ServiceHistory::clID ( ) const

inlineoverridevirtual

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented from HistoryObj.

Definition at line 39 of file ServiceHistory.h.

39 { return classID(); }

◆ dump()

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

overridevirtual

Implements HistoryObj.

Definition at line 84 of file ServiceHistory.cpp.

                                                                                    {
  
   if ( !isXML ) {
  
     ost << "Name: " << name() << endl;
     ost << "Type: " << type() << endl;
     ost << "Version: " << version() << endl;
  
     // Properties
     ost << "Properties: [" << endl;
  
     for ( const auto& ipprop : properties() ) {
       const PropertyBase& prop = *ipprop;
       prop.fillStream( ost );
       ost << endl;
     }
     ost << "]" << endl;
  
   } else {
  
     ind += 2;
     indent( ost, ind );
     ost << "<COMPONENT name=\"" << name() << "\" class=\"" << convert_string( type() ) << "\" version=\""
         << convert_string( version() ) << "\">" << endl;
  
     for ( const auto& ipprop : properties() ) {
       const PropertyBase& prop = *ipprop;
  
       indent( ost, ind + 2 );
       ost << "<PROPERTY name=\"" << prop.name() << "\" value=\"" << convert_string( prop.toString() )
           << "\" documentation=\"" << convert_string( prop.documentation() ) << "\">" << endl;
     }
  
     indent( ost, ind );
     ost << "</COMPONENT>" << endl;
   }
   return ost;
 }

◆ jobHistory()

const JobHistory* ServiceHistory::jobHistory ( ) const

inline

Definition at line 47 of file ServiceHistory.h.

47 { return m_jobHistory; }

◆ name()

const std::string& ServiceHistory::name ( ) const

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 51 of file ServiceHistory.h.

51 { return m_name; }

◆ properties()

const PropertyList& ServiceHistory::properties ( ) const

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 43 of file ServiceHistory.h.

43 { return m_properties; }

◆ service()

const IService* ServiceHistory::service ( ) const

inline

Definition at line 45 of file ServiceHistory.h.

45 { return m_pService; }

◆ type()

const std::string& ServiceHistory::type ( ) const

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 52 of file ServiceHistory.h.

52 { return m_type; }

◆ version()

const std::string& ServiceHistory::version ( ) const

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 53 of file ServiceHistory.h.

53 { return m_version; }

Friends And Related Function Documentation

◆ operator<<

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

friend

Definition at line 56 of file ServiceHistory.h.

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

Member Data Documentation

◆ m_jobHistory

const JobHistory* ServiceHistory::m_jobHistory { nullptr }

private

Definition at line 60 of file ServiceHistory.h.

◆ m_name

std::string ServiceHistory::m_name

private

Definition at line 61 of file ServiceHistory.h.

◆ m_properties

PropertyList ServiceHistory::m_properties

private

Definition at line 62 of file ServiceHistory.h.

◆ m_pService

const IService* ServiceHistory::m_pService

private

Definition at line 59 of file ServiceHistory.h.

◆ m_type

std::string ServiceHistory::m_type

private

Definition at line 61 of file ServiceHistory.h.

◆ m_version

std::string ServiceHistory::m_version

private

Definition at line 61 of file ServiceHistory.h.

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ServiceHistory() [1/3]

◆ ServiceHistory() [2/3]

◆ ServiceHistory() [3/3]

Member Function Documentation

◆ classID()

◆ clID()

◆ dump()

◆ jobHistory()

◆ name()

◆ properties()

◆ service()

◆ type()

◆ version()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ m_jobHistory

◆ m_name

◆ m_properties

◆ m_pService

◆ m_type

◆ m_version