Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members

AlgTool Class Reference

Base class from which all the concrete tool classes should be derived. More...

#include <GaudiKernel/AlgTool.h>

Inheritance diagram for AlgTool:

Public Methods
virtual StatusCode	queryInterface (const IID& riid, void** ppvUnknown)
	Methods for IInterface interface implementation, Query interface. More...
virtual unsigned long	addRef ()
	Reference Interface instance. More...
virtual unsigned long	release ()
	Release Interface instance. More...
virtual const std::string&	name () const
	Retrieve full identifying name of the concrete tool object. More...
virtual const std::string&	type () const
	Retrieve type (concrete class) of the sub-algtool. More...
virtual const IInterface*	parent () const
	Retrieve parent of the sub-algtool. More...
virtual StatusCode	setProperty (const Property& p)
	Default implementations for IProperty interface. More...
virtual StatusCode	setProperty ( std::istream& s )
	Set the property by istream. More...
virtual StatusCode	setProperty ( const std::string& n, const std::string& v)
	Set the property by std::string. More...
virtual StatusCode	getProperty (Property* p) const
	Get the property by property. More...
virtual const Property&	getProperty ( const std::string& name) const
	Get the property by name. More...
virtual StatusCode	getProperty ( const std::string& n, std::string& v ) const
	Get the property by std::string. More...
virtual const std::vector< Property*>&	getProperties ( ) const
	Get list of properties. More...
	AlgTool ( const std::string& type, const std::string& name, const IInterface* parent)
	Standard Constructor. More...
ISvcLocator*	serviceLocator ()
	Retrieve pointer to service locator. More...
IMessageSvc*	msgSvc ()
	Retrieve pointer to message service. More...
IMessageSvc*	msgSvc () const
StatusCode	setProperties ()
	Method for setting declared properties to the values specified in the jobOptions via the job option service. More...
template<classT> StatusCode	declareProperty ( const std::string& name, T& property ) const
	Declare named properties. More...
Protected Methods
virtual	~AlgTool ()
Private Attributes
int	m_outputLevel
	AlgTool output level. More...
std::string	m_type
	AlgTool type (concrete class name). More...
const std::string	m_name
	AlgTool full name. More...
const IInterface*	m_parent
	AlgTool parent. More...
unsigned long	m_refCount
	Reference counter. More...
ISvcLocator*	m_svcLocator
	Pointer to Service Locator service. More...
IMessageSvc*	m_messageSvc
	Message service. More...
PropertyMgr*	m_propertyMgr
	Property Manager. More...

Detailed Description

Base class from which all the concrete tool classes should be derived.

Specific methods for doing something usefull should be implemented in the concrete tools. Sub-types of this class could implement an additional interface for behaviour common to sets of concrete tools (for example vertexers).

Author(s):: Gloria Corti , Pere Mato

Definition at line 29 of file AlgTool.h.

Constructor & Destructor Documentation

AlgTool::AlgTool ( const std::string & type,

const std::string & name,

const IInterface * parent )

Standard Constructor.

Parameters:

type the concrete class of the sub-algtool

name the full name of the concrete sub-algtool

parent the parent of the concrete sub-algtool

Definition at line 127 of file AlgTool.cpp.

AlgTool::~AlgTool ( ) [protected, virtual]

Definition at line 172 of file AlgTool.cpp.

Member Function Documentation

unsigned long AlgTool::addRef ( ) [virtual]

Reference Interface instance.

Reimplemented from IInterface.
Definition at line 14 of file AlgTool.cpp.
Referenced by queryInterface().

template<classT>

StatusCode AlgTool::declareProperty ( const std::string & name,

T & property ) const [inline]

Declare named properties.

Definition at line 91 of file AlgTool.h.
Referenced by AlgTool().

const std::vector< Property *>& AlgTool::getProperties ( ) const [virtual]

Get list of properties.

Reimplemented from IProperty.
Definition at line 102 of file AlgTool.cpp.

StatusCode AlgTool::getProperty ( const std::string & n,

std::string & v ) const [virtual]

