#include <GaudiKernel/IAlgorithm.h>
The IAlgorithm is the interface implemented by the Algorithm base class. Concrete algorithms, derived from the Algorithm base class are controlled via this interface.
- Author
- Paul Maley
-
D.Quarrie
-
Marco Clemencic
Definition at line 38 of file IAlgorithm.h.
◆ cardinality()
| virtual unsigned int IAlgorithm::cardinality |
( |
| ) |
const |
|
pure virtual |
Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
◆ DeclareInterfaceID()
| IAlgorithm::DeclareInterfaceID |
( |
IAlgorithm |
, |
|
|
7 |
, |
|
|
0 |
|
|
) |
| |
◆ execState()
◆ execute()
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.
◆ index()
| virtual unsigned int IAlgorithm::index |
( |
| ) |
const |
|
pure virtual |
The index of the algorithm.
◆ isClonable()
| virtual bool IAlgorithm::isClonable |
( |
| ) |
const |
|
inlinevirtual |
Specify if the algorithm is clonable.
Definition at line 64 of file IAlgorithm.h.
◆ isEnabled()
| virtual bool IAlgorithm::isEnabled |
( |
| ) |
const |
|
pure virtual |
Is this algorithm enabled or disabled?
◆ isFinalized()
| virtual bool IAlgorithm::isFinalized |
( |
| ) |
const |
|
pure virtual |
check if the algorithm is finalized properly
◆ isInitialized()
| virtual bool IAlgorithm::isInitialized |
( |
| ) |
const |
|
pure virtual |
check if the algorithm is initialized properly
◆ isReEntrant()
| virtual bool IAlgorithm::isReEntrant |
( |
| ) |
const |
|
pure virtual |
◆ isSequence()
| virtual bool IAlgorithm::isSequence |
( |
| ) |
const |
|
pure virtual |
◆ nameKey()
◆ neededResources()
Named, non thread-safe resources used during event processing.
◆ setIndex()
| virtual void IAlgorithm::setIndex |
( |
const unsigned int & |
idx | ) |
|
|
pure virtual |
Set instantiation index of Alg.
◆ setType()
◆ sysExecute()
System execution. This method invokes the execute() method of a concrete algorithm.
◆ sysFinalize()
System finalization.
This method invokes the finalize() method of a concrete algorithm and the finalize() methods of all of that algorithm's sub algorithms.
◆ sysInitialize()
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.
◆ sysReinitialize()
| 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.
◆ sysRestart()
Re-start method invoked by the framework.
This method is responsible for any re-start required by the framework itself. It will in turn invoke the restart() method of the derived algorithm, and of any sub-algorithms which it creates.
◆ sysStart()
Startup 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 start() method of the derived algorithm, and of any sub-algorithms which it creates.
◆ sysStop()
System stop.
This method invokes the stop() method of a concrete algorithm and the stop() methods of all of that algorithm's sub algorithms.
◆ toControlFlowExpression()
Produce string represention of the control flow expression.
◆ type()
The type of the algorithm.
◆ version()
| virtual const std::string& IAlgorithm::version |
( |
| ) |
const |
|
pure virtual |
The version of the algorithm.
◆ AlgResourcePool
| friend IAlgorithm::AlgResourcePool |
The documentation for this class was generated from the following file:
Public Types inherited from extend_interfaces< INamedInterface, IStateful >
1.8.18