AlgToolHistory class definition. More...

#include <GaudiKernel/AlgToolHistory.h>

Inheritance diagram for AlgToolHistory:

Collaboration diagram for AlgToolHistory:

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)

virtual	~AlgToolHistory ()

virtual const CLID &	clID () const
	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

const JobHistory *	jobHistory () const

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

const std::string &	name () const

const std::string &	type () const

const std::string &	version () const

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
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< Property * >	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 22 of file AlgToolHistory.h.

Constructor & Destructor Documentation

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

Definition at line 21 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::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 34 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)
 {}

virtual AlgToolHistory::~AlgToolHistory ( )

inlinevirtual

Definition at line 56 of file AlgToolHistory.h.

56 {};

Member Function Documentation

const AlgTool* AlgToolHistory::algtool_instance ( ) const

inline

Definition at line 72 of file AlgToolHistory.h.

72 { return m_tool; }

AlgToolHistory::m_tool

const AlgTool * m_tool

Definition: AlgToolHistory.h:36

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

inline

Definition at line 69 of file AlgToolHistory.h.

69 { return m_name; }

AlgToolHistory::m_name

std::string m_name

Definition: AlgToolHistory.h:33

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

inline

Definition at line 63 of file AlgToolHistory.h.

63 { return m_type; }

AlgToolHistory::m_type

std::string m_type

Definition: AlgToolHistory.h:27

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

inline

Definition at line 66 of file AlgToolHistory.h.

66 { return m_version; }

AlgToolHistory::m_version

std::string m_version

Definition: AlgToolHistory.h:30

const CLID & AlgToolHistory::classID ( )

static

Definition at line 50 of file AlgToolHistory.cpp.

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

virtual const CLID& AlgToolHistory::clID ( ) const

inlinevirtual

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented from HistoryObj.

Definition at line 59 of file AlgToolHistory.h.

59 { return classID(); }

AlgToolHistory::classID

static const CLID & classID()

Definition: AlgToolHistory.cpp:50

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

virtual

Implements HistoryObj.

Definition at line 60 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;
 
   }
 
 }