Get the property by std::string.

Reimplemented from IProperty.
Definition at line 97 of file AlgTool.cpp.

const Property & AlgTool::getProperty ( const std::string & n ) const [virtual]

Get the property by name.

Reimplemented from IProperty.
Definition at line 93 of file AlgTool.cpp.

StatusCode AlgTool::getProperty ( Property * p ) const [virtual]

Get the property by property.

Reimplemented from IProperty.
Definition at line 88 of file AlgTool.cpp.

IMessageSvc * AlgTool::msgSvc ( ) const

Definition at line 71 of file AlgTool.cpp.

IMessageSvc * AlgTool::msgSvc ( )

Retrieve pointer to message service.

Definition at line 68 of file AlgTool.cpp.

const std::string & AlgTool::name ( ) const [virtual]

Retrieve full identifying name of the concrete tool object.

Reimplemented from IAlgTool.
Definition at line 48 of file AlgTool.cpp.
Referenced by setProperties().

const IInterface * AlgTool::parent ( ) const [virtual]

Retrieve parent of the sub-algtool.

Reimplemented from IAlgTool.
Definition at line 58 of file AlgTool.cpp.

StatusCode AlgTool::queryInterface ( const IID & riid,

void ** ppvInterface ) [virtual]

Methods for IInterface interface implementation, Query interface.

Parameters:

riid ID of Interface to be retrieved

ppvUnknown Pointer to Location for interface pointer

Definition at line 29 of file AlgTool.cpp.

unsigned long AlgTool::release ( ) [virtual]

Release Interface instance.

Reimplemented from IInterface.
Definition at line 20 of file AlgTool.cpp.

ISvcLocator * AlgTool::serviceLocator ( )

Retrieve pointer to service locator.

Definition at line 63 of file AlgTool.cpp.

StatusCode AlgTool::setProperties ( )

Method for setting declared properties to the values specified in the jobOptions via the job option service.
This method is called by the ToolSvc after creating the concrete tool, before passing it to the requesting parent and does not need to be called explicitly.
Definition at line 107 of file AlgTool.cpp.

StatusCode AlgTool::setProperty ( const std::string & n,

const std::string & v ) [virtual]

Set the property by std::string.

Reimplemented from IProperty.
Definition at line 83 of file AlgTool.cpp.

StatusCode AlgTool::setProperty ( std::istream & s ) [virtual]

Set the property by istream.

Reimplemented from IProperty.
Definition at line 80 of file AlgTool.cpp.

StatusCode AlgTool::setProperty ( const Property & p ) [virtual]

Default implementations for IProperty interface.

Reimplemented from IProperty.
Definition at line 76 of file AlgTool.cpp.

const std::string & AlgTool::type ( ) const [virtual]

Retrieve type (concrete class) of the sub-algtool.

Reimplemented from IAlgTool.
Definition at line 53 of file AlgTool.cpp.

Member Data Documentation

IMessageSvc * AlgTool::m_messageSvc [private]

Message service.

Definition at line 109 of file AlgTool.h.

const std::string AlgTool::m_name [private]

AlgTool full name.

Definition at line 105 of file AlgTool.h.

int AlgTool::m_outputLevel [private]

AlgTool output level.

Definition at line 103 of file AlgTool.h.

const IInterface * AlgTool::m_parent [private]

AlgTool parent.

Definition at line 106 of file AlgTool.h.

PropertyMgr * AlgTool::m_propertyMgr [private]

Property Manager.

Definition at line 110 of file AlgTool.h.

unsigned long AlgTool::m_refCount [private]

Reference counter.

Definition at line 107 of file AlgTool.h.

ISvcLocator * AlgTool::m_svcLocator [private]

Pointer to Service Locator service.

Definition at line 108 of file AlgTool.h.

std::string AlgTool::m_type [private]

AlgTool type (concrete class name).

Definition at line 104 of file AlgTool.h.

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

Generated at Wed Nov 21 12:22:08 2001 by

AlgTool Class Reference

Public Methods

Protected Methods

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation