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

IToolSvc Class Reference

The interface implemented by the IToolSvc base class. More...

#include <GaudiKernel/IToolSvc.h>

Inheritance diagram for IToolSvc:

IInterface List of all members.

Public Methods

virtual StatusCode retrieve (const std::string& type, IAlgTool*& tool, const IInterface* parent=0, bool createIf=true ) = 0
 Retrieve tool with tool dependent part of the name automatically assigned. More...

virtual StatusCode retrieve (const std::string& type, const std::string& name, IAlgTool*& tool, const IInterface* parent=0, bool createIf=true) = 0
 Retrieve tool with tool dependent part of the name specified by the requester. More...

template<classT> StatusCode retrieveTool ( const std::string& type, T*& tool, const IInterface* parent=0, bool createIf=true )
 Retrieve specified tool sub-type with tool dependent part of the name automatically assigned. More...

template<classT> StatusCode retrieveTool ( const std::string& type, const std::string& name, T*& tool, const IInterface* parent=0, bool createIf=true )
 Retrieve specified tool sub-type with tool dependent part of the name tool dependent part of the name specified by the requester. More...


Static Public Methods

const InterfaceID& interfaceID ()
 Retrieve interface ID. More...

Detailed Description

The interface implemented by the IToolSvc base class.

Author(s):
G.Corti

Definition at line 19 of file IToolSvc.h.

Member Function Documentation

const InterfaceID & IToolSvc::interfaceID ( ) [inline, static]
 

Retrieve interface ID.

Reimplemented from IInterface.

Definition at line 23 of file IToolSvc.h.

StatusCode IToolSvc::retrieve ( const std::string & type,
const std::string & name,
IAlgTool *& tool,
const IInterface * parent = 0,
bool createIf = true ) [pure virtual]
 

Retrieve tool with tool dependent part of the name specified by the requester.

By default a tool will be created if it does not exist, unless otherwise specified. By default it will be a common tool unless a parent is specified. The parent of a common tool is automatically taken as the ToolSvc itself.

Parameters:
type   AlgTool type name
name   name to be assigned to tool dependent part of the name
tool   returned tool
parent   constant reference to parent (def=none)
createIf   creation flag (def=create if not existing)

StatusCode IToolSvc::retrieve ( const std::string & type,
IAlgTool *& tool,
const IInterface * parent = 0,
bool createIf = true ) [pure virtual]
 

Retrieve tool with tool dependent part of the name automatically assigned.

By default a tool will be created if it does not exist, unless otherwise specified. By default it will be a common tool unless a parent is specified. The parent of a common tool is automatically taken as the ToolSvc itself.

Parameters:
type   AlgTool type name
tool   returned tool
parent   constant reference to parent (def=none)
createIf   creation flag (def=create if not existing)

Referenced by retrieveTool().

template<classT>
StatusCode IToolSvc::retrieveTool ( const std::string & type,
const std::string & name,
T *& tool,
const IInterface * parent = 0,
bool createIf = true ) [inline]
 

Retrieve specified tool sub-type with tool dependent part of the name tool dependent part of the name specified by the requester.

Internally it uses the corresponding IToolSvc::retrieve and does the dynamic casting.

Parameters:
type   AlgTool type name
name   name to be assigned to tool dependent part of the name
tool   returned tool
parent   constant reference to parent (def=none)
createIf   creation flag (def=create if not existing)

Definition at line 91 of file IToolSvc.h.

template<classT>
StatusCode IToolSvc::retrieveTool ( const std::string & type,
T *& tool,
const IInterface * parent = 0,
bool createIf = true ) [inline]
 

Retrieve specified tool sub-type with tool dependent part of the name automatically assigned.

Internally it uses the corresponding IToolSvc::retrieve and does the dynamic casting.

Parameters:
tool   returned tool
parent   constant reference to parent (def=none)
createIf   creation flag (def=create if not existing)

Definition at line 65 of file IToolSvc.h.

The documentation for this class was generated from the following file:
Generated at Wed Nov 21 12:22:13 2001 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000