#include <GaudiKernel/IAlgorithm.h>
Inheritance diagram for IAlgorithm:
Public Types | |
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 const std::string & | version () const =0 |
The version of the algorithm. | |
virtual StatusCode | execute ()=0 |
The action to be performed by the algorithm on an event. | |
virtual bool | isInitialized () const =0 |
check if the algorithm is initialized properly | |
virtual bool | isFinalized () const =0 |
check if the algorithm is finalized properly | |
virtual bool | isExecuted () const =0 |
check if the algorithm is already executed for the current event | |
virtual StatusCode | configure ()=0 |
Configuration (from OFFLINE to CONFIGURED). | |
virtual StatusCode | initialize ()=0 |
Initialization (from CONFIGURED to INITIALIZED). | |
virtual StatusCode | start ()=0 |
Start (from INITIALIZED to RUNNING). | |
virtual StatusCode | stop ()=0 |
Stop (from RUNNING to INITIALIZED). | |
virtual StatusCode | finalize ()=0 |
Finalize (from INITIALIZED to CONFIGURED). | |
virtual StatusCode | terminate ()=0 |
Initialization (from CONFIGURED to OFFLINE). | |
virtual StatusCode | reinitialize ()=0 |
Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). | |
virtual StatusCode | restart ()=0 |
Initialization (from RUNNING to RUNNING, via INITIALIZED). | |
virtual Gaudi::StateMachine::State | FSMState () const =0 |
Get the current state. | |
virtual StatusCode | sysInitialize ()=0 |
Initialization method invoked by the framework. | |
virtual StatusCode | sysStart ()=0 |
Startup method invoked by the framework. | |
virtual StatusCode | sysReinitialize ()=0 |
Re-initialization method invoked by the framework. | |
virtual StatusCode | sysRestart ()=0 |
Re-start method invoked by the framework. | |
virtual StatusCode | sysExecute ()=0 |
System execution. This method invokes the execute() method of a concrete algorithm. | |
virtual StatusCode | sysStop ()=0 |
System stop. | |
virtual StatusCode | sysFinalize ()=0 |
System finalization. | |
virtual StatusCode | sysBeginRun ()=0 |
beginRun method invoked by the framework. | |
virtual StatusCode | sysEndRun ()=0 |
endRun method invoked by the framework. | |
virtual void | resetExecuted ()=0 |
Reset the Algorithm executed state for the current event. | |
virtual StatusCode | beginRun ()=0 |
Algorithm begin run. | |
virtual StatusCode | endRun ()=0 |
Algorithm end run. | |
virtual void | setExecuted (bool state)=0 |
Set the executed flag to the specified state. | |
virtual bool | isEnabled () const =0 |
Is this algorithm enabled or disabled? | |
virtual bool | filterPassed () const =0 |
Did this algorithm pass or fail its filter criterion for the last event? | |
virtual void | setFilterPassed (bool state)=0 |
Set the filter passed flag to the specified state. | |
virtual const std::string & | name () const =0 |
Retrieve the name of the instance. | |
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 InterfaceID & | interfaceID () |
Retrieve interface ID. |
Concrete algorithms, derived from the Algorithm base class are controlled via this interface.
D.Quarrie
Definition at line 22 of file IAlgorithm.h.
enum IInterface::Status [inherited] |
Return status.
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 };
static const InterfaceID& IAlgorithm::interfaceID | ( | ) | [inline, static] |
Retrieve interface ID.
Reimplemented from INamedInterface.
Definition at line 25 of file IAlgorithm.h.
00025 { return IID_IAlgorithm; }
virtual const std::string& IAlgorithm::version | ( | ) | const [pure virtual] |
virtual StatusCode IAlgorithm::execute | ( | ) | [pure virtual] |
The action to be performed by the algorithm on an event.
This method is invoked once per event for top level algorithms by the application manager.
virtual bool IAlgorithm::isInitialized | ( | ) | const [pure virtual] |
virtual bool IAlgorithm::isFinalized | ( | ) | const [pure virtual] |
virtual bool IAlgorithm::isExecuted | ( | ) | const [pure virtual] |
virtual StatusCode IAlgorithm::configure | ( | ) | [pure virtual] |
virtual StatusCode IAlgorithm::initialize | ( | ) | [pure virtual] |
virtual StatusCode IAlgorithm::start | ( | ) | [pure virtual] |
virtual StatusCode IAlgorithm::stop | ( | ) | [pure virtual] |
virtual StatusCode IAlgorithm::finalize | ( | ) | [pure virtual] |
virtual StatusCode IAlgorithm::terminate | ( | ) | [pure virtual] |
virtual StatusCode IAlgorithm::reinitialize | ( | ) | [pure virtual] |
Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).
Implemented in Algorithm.
virtual StatusCode IAlgorithm::restart | ( | ) | [pure virtual] |
virtual Gaudi::StateMachine::State IAlgorithm::FSMState | ( | ) | const [pure virtual] |
virtual StatusCode IAlgorithm::sysInitialize | ( | ) | [pure virtual] |
Initialization method invoked by the framework.
This method is responsible for any bookkeeping of initialization required by the framework itself. It will in turn invoke the initialize() method of the derived algorithm, and of any sub-algorithms which it creates.
Implemented in Algorithm.
virtual StatusCode IAlgorithm::sysStart | ( | ) | [pure virtual] |
virtual StatusCode IAlgorithm::sysReinitialize | ( | ) | [pure virtual] |
Re-initialization method invoked by the framework.
This method is responsible for any re-initialization required by the framework itself. It will in turn invoke the reinitialize() method of the derived algorithm, and of any sub-algorithms which it creates.
Implemented in Algorithm.
virtual StatusCode IAlgorithm::sysRestart | ( | ) | [pure virtual] |
virtual StatusCode IAlgorithm::sysExecute | ( | ) | [pure virtual] |
virtual StatusCode IAlgorithm::sysStop | ( | ) | [pure virtual] |
virtual StatusCode IAlgorithm::sysFinalize | ( | ) | [pure virtual] |
System finalization.
This method invokes the finalize() method of a concrete algorithm and the finalize() methods of all of that algorithm's sub algorithms.
Implemented in Algorithm.
virtual StatusCode IAlgorithm::sysBeginRun | ( | ) | [pure virtual] |
beginRun method invoked by the framework.
This method is responsible for any beginRun actions required by the framework itself. It will in turn invoke the beginRun() method of the derived algorithm, and of any sub-algorithms which it creates.
Implemented in Algorithm.
virtual StatusCode IAlgorithm::sysEndRun | ( | ) | [pure virtual] |
virtual void IAlgorithm::resetExecuted | ( | ) | [pure virtual] |
virtual StatusCode IAlgorithm::beginRun | ( | ) | [pure virtual] |
virtual StatusCode IAlgorithm::endRun | ( | ) | [pure virtual] |
virtual void IAlgorithm::setExecuted | ( | bool | state | ) | [pure virtual] |
virtual bool IAlgorithm::isEnabled | ( | ) | const [pure virtual] |
virtual bool IAlgorithm::filterPassed | ( | ) | const [pure virtual] |
virtual void IAlgorithm::setFilterPassed | ( | bool | state | ) | [pure virtual] |
virtual const std::string& INamedInterface::name | ( | ) | const [pure virtual, inherited] |
virtual StatusCode IInterface::queryInterface | ( | const InterfaceID & | riid, | |
void ** | ppvInterface | |||
) | [pure virtual, inherited] |
Query interfaces of Interface.
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.