AlgToolHistory Class Reference

AlgToolHistory class definition. More...

#include <AlgToolHistory.h>

Inheritance diagram for AlgToolHistory:

Collaboration diagram for AlgToolHistory:

List of all members.

Public Member Functions
	AlgToolHistory (const AlgTool &alg, const JobHistory *job)
	AlgToolHistory (const std::string &algVersion, const std::string &algName, const std::string &algType, const AlgTool *tool, const PropertyList &props, const JobHistory *job)
virtual	~AlgToolHistory ()
virtual const CLID &	clID () const
	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
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
Static Public Member Functions
static const CLID &	classID ()
	Retrieve reference to class definition structure (static access)
Private Attributes
std::string	m_type
std::string	m_version
	Version number.
std::string	m_name
const AlgTool *	m_tool
PropertyList	m_properties
const JobHistory *	m_jobHistory

---

Detailed Description

AlgToolHistory class definition.

Author:

: Charles Leggett

Definition at line 24 of file AlgToolHistory.h.

---

Constructor & Destructor Documentation

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

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

virtual AlgToolHistory::~AlgToolHistory

(

)

[inline, virtual]

Definition at line 58 of file AlgToolHistory.h.

{};

---

Member Function Documentation

const AlgTool* AlgToolHistory::algtool_instance

(

)

const [inline]

Definition at line 74 of file AlgToolHistory.h.

{ return m_tool; }

const std::string& AlgToolHistory::algtool_name

(

)

const [inline]

Definition at line 71 of file AlgToolHistory.h.

{ return m_name; }

const std::string& AlgToolHistory::algtool_type

(

)

const [inline]

Definition at line 65 of file AlgToolHistory.h.

{ return m_type; }

const std::string& AlgToolHistory::algtool_version

(

)

const [inline]

Definition at line 68 of file AlgToolHistory.h.

{ return m_version; }

const CLID & AlgToolHistory::classID

(

)

[static]

Retrieve reference to class definition structure (static access)

Retrieve Pointer to class definition structure.

Reimplemented from HistoryObj.

Definition at line 52 of file AlgToolHistory.cpp.

                                    {

  static CLID CLID_AlgToolHistory = 171959758;   // from `clid AlgToolHistory`
  return CLID_AlgToolHistory;

}

virtual const CLID& AlgToolHistory::clID

(

)

const [inline, virtual]

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented from HistoryObj.

Definition at line 61 of file AlgToolHistory.h.

{ return classID(); }

void AlgToolHistory::dump	(	std::ostream &	ost,
		const bool	isXML = false,
		int	indent = 0
	)		const [virtual]

Implements HistoryObj.

Definition at line 62 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 ( AlgToolHistory::PropertyList::const_iterator
            ipprop=properties().begin();
          ipprop!=properties().end(); ++ipprop ) {
      const Property& prop = **ipprop;
      prop.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 ( AlgToolHistory::PropertyList::const_iterator
            ipprop=properties().begin();
          ipprop!=properties().end(); ++ipprop ) {
      const Property& prop = **ipprop;

      indent(ost,ind+2);
      ost << "<PROPERTY name=\"" << prop.name() 
          << "\" value=\"" << convert_string(prop.toString()) 
          << "\" documentation=\"" << convert_string(prop.documentation())
          << "\">" << endl;
    }

    indent(ost,ind);
    ost << "</COMPONENT>" << endl;

  }

}

const std::string& AlgToolHistory::name

(

)

const [inline, virtual]

Implements IVersHistoryObj.

Definition at line 81 of file AlgToolHistory.h.

{ return algtool_name(); }

const PropertyList& AlgToolHistory::properties

(

)

const [inline, virtual]

Implements IVersHistoryObj.

Definition at line 77 of file AlgToolHistory.h.

{ return m_properties; }

const std::string& AlgToolHistory::type

(

)

const [inline, virtual]

Implements IVersHistoryObj.

Definition at line 82 of file AlgToolHistory.h.

{ return algtool_type(); }

const std::string& AlgToolHistory::version

(

)

const [inline, virtual]

Implements IVersHistoryObj.

Definition at line 83 of file AlgToolHistory.h.

{ return algtool_version(); }

---

Member Data Documentation

const JobHistory* AlgToolHistory::m_jobHistory [private]

Definition at line 44 of file AlgToolHistory.h.

std::string AlgToolHistory::m_name [private]

Definition at line 35 of file AlgToolHistory.h.

PropertyList AlgToolHistory::m_properties [private]

Definition at line 41 of file AlgToolHistory.h.

const AlgTool* AlgToolHistory::m_tool [private]

Definition at line 38 of file AlgToolHistory.h.

std::string AlgToolHistory::m_type [private]

Definition at line 29 of file AlgToolHistory.h.

std::string AlgToolHistory::m_version [private]

Version number.

Reimplemented from DataObject.

Definition at line 32 of file AlgToolHistory.h.

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r0/GaudiKernel/GaudiKernel/AlgToolHistory.h
• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r0/GaudiKernel/src/Lib/AlgToolHistory.cpp