AlgToolHistory class definition. More...

#include </builds/gaudi/Gaudi/GaudiKernel/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 (std::string algVersion, std::string algName, std::string algType, const AlgTool tool, const PropertyList &props, const JobHistory job)

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

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

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_type

std::string	m_version

std::string	m_name

const AlgTool *	m_tool

PropertyList	m_properties

const JobHistory *	m_jobHistory

Friends
std::ostream &	operator<< (std::ostream &lhs, const AlgToolHistory &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

AlgToolHistory class definition.

Author: : Charles Leggett

Definition at line 31 of file AlgToolHistory.h.

Constructor & Destructor Documentation

◆ AlgToolHistory() [1/2]

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

Definition at line 20 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	(	std::string	algVersion,
		std::string	algName,
		std::string	algType,
		const AlgTool *	tool,
		const PropertyList &	props,
		const JobHistory *	job )

Definition at line 28 of file AlgToolHistory.cpp.

    : m_type( std::move( algType ) ) // FIXME type_info???
    , m_version( std::move( algVersion ) )
    , m_name( std::move( 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 72 of file AlgToolHistory.h.

72{ return m_tool; }

◆ algtool_name()

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

inline

Definition at line 69 of file AlgToolHistory.h.

69{ return m_name; }

◆ algtool_type()

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

inline

Definition at line 63 of file AlgToolHistory.h.

63{ return m_type; }

◆ algtool_version()

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

inline

Definition at line 66 of file AlgToolHistory.h.

66{ return m_version; }

◆ classID()

const CLID & AlgToolHistory::classID ( )

static

Definition at line 38 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 59 of file AlgToolHistory.h.

59{ return classID(); }

AlgToolHistory::classID

static const CLID & classID()

Definition AlgToolHistory.cpp:38

◆ dump()

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

overridevirtual

Implements HistoryObj.

Definition at line 46 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;
  }
  return ost;
}

◆ jobHistory()

const JobHistory * AlgToolHistory::jobHistory ( ) const

inline

Definition at line 78 of file AlgToolHistory.h.

78{ return m_jobHistory; }

◆ name()

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

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 82 of file AlgToolHistory.h.

82{ return algtool_name(); }

◆ properties()

const PropertyList & AlgToolHistory::properties ( ) const

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 75 of file AlgToolHistory.h.

75{ return m_properties; }

◆ type()

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

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 83 of file AlgToolHistory.h.

83{ return algtool_type(); }

◆ version()

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

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 84 of file AlgToolHistory.h.

84{ return algtool_version(); }

Friends And Related Symbol Documentation

◆ operator<<

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

friend

Definition at line 86 of file AlgToolHistory.h.

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

AlgToolHistory::dump

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

Definition AlgToolHistory.cpp:46

Member Data Documentation

◆ m_jobHistory

const JobHistory* AlgToolHistory::m_jobHistory

private

Definition at line 50 of file AlgToolHistory.h.

◆ m_name

std::string AlgToolHistory::m_name

private

Definition at line 41 of file AlgToolHistory.h.

◆ m_properties

PropertyList AlgToolHistory::m_properties

private

Definition at line 47 of file AlgToolHistory.h.

◆ m_tool

const AlgTool* AlgToolHistory::m_tool

private

Definition at line 44 of file AlgToolHistory.h.

◆ m_type

std::string AlgToolHistory::m_type

private

Definition at line 35 of file AlgToolHistory.h.

◆ m_version

std::string AlgToolHistory::m_version

private

Definition at line 38 of file AlgToolHistory.h.

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

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()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ m_jobHistory

◆ m_name

◆ m_properties

◆ m_tool

◆ m_type

◆ m_version