IAlgorithm.h

Go to the documentation of this file.

// $Id: IAlgorithm.h,v 1.12 2008/10/17 13:06:04 marcocle Exp $
#ifndef GAUDIKERNEL_IALGORITHM_H
#define GAUDIKERNEL_IALGORITHM_H

// Include files
#include "GaudiKernel/INamedInterface.h"
#include "GaudiKernel/StateMachine.h"
#include <string>

class GAUDI_API IAlgorithm : virtual public INamedInterface {
public:
  DeclareInterfaceID(IAlgorithm,4,0);

  virtual const std::string& version() const = 0;

  virtual StatusCode execute() = 0;

  virtual bool isInitialized() const = 0;
  virtual bool isFinalized() const = 0;
  virtual bool isExecuted() const = 0;

  // --- Methods from IStateful ---
  virtual StatusCode configure() = 0;

  virtual StatusCode initialize() = 0;

  virtual StatusCode start() = 0;

  virtual StatusCode stop() = 0;

  virtual StatusCode finalize() = 0;

  virtual StatusCode terminate() = 0;

  virtual StatusCode reinitialize() = 0;

  virtual StatusCode restart() = 0;

  virtual Gaudi::StateMachine::State FSMState() const = 0;

  virtual StatusCode sysInitialize() = 0;

  virtual StatusCode sysStart() = 0;

  virtual StatusCode sysReinitialize() = 0;

  virtual StatusCode sysRestart() = 0;

  virtual StatusCode sysExecute() = 0;

  virtual StatusCode sysStop() = 0;

  virtual StatusCode sysFinalize() = 0;

  virtual StatusCode sysBeginRun( ) = 0;

  virtual StatusCode sysEndRun( ) = 0;

  virtual void resetExecuted( ) = 0;

  virtual StatusCode beginRun() = 0;
  virtual StatusCode endRun() = 0;


  // ---- Function useful for dealing with sub-algorithms
  virtual void setExecuted( bool state ) = 0;

  virtual bool isEnabled( ) const = 0;

  virtual bool filterPassed( ) const = 0;

  virtual void setFilterPassed( bool state ) = 0;

};

#endif // GAUDIKERNEL_IALGORITHM_H