Gaudi Framework, version v20r2
	Generated: 18 Jul 2008

AlgorithmHistory Class Reference

#include <AlgorithmHistory.h>

Inheritance diagram for AlgorithmHistory:

[legend]Collaboration diagram for AlgorithmHistory:

[legend]List of all members.

---

Detailed Description

AlgorithmHistory class definition.

Author:

: Charles Leggett

Definition at line 28 of file AlgorithmHistory.h.

Public Types
typedef std::vector< Property * >	PropertyList
typedef std::vector< const AlgorithmHistory * >	HistoryList
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 ()
virtual const CLID &	clID () const
	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 Algorithm *	algorithm () const
const PropertyList &	properties () const
const HistoryList &	subalgorithm_histories () const
const JobHistory *	jobHistory () const
Static Public Member Functions
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 Algorithm *	m_algorithm
PropertyList	m_properties
HistoryList	m_subalgorithm_histories
const JobHistory *	m_jobHistory

---

Member Typedef Documentation

typedef std::vector<Property*> AlgorithmHistory::PropertyList

Definition at line 33 of file AlgorithmHistory.h.

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

Definition at line 36 of file AlgorithmHistory.h.

---

Constructor & Destructor Documentation

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

Definition at line 32 of file AlgorithmHistory.cpp.

References std::vector< _Tp, _Alloc >::begin(), std::vector< _Tp, _Alloc >::end(), m_subalgorithm_histories, std::vector< _Tp, _Alloc >::push_back(), and Algorithm::subAlgorithms().

: 
  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 ( vector<Algorithm*>::const_iterator
        ialg=alg.subAlgorithms()->begin();
        ialg!=alg.subAlgorithms()->end(); ++ ialg ) {
    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 52 of file AlgorithmHistory.cpp.

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

AlgorithmHistory::~AlgorithmHistory

(

)

[virtual]

Definition at line 68 of file AlgorithmHistory.cpp.

References std::vector< _Tp, _Alloc >::begin(), std::vector< _Tp, _Alloc >::end(), and m_subalgorithm_histories.

                                    {
  for ( HistoryList::const_iterator
        iphist=m_subalgorithm_histories.begin();
        iphist!=m_subalgorithm_histories.end(); ++iphist ) {
    delete *iphist;
  }
}

---

Member Function Documentation

virtual const CLID& AlgorithmHistory::clID

(

)

const [inline, virtual]

Retrieve reference to class definition structure.

Reimplemented from HistoryObj.

Definition at line 76 of file AlgorithmHistory.h.

References classID().

{ return classID(); }

const CLID & AlgorithmHistory::classID

(

)

[static]

Retrieve reference to class definition structure (static access).

Reimplemented from HistoryObj.

Definition at line 76 of file AlgorithmHistory.cpp.

Referenced by clID().

                                      {

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

}

const std::string& AlgorithmHistory::algorithm_type

(

)

const [inline]

Definition at line 80 of file AlgorithmHistory.h.

References m_algorithm_type.

Referenced by operator<<().

{ return m_algorithm_type; }

const std::string& AlgorithmHistory::algorithm_version

(

)

const [inline]

Definition at line 83 of file AlgorithmHistory.h.

References m_algorithm_version.

Referenced by operator<<().

{ return m_algorithm_version; }

const std::string& AlgorithmHistory::algorithm_name

(

)

const [inline]

Definition at line 86 of file AlgorithmHistory.h.

References m_algorithm_name.

Referenced by operator<<(), and HistorySvc::registerDataHistory().

{ return m_algorithm_name; }

const Algorithm* AlgorithmHistory::algorithm

(

)

const [inline]

Definition at line 89 of file AlgorithmHistory.h.

References m_algorithm.

{ return m_algorithm; }

const PropertyList& AlgorithmHistory::properties

(

)

const [inline]

Definition at line 92 of file AlgorithmHistory.h.

References m_properties.

Referenced by HistorySvc::dumpProperties(), and operator<<().

{ return m_properties; }

const HistoryList& AlgorithmHistory::subalgorithm_histories

(

)

const [inline]

Definition at line 95 of file AlgorithmHistory.h.

References m_subalgorithm_histories.

Referenced by operator<<().

    { return m_subalgorithm_histories; }

const JobHistory* AlgorithmHistory::jobHistory

(

)

const [inline]

Definition at line 99 of file AlgorithmHistory.h.

References m_jobHistory.

{ return m_jobHistory; }

---

Member Data Documentation

std::string AlgorithmHistory::m_algorithm_type [private]

Definition at line 41 of file AlgorithmHistory.h.

Referenced by algorithm_type().

std::string AlgorithmHistory::m_algorithm_version [private]

Definition at line 44 of file AlgorithmHistory.h.

Referenced by algorithm_version().

std::string AlgorithmHistory::m_algorithm_name [private]

Definition at line 47 of file AlgorithmHistory.h.

Referenced by algorithm_name().

const Algorithm* AlgorithmHistory::m_algorithm [private]

Definition at line 50 of file AlgorithmHistory.h.

Referenced by algorithm().

PropertyList AlgorithmHistory::m_properties [private]

Definition at line 53 of file AlgorithmHistory.h.

Referenced by properties().

HistoryList AlgorithmHistory::m_subalgorithm_histories [private]

Definition at line 56 of file AlgorithmHistory.h.

Referenced by AlgorithmHistory(), subalgorithm_histories(), and ~AlgorithmHistory().

const JobHistory* AlgorithmHistory::m_jobHistory [private]

Definition at line 59 of file AlgorithmHistory.h.

Referenced by jobHistory().

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiKernel/v25r2/GaudiKernel/AlgorithmHistory.h
• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiKernel/v25r2/src/Lib/AlgorithmHistory.cpp

---