The IAlgorithm is the interface implemented by the Algorithm base class.
More...
#include <GaudiKernel/IAlgorithm.h>
|
| virtual void | setIndex (const unsigned int &idx)=0 |
| | Set instantiation index of Alg. More...
|
| |
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 25 of file IAlgorithm.h.
Algorithm begin run.
This method is called at the beginning of the event loop.
| virtual unsigned int IAlgorithm::cardinality |
( |
| ) |
const |
|
pure virtual |
Cardinality (Maximum number of clones that can exist)
| IAlgorithm::DeclareInterfaceID |
( |
IAlgorithm |
, |
|
|
5 |
, |
|
|
0 |
|
|
) |
| |
Algorithm end run.
This method is called at the end of the event loop.
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::filterPassed |
( |
| ) |
const |
|
pure virtual |
Did this algorithm pass or fail its filter criterion for the last event?
| virtual unsigned int IAlgorithm::index |
( |
| ) |
const |
|
pure virtual |
The index of the algorithm.
| virtual bool IAlgorithm::isClonable |
( |
| ) |
const |
|
pure virtual |
Specify if the algorithm is clonable.
| virtual bool IAlgorithm::isEnabled |
( |
| ) |
const |
|
pure virtual |
Is this algorithm enabled or disabled?
| virtual bool IAlgorithm::isExecuted |
( |
| ) |
const |
|
pure virtual |
check if the algorithm is already executed for the current event
| virtual bool IAlgorithm::isFinalized |
( |
| ) |
const |
|
pure virtual |
check if the algorithm is finalized properly
| virtual bool IAlgorithm::isInitialized |
( |
| ) |
const |
|
pure virtual |
check if the algorithm is initialized properly
Named, non thread-safe resources used during event processing.
| virtual void IAlgorithm::resetExecuted |
( |
| ) |
|
|
pure virtual |
Reset the Algorithm executed state for the current event.
| virtual void IAlgorithm::setExecuted |
( |
bool |
state | ) |
|
|
pure virtual |
Set the executed flag to the specified state.
| virtual void IAlgorithm::setFilterPassed |
( |
bool |
state | ) |
|
|
pure virtual |
Set the filter passed flag to the specified state.
| virtual void IAlgorithm::setIndex |
( |
const unsigned int & |
idx | ) |
|
|
protectedpure virtual |
Set instantiation index of Alg.
| virtual void IAlgorithm::setType |
( |
const std::string & |
| ) |
|
|
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.
endRun method invoked by the framework.
This method is responsible for any endRun actions required by the framework itself. It will in turn invoke the endRun() method of the derived algorithm, and of any sub-algorithms which it creates.
System execution. This method invokes the execute() method of a concrete algorithm.
System finalization.
This method invokes the finalize() method of a concrete algorithm and the finalize() methods of all of that algorithm's sub algorithms.
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.
| 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.
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.
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.
System stop.
This method invokes the stop() method of a concrete algorithm and the stop() methods of all of that algorithm's sub algorithms.
The type of the algorithm.
| virtual const std::string& IAlgorithm::version |
( |
| ) |
const |
|
pure virtual |
The version of the algorithm.
| friend IAlgorithm::AlgResourcePool |
The documentation for this class was generated from the following file:
Public Member Functions inherited from extend_interfaces< INamedInterface, IStateful >
1.8.9.1 
