IAlgorithm.h

Go to the documentation of this file.

#ifndef GAUDIKERNEL_IALGORITHM_H
#define GAUDIKERNEL_IALGORITHM_H

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

class IAlgTool;
class AlgResourcePool;
class EventContext;

namespace Gaudi {
  class StringKey;
}

class GAUDI_API IAlgorithm : virtual public extend_interfaces<INamedInterface,
                                                              IStateful> {
public:

  friend AlgResourcePool;

  DeclareInterfaceID(IAlgorithm,6,0);

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

  virtual const std::string& type() const = 0;
  virtual void  setType(const std::string& ) = 0;

  virtual const Gaudi::StringKey& nameKey() const = 0;

  virtual unsigned int index() const = 0;

  virtual bool isClonable() const = 0;

  virtual unsigned int cardinality() const = 0;

  virtual const std::vector<std::string>& neededResources() const = 0;

  virtual StatusCode execute() = 0;

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

  virtual StatusCode sysInitialize() = 0;

  virtual StatusCode sysStart() = 0;

  virtual StatusCode sysReinitialize() = 0;

  virtual StatusCode sysRestart() = 0;

#define GAUDI_SYSEXECUTE_WITHCONTEXT 1

  virtual StatusCode sysExecute(const EventContext&) = 0;

  virtual StatusCode sysStop() = 0;

  virtual StatusCode sysFinalize() = 0;

  virtual StatusCode sysBeginRun( ) = 0;

  virtual StatusCode sysEndRun( ) = 0;

  [[deprecated("resetExecuted should be triggered globally via the AlgExecStateSvc, not individually for each Algorithm")]]
  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;

  virtual std::ostream& toControlFlowExpression(std::ostream& os) const = 0;

  virtual const EventContext& getContext() const = 0;

  virtual void setIndex(const unsigned int& idx) = 0;

};

#endif // GAUDIKERNEL_IALGORITHM_H