AlgorithmHistory Class Reference

AlgorithmHistory class definition. More...

#include </tmp/marcocle/lhcb-release/1122/GAUDI/GAUDI_v27r0/InstallArea/x86_64-slc6-gcc49-opt/include/GaudiKernel/AlgorithmHistory.h>

Inheritance diagram for AlgorithmHistory:

Collaboration diagram for AlgorithmHistory:

Public Types
typedef std::vector< const AlgorithmHistory * >	HistoryList
typedef std::vector< const AlgorithmHistory * >	HistoryList
Public Types inherited from IVersHistoryObj
typedef std::vector< Property * >	PropertyList
typedef std::vector< Property * >	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 ()
virtual const CLID &	clID () const
	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
const HistoryList &	subalgorithm_histories () const
const JobHistory *	jobHistory () const
void	dump (std::ostream &, const bool isXML=false, int indent=0) const
const std::string &	name () const
const std::string &	type () const
const std::string &	version () const
	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. 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
const HistoryList &	subalgorithm_histories () const
const JobHistory *	jobHistory () const
void	dump (std::ostream &, const bool isXML=false, int indent=0) const
const std::string &	name () const
const std::string &	type () const
const std::string &	version () const
Public Member Functions inherited from HistoryObj
	HistoryObj ()=default
virtual	~HistoryObj ()=default
	HistoryObj ()=default
virtual	~HistoryObj ()=default
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...
	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...
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
virtual	~IVersHistoryObj ()=default

Static Public Member Functions
static const CLID &	classID ()
static const CLID &	classID ()
Static Public Member Functions inherited from HistoryObj
static const CLID &	classID ()
static std::string	convert_string (const std::string &)
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...
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
virtual void	indent (std::ostream &, int) const

Detailed Description

AlgorithmHistory class definition.

Author

: Charles Leggett

Definition at line 27 of file AlgorithmHistory.h.

Member Typedef Documentation

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

Definition at line 32 of file AlgorithmHistory.h.

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

Definition at line 32 of file AlgorithmHistory.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 30 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 48 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 65 of file AlgorithmHistory.cpp.

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

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

explicit

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

explicit

virtual AlgorithmHistory::~AlgorithmHistory ( )

virtual

Member Function Documentation

const Algorithm* AlgorithmHistory::algorithm ( ) const

inline

Definition at line 85 of file AlgorithmHistory.h.

{ return m_algorithm; }

const Algorithm* AlgorithmHistory::algorithm ( ) const

inline

Definition at line 85 of file AlgorithmHistory.h.

{ return m_algorithm; }

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

inline

Definition at line 82 of file AlgorithmHistory.h.

{ return m_algorithm_name; }

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

inline

Definition at line 82 of file AlgorithmHistory.h.

{ return m_algorithm_name; }

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

inline

Definition at line 76 of file AlgorithmHistory.h.

{ return m_algorithm_type; }

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

inline

Definition at line 76 of file AlgorithmHistory.h.

{ return m_algorithm_type; }

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

inline

Definition at line 79 of file AlgorithmHistory.h.

{ return m_algorithm_version; }

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

inline

Definition at line 79 of file AlgorithmHistory.h.

{ return m_algorithm_version; }

const CLID & AlgorithmHistory::classID ( )

static

Definition at line 72 of file AlgorithmHistory.cpp.

                          {

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

}

static const CLID& AlgorithmHistory::classID ( )

static

virtual const CLID& AlgorithmHistory::clID ( ) const

inlinevirtual

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented from HistoryObj.

Definition at line 72 of file AlgorithmHistory.h.

{ return classID(); }

virtual const CLID& AlgorithmHistory::clID ( ) const

inlinevirtual

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented from HistoryObj.

Definition at line 72 of file AlgorithmHistory.h.

{ return classID(); }

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

virtual

Implements HistoryObj.

Definition at line 82 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;

  }
}

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

virtual

Implements HistoryObj.

const JobHistory* AlgorithmHistory::jobHistory ( ) const

inline

Definition at line 95 of file AlgorithmHistory.h.

{ return m_jobHistory; }

const JobHistory* AlgorithmHistory::jobHistory ( ) const

inline

Definition at line 95 of file AlgorithmHistory.h.

{ return m_jobHistory; }

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

inlinevirtual

Implements IVersHistoryObj.

Definition at line 100 of file AlgorithmHistory.h.

{ return algorithm_name(); }

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

inlinevirtual

Implements IVersHistoryObj.

Definition at line 100 of file AlgorithmHistory.h.

{ return algorithm_name(); }

const PropertyList& AlgorithmHistory::properties ( ) const

inlinevirtual

Implements IVersHistoryObj.

Definition at line 88 of file AlgorithmHistory.h.

{ return m_properties; }

const PropertyList& AlgorithmHistory::properties ( ) const

inlinevirtual

Implements IVersHistoryObj.

Definition at line 88 of file AlgorithmHistory.h.

{ return m_properties; }

const HistoryList& AlgorithmHistory::subalgorithm_histories ( ) const

inline

Definition at line 91 of file AlgorithmHistory.h.

    { return m_subalgorithm_histories; }

const HistoryList& AlgorithmHistory::subalgorithm_histories ( ) const

inline

Definition at line 91 of file AlgorithmHistory.h.

    { return m_subalgorithm_histories; }

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

inlinevirtual

Implements IVersHistoryObj.

Definition at line 101 of file AlgorithmHistory.h.

{ return algorithm_type(); }

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

inlinevirtual

Implements IVersHistoryObj.

Definition at line 101 of file AlgorithmHistory.h.

{ return algorithm_type(); }

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

inlinevirtual

Implements IVersHistoryObj.

Definition at line 102 of file AlgorithmHistory.h.

{ return algorithm_version(); }

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

inlinevirtual

Implements IVersHistoryObj.

Definition at line 102 of file AlgorithmHistory.h.

{ return algorithm_version(); }

Member Data Documentation

const Algorithm * AlgorithmHistory::m_algorithm

private

Definition at line 46 of file AlgorithmHistory.h.

std::string AlgorithmHistory::m_algorithm_name

private

Definition at line 43 of file AlgorithmHistory.h.

std::string AlgorithmHistory::m_algorithm_type

private

Definition at line 37 of file AlgorithmHistory.h.

std::string AlgorithmHistory::m_algorithm_version

private

Definition at line 40 of file AlgorithmHistory.h.

const JobHistory * AlgorithmHistory::m_jobHistory

private

Definition at line 55 of file AlgorithmHistory.h.

PropertyList AlgorithmHistory::m_properties

private

Definition at line 49 of file AlgorithmHistory.h.

HistoryList AlgorithmHistory::m_subalgorithm_histories

private

Definition at line 52 of file AlgorithmHistory.h.

---

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

• InstallArea/x86_64-slc6-gcc49-opt/include/GaudiKernel/AlgorithmHistory.h
• GaudiKernel/src/Lib/AlgorithmHistory.cpp