AlgToolHistory class definition. More...

#include <GaudiKernel/AlgToolHistory.h>

Inheritance diagram for AlgToolHistory:

[legend]

Collaboration diagram for AlgToolHistory:

[legend]

Public Member Functions
	AlgToolHistory (const AlgTool &alg, const JobHistory *job)

	AlgToolHistory (const std::string &algVersion, const std::string &algName, const std::string &algType, const AlgTool tool, const PropertyList &props, const JobHistory job)

const CLID &	clID () const override
	Retrieve reference to class definition structure. More...

const std::string &	algtool_type () const

const std::string &	algtool_version () const

const std::string &	algtool_name () const

const AlgTool *	algtool_instance () const

const PropertyList &	properties () const override

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

const CLID &	clID () const override
	Retrieve reference to class definition structure. More...

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
std::string	m_type

std::string	m_version

std::string	m_name

const AlgTool *	m_tool

PropertyList	m_properties

const JobHistory *	m_jobHistory

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

AlgToolHistory class definition.

Author: : Charles Leggett

Definition at line 32 of file AlgToolHistory.h.

Constructor & Destructor Documentation

◆ AlgToolHistory() [1/2]

AlgToolHistory::AlgToolHistory	(	const AlgTool &	alg,
		const JobHistory *	job
	)

Definition at line 31 of file AlgToolHistory.cpp.

     : m_type( alg.type() )
     , m_version( "UNKNOWN" )
     , m_name( alg.name() )
     , m_tool( &alg )
     , m_properties( alg.getProperties() )
     , m_jobHistory( job ) {}

◆ AlgToolHistory() [2/2]

AlgToolHistory::AlgToolHistory	(	const std::string &	algVersion,
		const std::string &	algName,
		const std::string &	algType,
		const AlgTool *	tool,
		const PropertyList &	props,
		const JobHistory *	job
	)

Definition at line 41 of file AlgToolHistory.cpp.

     : m_type( algType )
     , // FIXME type_info???
     m_version( algVersion )
     , m_name( algName )
     , m_tool( tool )
     , m_properties( props )
     , m_jobHistory( job ) {}

Member Function Documentation

◆ algtool_instance()

const AlgTool* AlgToolHistory::algtool_instance ( ) const

inline

Definition at line 73 of file AlgToolHistory.h.

73 { return m_tool; }

AlgToolHistory::m_tool

const AlgTool * m_tool

Definition: AlgToolHistory.h:45

◆ algtool_name()

const std::string& AlgToolHistory::algtool_name ( ) const

inline

Definition at line 70 of file AlgToolHistory.h.

70 { return m_name; }

AlgToolHistory::m_name

std::string m_name

Definition: AlgToolHistory.h:42

◆ algtool_type()

const std::string& AlgToolHistory::algtool_type ( ) const

inline

Definition at line 64 of file AlgToolHistory.h.

64 { return m_type; }

AlgToolHistory::m_type

std::string m_type

Definition: AlgToolHistory.h:36

◆ algtool_version()

const std::string& AlgToolHistory::algtool_version ( ) const

inline

Definition at line 67 of file AlgToolHistory.h.

67 { return m_version; }

AlgToolHistory::m_version

std::string m_version

Definition: AlgToolHistory.h:39

◆ classID()

const CLID & AlgToolHistory::classID ( )

static

Definition at line 54 of file AlgToolHistory.cpp.

                                     {
 
   static const CLID CLID_AlgToolHistory = 171959758; // from `clid AlgToolHistory`
   return CLID_AlgToolHistory;
 }

◆ clID()

const CLID& AlgToolHistory::clID ( ) const

inlineoverridevirtual

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented from DataObject.

Definition at line 60 of file AlgToolHistory.h.

60 { return classID(); }

AlgToolHistory::classID

static const CLID & classID()

Definition: AlgToolHistory.cpp:54

◆ dump()

void AlgToolHistory::dump	(	std::ostream &	ost,
		const bool	isXML = `false`,
		int	indent = `0`
	)		const

