AlgorithmHistory class definition. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/AlgorithmHistory.h>

Inheritance diagram for AlgorithmHistory:

[legend]

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 Gaudi::Algorithm &alg, const JobHistory *job)

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

virtual	~AlgorithmHistory ()

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

const std::string &	algorithm_type () const

const std::string &	algorithm_version () const

const std::string &	algorithm_name () const

const Gaudi::Algorithm *	algorithm () const

const PropertyList &	properties () const override

const HistoryList &	subalgorithm_histories () const

const JobHistory *	jobHistory () const

std::ostream &	dump (std::ostream &, 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

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

Public Member Functions inherited from DataObject
	DataObject ()
	Standard Constructor.

	DataObject (const DataObject &rhs)
	Copy Constructor.

DataObject &	operator= (const DataObject &rhs)
	Assignment Operator.

	DataObject (DataObject &&rhs)
	Move Constructor.

DataObject &	operator= (DataObject &&rhs)
	Move Assignment Operator.

virtual	~DataObject ()
	Standard Destructor.

virtual unsigned long	addRef ()
	Add reference to object.

virtual unsigned long	release ()
	release reference to object

const std::string &	name () const
	Retreive DataObject name. It is the name when registered in the store.

virtual StatusCode	update ()
	Provide empty placeholder for internal object reconfiguration callback.

void	setRegistry (IRegistry *pRegistry)
	Set pointer to Registry.

IRegistry *	registry () const
	Get pointer to Registry.

LinkManager *	linkMgr ()
	Retrieve Link manager.

const LinkManager *	linkMgr () const

unsigned char	version () const
	Retrieve version number of this object representation.

void	setVersion (unsigned char vsn)
	Set version number of this object representation.

unsigned long	refCount () const
	Return the refcount.

virtual std::ostream &	fillStream (std::ostream &s) const
	Fill the output stream (ASCII)

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)

Private Attributes
std::string	m_algorithm_type

std::string	m_algorithm_version

std::string	m_algorithm_name

const Gaudi::Algorithm *	m_algorithm

PropertyList	m_properties

HistoryList	m_subalgorithm_histories

const JobHistory *	m_jobHistory

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

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 37 of file AlgorithmHistory.h.

Member Typedef Documentation

◆ HistoryList

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

Definition at line 41 of file AlgorithmHistory.h.

Constructor & Destructor Documentation

◆ AlgorithmHistory() [1/2]

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

explicit

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

◆ AlgorithmHistory() [2/2]

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

explicit

Definition at line 29 of file AlgorithmHistory.cpp.

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

◆ ~AlgorithmHistory()

AlgorithmHistory::~AlgorithmHistory ( )

virtual

Definition at line 40 of file AlgorithmHistory.cpp.

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

Member Function Documentation

◆ algorithm()

const Gaudi::Algorithm * AlgorithmHistory::algorithm ( ) const

inline

Definition at line 89 of file AlgorithmHistory.h.

89{ return m_algorithm; }

◆ algorithm_name()

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

inline

Definition at line 86 of file AlgorithmHistory.h.

86{ return m_algorithm_name; }

◆ algorithm_type()

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

inline

Definition at line 80 of file AlgorithmHistory.h.

80{ return m_algorithm_type; }

◆ algorithm_version()

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

inline

Definition at line 83 of file AlgorithmHistory.h.

83{ return m_algorithm_version; }

◆ classID()

const CLID & AlgorithmHistory::classID ( )

static

Definition at line 44 of file AlgorithmHistory.cpp.

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

◆ clID()

const CLID & AlgorithmHistory::clID ( ) const

inlineoverridevirtual

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented from DataObject.

Definition at line 76 of file AlgorithmHistory.h.

76{ return classID(); }

AlgorithmHistory::classID

static const CLID & classID()

Definition AlgorithmHistory.cpp:44

◆ dump()

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

overridevirtual

Implements HistoryObj.

Definition at line 49 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;
  } 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;
    }
 
    indent( ost, ind );
    ost << "</COMPONENT>" << std::endl;
  }
  return ost;
}

◆ jobHistory()

const JobHistory * AlgorithmHistory::jobHistory ( ) const

inline

Definition at line 98 of file AlgorithmHistory.h.

98{ return m_jobHistory; }

◆ name()

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

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 102 of file AlgorithmHistory.h.

102{ return algorithm_name(); }

◆ properties()

const PropertyList & AlgorithmHistory::properties ( ) const

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 92 of file AlgorithmHistory.h.

92{ return m_properties; }

◆ subalgorithm_histories()

const HistoryList & AlgorithmHistory::subalgorithm_histories ( ) const

inline

Definition at line 95 of file AlgorithmHistory.h.

95{ return m_subalgorithm_histories; }

◆ type()

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

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 103 of file AlgorithmHistory.h.

103{ return algorithm_type(); }

◆ version()

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

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 104 of file AlgorithmHistory.h.

104{ return algorithm_version(); }

Friends And Related Symbol Documentation

◆ operator<<

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

friend

Definition at line 107 of file AlgorithmHistory.h.

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

Member Data Documentation

◆ m_algorithm

const Gaudi::Algorithm* AlgorithmHistory::m_algorithm

private

Definition at line 54 of file AlgorithmHistory.h.

◆ m_algorithm_name

std::string AlgorithmHistory::m_algorithm_name

private

Definition at line 51 of file AlgorithmHistory.h.

◆ m_algorithm_type

std::string AlgorithmHistory::m_algorithm_type

private

Definition at line 45 of file AlgorithmHistory.h.

◆ m_algorithm_version

std::string AlgorithmHistory::m_algorithm_version

private

Definition at line 48 of file AlgorithmHistory.h.

◆ m_jobHistory

const JobHistory* AlgorithmHistory::m_jobHistory

private

Definition at line 63 of file AlgorithmHistory.h.

◆ m_properties

PropertyList AlgorithmHistory::m_properties

private

Definition at line 57 of file AlgorithmHistory.h.

◆ m_subalgorithm_histories

HistoryList AlgorithmHistory::m_subalgorithm_histories

private

Definition at line 60 of file AlgorithmHistory.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ HistoryList

Constructor & Destructor Documentation

◆ AlgorithmHistory() [1/2]

◆ AlgorithmHistory() [2/2]

◆ ~AlgorithmHistory()

Member Function Documentation

◆ algorithm()

◆ algorithm_name()

◆ algorithm_type()

◆ algorithm_version()

◆ classID()

◆ clID()

◆ dump()

◆ jobHistory()

◆ name()

◆ properties()

◆ subalgorithm_histories()

◆ type()

◆ version()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ m_algorithm

◆ m_algorithm_name

◆ m_algorithm_type

◆ m_algorithm_version

◆ m_jobHistory

◆ m_properties

◆ m_subalgorithm_histories