| The Gaudi Framework v32r1 (f65d50dc)

Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
AlgorithmHistory Class Reference

AlgorithmHistory class definition. More...

`#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 (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 Gaudi::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 Gaudi::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 28 of file AlgorithmHistory.h.

## Member Typedef Documentation

## ◆ HistoryList

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

Definition at line 32 of file AlgorithmHistory.h.

## Constructor & Destructor Documentation

## ◆ AlgorithmHistory() [1/2]

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

Definition at line 29 of file AlgorithmHistory.cpp.

30 : m_algorithm_type( System::typeinfoName( typeid( alg ) ) )
31 , m_algorithm_version( alg.version() )
32 , m_algorithm_name( alg.name() )
33 , m_algorithm( &alg )
34 , m_properties( alg.getProperties() )
35 , m_jobHistory( job ) {}
ManySmallAlgs.alg
alg
Definition: ManySmallAlgs.py:69
System::typeinfoName
GAUDI_API const std::string typeinfoName(const std::type_info &)
Get platform independent information about the class type.
Definition: System.cpp:298
AlgorithmHistory::m_algorithm_type
std::string m_algorithm_type
Definition: AlgorithmHistory.h:36
AlgorithmHistory::m_algorithm_version
std::string m_algorithm_version
Definition: AlgorithmHistory.h:39
AlgorithmHistory::m_properties
PropertyList m_properties
Definition: AlgorithmHistory.h:48
AlgorithmHistory::m_algorithm_name
std::string m_algorithm_name
Definition: AlgorithmHistory.h:42
AlgorithmHistory::m_algorithm
const Gaudi::Algorithm * m_algorithm
Definition: AlgorithmHistory.h:45
AlgorithmHistory::m_jobHistory
const JobHistory * m_jobHistory
Definition: AlgorithmHistory.h:54

## ◆ AlgorithmHistory() [2/2]

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

Definition at line 39 of file AlgorithmHistory.cpp.

42 : m_algorithm_type( algType )
43 , // FIXME type_info???
44 m_algorithm_version( algVersion )
45 , m_algorithm_name( algName )
46 , m_algorithm( nullptr )
47 , m_properties( props )
48 , m_subalgorithm_histories( subHists )
49 , m_jobHistory( nullptr ) {}
AlgorithmHistory::m_algorithm_type
std::string m_algorithm_type
Definition: AlgorithmHistory.h:36
AlgorithmHistory::m_algorithm_version
std::string m_algorithm_version
Definition: AlgorithmHistory.h:39
AlgorithmHistory::m_subalgorithm_histories
HistoryList m_subalgorithm_histories
Definition: AlgorithmHistory.h:51
AlgorithmHistory::m_properties
PropertyList m_properties
Definition: AlgorithmHistory.h:48
AlgorithmHistory::m_algorithm_name
std::string m_algorithm_name
Definition: AlgorithmHistory.h:42
AlgorithmHistory::m_algorithm
const Gaudi::Algorithm * m_algorithm
Definition: AlgorithmHistory.h:45
AlgorithmHistory::m_jobHistory
const JobHistory * m_jobHistory
Definition: AlgorithmHistory.h:54

## ◆ ~AlgorithmHistory()

AlgorithmHistory::~AlgorithmHistory | ( |  | ) |
| virtual

Definition at line 55 of file AlgorithmHistory.cpp.

55 {
56 for ( auto& i : m_subalgorithm_histories ) delete i;
57 }
AlgorithmHistory::m_subalgorithm_histories
HistoryList m_subalgorithm_histories
Definition: AlgorithmHistory.h:51

## Member Function Documentation

## ◆ algorithm()

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

Definition at line 80 of file AlgorithmHistory.h.

80 { return m_algorithm; }
AlgorithmHistory::m_algorithm
const Gaudi::Algorithm * m_algorithm
Definition: AlgorithmHistory.h:45

## ◆ algorithm_name()

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

Definition at line 77 of file AlgorithmHistory.h.

77 { return m_algorithm_name; }
AlgorithmHistory::m_algorithm_name
std::string m_algorithm_name
Definition: AlgorithmHistory.h:42

## ◆ algorithm_type()

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

Definition at line 71 of file AlgorithmHistory.h.

71 { return m_algorithm_type; }
AlgorithmHistory::m_algorithm_type
std::string m_algorithm_type
Definition: AlgorithmHistory.h:36

## ◆ algorithm_version()

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

Definition at line 74 of file AlgorithmHistory.h.

74 { return m_algorithm_version; }
AlgorithmHistory::m_algorithm_version
std::string m_algorithm_version
Definition: AlgorithmHistory.h:39

## ◆ classID()

const CLID & AlgorithmHistory::classID | ( |  | ) |
| static

Definition at line 61 of file AlgorithmHistory.cpp.

61 {
62
63 static const CLID CLID_AlgorithmHistory = 56809101; // from `clid AlgorithmHistory`
64 return CLID_AlgorithmHistory;
65 }
CLID
unsigned int CLID
Class ID definition.
Definition: ClassID.h:8

## ◆ clID()

const CLID& AlgorithmHistory::clID | ( |  | ) | const
| inline override virtual

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented from DataObject.

Definition at line 67 of file AlgorithmHistory.h.

67 { return classID(); }
AlgorithmHistory::classID
static const CLID & classID()
Definition: AlgorithmHistory.cpp:61

## ◆ dump()

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

Implements HistoryObj.

Definition at line 69 of file AlgorithmHistory.cpp.

69 {
70
71 if ( !isXML ) {
72 ost << "Type: " << algorithm_type() << endl;
73 ost << "Name: " << algorithm_name() << endl;
74 ost << "Version: " << algorithm_version() << endl;
75 // Properties.
76 ost << "Properties: [" << endl;
77 ;
78 for ( const auto& iprop : properties() ) {
79 iprop->fillStream( ost );
80 ost << endl;
81 }
82 ost << "]" << endl;
83 } else {
84 ind += 2;
85 indent( ost, ind );
86 ost << "<COMPONENT name=\"" << algorithm_name() << "\" class=\"" << convert_string( algorithm_type() )
87 << "\" version=\"" << algorithm_version() << "\">" << std::endl;
88
89 for ( const auto& iprop : properties() ) {
90 indent( ost, ind + 2 );
91 ost << "<PROPERTY name=\"" << iprop->name() << "\" value=\"" << convert_string( iprop->toString() )
92 << "\" documentation=\"" << convert_string( iprop->documentation() ) << "\">" << std::endl;
93 }
94
95 indent( ost, ind );
96 ost << "</COMPONENT>" << std::endl;
97 }
98 }
AlgorithmHistory::algorithm_version
const std::string & algorithm_version() const
Definition: AlgorithmHistory.h:74
AlgorithmHistory::algorithm_type
const std::string & algorithm_type() const
Definition: AlgorithmHistory.h:71
std::endl
T endl(T... args)
AlgorithmHistory::algorithm_name
const std::string & algorithm_name() const
Definition: AlgorithmHistory.h:77
AlgorithmHistory::properties
const PropertyList & properties() const override
Definition: AlgorithmHistory.h:83
HistoryObj::indent
virtual void indent(std::ostream &, int) const
Definition: HistoryObj.cpp:46
HistoryObj::convert_string
static std::string convert_string(const std::string &)
Definition: HistoryObj.cpp:20

## ◆ jobHistory()

const JobHistory* AlgorithmHistory::jobHistory | ( |  | ) | const
| inline

Definition at line 89 of file AlgorithmHistory.h.

89 { return m_jobHistory; }
AlgorithmHistory::m_jobHistory
const JobHistory * m_jobHistory
Definition: AlgorithmHistory.h:54

## ◆ name()

const std::string& AlgorithmHistory::name | ( |  | ) | const
| inline override virtual

Implements IVersHistoryObj.

Definition at line 93 of file AlgorithmHistory.h.

93 { return algorithm_name(); }
AlgorithmHistory::algorithm_name
const std::string & algorithm_name() const
Definition: AlgorithmHistory.h:77

## ◆ properties()

const PropertyList& AlgorithmHistory::properties | ( |  | ) | const
| inline override virtual

Implements IVersHistoryObj.

Definition at line 83 of file AlgorithmHistory.h.

83 { return m_properties; }
AlgorithmHistory::m_properties
PropertyList m_properties
Definition: AlgorithmHistory.h:48

## ◆ subalgorithm_histories()

const HistoryList& AlgorithmHistory::subalgorithm_histories | ( |  | ) | const
| inline

Definition at line 86 of file AlgorithmHistory.h.

86 { return m_subalgorithm_histories; }
AlgorithmHistory::m_subalgorithm_histories
HistoryList m_subalgorithm_histories
Definition: AlgorithmHistory.h:51

## ◆ type()

const std::string& AlgorithmHistory::type | ( |  | ) | const
| inline override virtual

Implements IVersHistoryObj.

Definition at line 94 of file AlgorithmHistory.h.

94 { return algorithm_type(); }
AlgorithmHistory::algorithm_type
const std::string & algorithm_type() const
Definition: AlgorithmHistory.h:71

## ◆ version()

const std::string& AlgorithmHistory::version | ( |  | ) | const
| inline override virtual

Implements IVersHistoryObj.

Definition at line 95 of file AlgorithmHistory.h.

95 { return algorithm_version(); }
AlgorithmHistory::algorithm_version
const std::string & algorithm_version() const
Definition: AlgorithmHistory.h:74

## Member Data Documentation

## ◆ m_algorithm

const Gaudi::Algorithm* AlgorithmHistory::m_algorithm
| private

Definition at line 45 of file AlgorithmHistory.h.

## ◆ m_algorithm_name

std::string AlgorithmHistory::m_algorithm_name
| private

Definition at line 42 of file AlgorithmHistory.h.

## ◆ m_algorithm_type

std::string AlgorithmHistory::m_algorithm_type
| private

Definition at line 36 of file AlgorithmHistory.h.

## ◆ m_algorithm_version

std::string AlgorithmHistory::m_algorithm_version
| private

Definition at line 39 of file AlgorithmHistory.h.

## ◆ m_jobHistory

const JobHistory* AlgorithmHistory::m_jobHistory
| private

Definition at line 54 of file AlgorithmHistory.h.

## ◆ m_properties

PropertyList AlgorithmHistory::m_properties
| private

Definition at line 48 of file AlgorithmHistory.h.

## ◆ m_subalgorithm_histories

HistoryList AlgorithmHistory::m_subalgorithm_histories
| private

Definition at line 51 of file AlgorithmHistory.h.

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

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