overridevirtual

Implements HistoryObj.

Definition at line 62 of file AlgToolHistory.cpp.

                                                                             {
 
   if ( !isXML ) {
 
     ost << "Name: " << algtool_name() << endl;
     ost << "Type: " << algtool_type() << endl;
     ost << "Version: " << algtool_version() << endl;
     ost << "Parent: " << algtool_instance()->name() << endl;
 
     // Properties
     ost << "Properties: [" << endl;
 
     for ( const auto& iprop : properties() ) {
       iprop->fillStream( ost );
       ost << endl;
     }
     ost << "]" << endl;
 
   } else {
 
     ind += 2;
     indent( ost, ind );
     ost << "<COMPONENT name=\"" << algtool_name() << "\" class=\"" << convert_string( algtool_type() )
         << "\" version=\"" << convert_string( algtool_version() ) << "\" parent=\""
         << convert_string( algtool_instance()->name() ) << "\">" << endl;
 
     for ( const auto& iprop : properties() ) {
 
       indent( ost, ind + 2 );
       ost << "<PROPERTY name=\"" << iprop->name() << "\" value=\"" << convert_string( iprop->toString() )
           << "\" documentation=\"" << convert_string( iprop->documentation() ) << "\">" << endl;
     }
 
     indent( ost, ind );
     ost << "</COMPONENT>" << endl;
   }
 }

◆ jobHistory()

const JobHistory* AlgToolHistory::jobHistory ( ) const

inline

Definition at line 79 of file AlgToolHistory.h.

79 { return m_jobHistory; }

AlgToolHistory::m_jobHistory

const JobHistory * m_jobHistory

Definition: AlgToolHistory.h:51

◆ name()

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

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 83 of file AlgToolHistory.h.

83 { return algtool_name(); }

AlgToolHistory::algtool_name

const std::string & algtool_name() const

Definition: AlgToolHistory.h:70

◆ properties()

const PropertyList& AlgToolHistory::properties ( ) const

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 76 of file AlgToolHistory.h.

76 { return m_properties; }

AlgToolHistory::m_properties

PropertyList m_properties

Definition: AlgToolHistory.h:48

◆ type()

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

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 84 of file AlgToolHistory.h.

84 { return algtool_type(); }

AlgToolHistory::algtool_type

const std::string & algtool_type() const

Definition: AlgToolHistory.h:64

◆ version()

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

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 85 of file AlgToolHistory.h.

85 { return algtool_version(); }

AlgToolHistory::algtool_version

const std::string & algtool_version() const

Definition: AlgToolHistory.h:67

Member Data Documentation

◆ m_jobHistory

const JobHistory* AlgToolHistory::m_jobHistory

private

Definition at line 51 of file AlgToolHistory.h.

◆ m_name

std::string AlgToolHistory::m_name

private

Definition at line 42 of file AlgToolHistory.h.

◆ m_properties

PropertyList AlgToolHistory::m_properties

private

Definition at line 48 of file AlgToolHistory.h.

◆ m_tool

const AlgTool* AlgToolHistory::m_tool

private

Definition at line 45 of file AlgToolHistory.h.

◆ m_type

std::string AlgToolHistory::m_type

private

Definition at line 36 of file AlgToolHistory.h.

◆ m_version

std::string AlgToolHistory::m_version

private

Definition at line 39 of file AlgToolHistory.h.

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

GaudiKernel/GaudiKernel/AlgToolHistory.h
GaudiKernel/src/Lib/AlgToolHistory.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AlgToolHistory() [1/2]

◆ AlgToolHistory() [2/2]

Member Function Documentation

◆ algtool_instance()

◆ algtool_name()

◆ algtool_type()

◆ algtool_version()

◆ classID()

◆ clID()

◆ dump()

◆ jobHistory()

◆ name()

◆ properties()

◆ type()

◆ version()

Member Data Documentation

◆ m_jobHistory

◆ m_name

◆ m_properties

◆ m_tool

◆ m_type

◆ m_version