---

IAlgorithm Class Reference

#include <GaudiKernel/IAlgorithm.h>

Inheritance diagram for IAlgorithm:

[legend]Collaboration diagram for IAlgorithm:

[legend]List of all members.

Public Methods
virtual StatusCode	initialize ()=0
virtual StatusCode	execute ()=0
virtual StatusCode	finalize ()=0
virtual const std::string &	name () const=0
	The identifying name of the algorithm object. More...
virtual StatusCode	sysInitialize ()=0
virtual StatusCode	sysExecute ()=0
	System execution. This method invokes the execute() method of a concrete algorithm. More...
virtual StatusCode	sysFinalize ()=0
virtual StatusCode	resetExecuted ()=0
	Reset the Algorithm executed state for the current event. More...
virtual StatusCode	beginRun ()=0
virtual StatusCode	endRun ()=0
Static Public Methods
const InterfaceID &	interfaceID ()
	Retrieve interface ID. More...

---

Detailed Description

The IAlgorithm is the interface implmented by the Algorithm base class. Concrete algorithms, derived from the Algorithm base class are controlled via this interface.

Author:

Paul Maley , D.Quarrie

---

Member Function Documentation

virtual StatusCode IAlgorithm::beginRun (    )  [pure virtual]

Algorithm begin run. This method is called at the beginning of the event loop. Reimplemented in Algorithm.

virtual StatusCode IAlgorithm::endRun (    )  [pure virtual]

Algorithm end run. This method is called at the end of the event loop. Reimplemented in Algorithm.

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. Reimplemented in Atlfast::AnalysisSkeleton, and Atlfast::AtlfastExample1.

virtual StatusCode IAlgorithm::finalize (    )  [pure virtual]

Algorithm finalization. This method should be overridden by concrete algorithm classes. It will typically be used for outputting statistical summaries of the algorithm's performance over an event sample. Reimplemented in Atlfast::AnalysisSkeleton, and Atlfast::AtlfastExample1.

virtual StatusCode IAlgorithm::initialize (    )  [pure virtual]

Initialization of a concrete algorithm object. Concrete algorithm classes should overide this method. Reimplemented in Atlfast::AnalysisSkeleton, and Atlfast::AtlfastExample1.

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

Retrieve interface ID. Reimplemented from IInterface.

virtual const std::string& IAlgorithm::name (    )  const [pure virtual]

The identifying name of the algorithm object. Reimplemented in Algorithm.

virtual StatusCode IAlgorithm::resetExecuted (    )  [pure virtual]

Reset the Algorithm executed state for the current event. Reimplemented in Algorithm.

virtual StatusCode IAlgorithm::sysExecute (    )  [pure virtual]

System execution. This method invokes the execute() method of a concrete algorithm. Reimplemented in Algorithm.

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. Reimplemented in Algorithm.

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. Reimplemented in Algorithm.

---

The documentation for this class was generated from the following file:

• IAlgorithm.h

---