| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

In This Package:

IAlgContextSvc Class Reference

An abstract interface for Algorithm Context Service. More...

#include <IAlgContextSvc.h>

Inheritance diagram for IAlgContextSvc:

[legend]
Collaboration diagram for IAlgContextSvc:
[legend]
List of all members.

Public Types

typedef std::vector< IAlgorithm * > Algorithms
 the actual type of algorithm' stack
 SUCCESS = 1
 Normal successful completion.
 NO_INTERFACE
 Requested interface is not available.
 VERSMISMATCH
 Requested interface version is incompatible.
 LAST_ERROR
 Last error.
enum  Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
 Return status. More...

Public Member Functions

virtual StatusCode setCurrentAlg (IAlgorithm *a)=0
 set the currently executing algorithm ("push_back")
virtual StatusCode unSetCurrentAlg (IAlgorithm *a)=0
 remove the algorithm ("pop_back")
virtual IAlgorithmcurrentAlg () const =0
 accessor to current algorithm:
virtual const Algorithmsalgorithms () const =0
 get the stack of executed algorithms
virtual StatusCode queryInterface (const InterfaceID &riid, void **ppvInterface)=0
 Query interfaces of Interface.
virtual unsigned long addRef ()=0
 Increment the reference count of Interface instance.
virtual unsigned long release ()=0
 Release Interface instance.

Static Public Member Functions

static const InterfaceIDinterfaceID ()
 unique algorithm identification

Protected Member Functions

virtual ~IAlgContextSvc ()
 virtual and protected desctructor

Detailed Description

An abstract interface for Algorithm Context Service.

Author:
ATLAS Collaboration

Vanya BELYAEV ibelyaev@physics.syr.edu

Date:
2007-03-07 (modified)

Definition at line 28 of file IAlgContextSvc.h.


Member Typedef Documentation

typedef std::vector<IAlgorithm*> IAlgContextSvc::Algorithms

the actual type of algorithm' stack

Definition at line 32 of file IAlgContextSvc.h.


Member Enumeration Documentation

enum IInterface::Status [inherited]

Return status.

Enumerator:
SUCCESS  Normal successful completion.
NO_INTERFACE  Requested interface is not available.
VERSMISMATCH  Requested interface version is incompatible.
LAST_ERROR  Last error.

Reimplemented in IConversionSvc, IConverter, and IDataProviderSvc.

Definition at line 113 of file IInterface.h.

00113                 {
00115     SUCCESS = 1,
00117     NO_INTERFACE,
00119     VERSMISMATCH,
00121     LAST_ERROR
00122   };


Constructor & Destructor Documentation

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

virtual and protected desctructor


Member Function Documentation

virtual StatusCode IAlgContextSvc::setCurrentAlg ( IAlgorithm a  )  [pure virtual]

set the currently executing algorithm ("push_back")

virtual StatusCode IAlgContextSvc::unSetCurrentAlg ( IAlgorithm a  )  [pure virtual]

remove the algorithm ("pop_back")

virtual IAlgorithm* IAlgContextSvc::currentAlg (  )  const [pure virtual]

accessor to current algorithm:

virtual const Algorithms& IAlgContextSvc::algorithms (  )  const [pure virtual]

get the stack of executed algorithms

static const InterfaceID& IAlgContextSvc::interfaceID (  )  [static]

unique algorithm identification

Reimplemented from IInterface.

virtual StatusCode IInterface::queryInterface ( const InterfaceID riid,
void **  ppvInterface 
) [pure virtual, inherited]

Query interfaces of Interface.

Parameters:
riid ID of Interface to be retrieved
ppvInterface Pointer to Location for interface pointer

Implemented in Algorithm, AlgTool, Auditor, ConversionSvc, Converter, DataSvc, EventSelectorDataStream, MinimalEventLoopMgr, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::addRef (  )  [pure virtual, inherited]

Increment the reference count of Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::release (  )  [pure virtual, inherited]

Release Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.


The documentation for this class was generated from the following file:
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

Generated on Mon Apr 11 19:57:07 2011 for GaudiKernel by doxygen 1.4.7