IAlgorithm.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2026 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
#include <GaudiKernel/INamedInterface.h>
#include <GaudiKernel/IStateful.h>
#include <map>
#include <string>
 
class IAlgTool;
class AlgResourcePool;
class AlgExecStateRef;
class EventContext;
 
namespace Gaudi {
  class StringKey;
}

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

  DeclareInterfaceID( IAlgorithm, 7, 0 );

  using AlgResources_t = std::map<Gaudi::StringKey, unsigned int, std::less<>>;

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

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

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

  virtual unsigned int index() const = 0;

  virtual bool isClonable() const { return false; }

  virtual unsigned int cardinality() const = 0;

  virtual const AlgResources_t& neededResources() const = 0;

  virtual StatusCode execute( const EventContext& ) const = 0;

  virtual bool isInitialized() const = 0;
  virtual bool isFinalized() 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 AlgExecStateRef execState( const EventContext& ctx ) const = 0;

  virtual bool isEnabled() const = 0;

  virtual bool isSequence() const = 0;

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

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