AlgorithmHistory class definition. More...

#include <GaudiKernel/AlgorithmHistory.h>

Inheritance diagram for AlgorithmHistory:

Collaboration diagram for AlgorithmHistory:

[legend]

Public Types
typedef std::vector< const AlgorithmHistory * >	HistoryList

Public Types inherited from IVersHistoryObj
typedef std::vector< Gaudi::Details::PropertyBase * >	PropertyList

Public Member Functions
	AlgorithmHistory (const Algorithm &alg, const JobHistory *job)

	AlgorithmHistory (const std::string &algVersion, const std::string &algName, const std::string &algType, const PropertyList &props, const HistoryList &subHists)

virtual	~AlgorithmHistory ()

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

const std::string &	algorithm_type () const

const std::string &	algorithm_version () const

const std::string &	algorithm_name () const

const Algorithm *	algorithm () const

const PropertyList &	properties () const override

const HistoryList &	subalgorithm_histories () 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

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_algorithm_type

std::string	m_algorithm_version

std::string	m_algorithm_name

const Algorithm *	m_algorithm

PropertyList	m_properties

HistoryList	m_subalgorithm_histories

const JobHistory *	m_jobHistory

Additional Inherited Members
Protected Member Functions inherited from HistoryObj
virtual void	indent (std::ostream &, int) const

Detailed Description

AlgorithmHistory class definition.

Author: : Charles Leggett

Definition at line 26 of file AlgorithmHistory.h.

Member Typedef Documentation

typedef std::vector<const AlgorithmHistory*> AlgorithmHistory::HistoryList

Definition at line 31 of file AlgorithmHistory.h.

Constructor & Destructor Documentation

AlgorithmHistory::AlgorithmHistory	(	const Algorithm &	alg,
		const JobHistory *	job
	)

explicit

Definition at line 29 of file AlgorithmHistory.cpp.

     : m_algorithm_type( System::typeinfoName( typeid( alg ) ) )
     , m_algorithm_version( alg.version() )
     , m_algorithm_name( alg.name() )
     , m_algorithm( &alg )
     , m_properties( alg.getProperties() )
     , m_jobHistory( job )
 {
   assert( alg.subAlgorithms() != 0 );
 
   for ( const auto& ialg : *alg.subAlgorithms() ) {
     m_subalgorithm_histories.push_back( new AlgorithmHistory( *ialg, job ) );
   }
 }

AlgorithmHistory::AlgorithmHistory	(	const std::string &	algVersion,
		const std::string &	algName,
		const std::string &	algType,
		const PropertyList &	props,
		const HistoryList &	subHists
	)

explicit

Definition at line 46 of file AlgorithmHistory.cpp.

     : m_algorithm_type( algType )
     , // FIXME type_info???
     m_algorithm_version( algVersion )
     , m_algorithm_name( algName )
     , m_algorithm( nullptr )
     , m_properties( props )
     , m_subalgorithm_histories( subHists )
     , m_jobHistory( nullptr )
 {
 }

AlgorithmHistory::~AlgorithmHistory ( )

virtual

Definition at line 64 of file AlgorithmHistory.cpp.

 {
   for ( auto& i : m_subalgorithm_histories ) delete i;
 }

Member Function Documentation

const Algorithm* AlgorithmHistory::algorithm ( ) const

inline

Definition at line 79 of file AlgorithmHistory.h.

79 { return m_algorithm; }

AlgorithmHistory::m_algorithm

const Algorithm * m_algorithm

Definition: AlgorithmHistory.h:44

const std::string& AlgorithmHistory::algorithm_name ( ) const

inline

Definition at line 76 of file AlgorithmHistory.h.

76 { return m_algorithm_name; }

AlgorithmHistory::m_algorithm_name

std::string m_algorithm_name

Definition: AlgorithmHistory.h:41

const std::string& AlgorithmHistory::algorithm_type ( ) const

inline

Definition at line 70 of file AlgorithmHistory.h.

70 { return m_algorithm_type; }

AlgorithmHistory::m_algorithm_type

std::string m_algorithm_type

Definition: AlgorithmHistory.h:35

const std::string& AlgorithmHistory::algorithm_version ( ) const

inline

Definition at line 73 of file AlgorithmHistory.h.

73 { return m_algorithm_version; }

AlgorithmHistory::m_algorithm_version

std::string m_algorithm_version

Definition: AlgorithmHistory.h:38

const CLID & AlgorithmHistory::classID ( )

static

Definition at line 71 of file AlgorithmHistory.cpp.

 {
 
   static const CLID CLID_AlgorithmHistory = 56809101; // from `clid AlgorithmHistory`
   return CLID_AlgorithmHistory;
 }

const CLID& AlgorithmHistory::clID ( ) const

inlineoverridevirtual

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented from DataObject.

Definition at line 66 of file AlgorithmHistory.h.

66 { return classID(); }

AlgorithmHistory::classID

static const CLID & classID()

Definition: AlgorithmHistory.cpp:71

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

overridevirtual

Implements HistoryObj.

Definition at line 80 of file AlgorithmHistory.cpp.

 {
 
   if ( !isXML ) {
     ost << "Type: " << algorithm_type() << endl;
     ost << "Name: " << algorithm_name() << endl;
     ost << "Version: " << algorithm_version() << endl;
     // Properties.
     ost << "Properties: [" << endl;
     ;
     for ( const auto& iprop : properties() ) {
       iprop->fillStream( ost );
       ost << endl;
     }
     ost << "]" << endl;
     // Subalgorithms.
     if ( subalgorithm_histories().size() == 0 ) {
       ost << "No subalgorithms.";
     } else {
       ost << "Subalgorithms: {" << endl;
       for ( auto iphist = subalgorithm_histories().begin(); iphist != subalgorithm_histories().end(); ++iphist ) {
         if ( iphist == subalgorithm_histories().begin() ) {
           ost << "----------" << endl;
         }
         ost << **iphist << endl;
         ost << "----------" << endl;
       }
       ost << "}";
     }
   } else {
     ind += 2;
     indent( ost, ind );
     ost << "<COMPONENT name=\"" << algorithm_name() << "\" class=\"" << convert_string( algorithm_type() )
         << "\" version=\"" << algorithm_version() << "\">" << std::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() ) << "\">" << std::endl;
     }
 
     // Subalgs
     for ( const auto& iphist : subalgorithm_histories() ) {
       iphist->dump( ost, isXML, ind + 2 );
     }
 
     indent( ost, ind );
     ost << "</COMPONENT>" << std::endl;
   }
 }