AthAlgorithm.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
// AthAlgorithm.h 
// Header file for class AthAlgorithm
// Author: S.Binet<binet@cern.ch>
#ifndef ATHENABASECOMPS_ATHALGORITHM_H
#define ATHENABASECOMPS_ATHALGORITHM_H 1
 
// STL includes
#include <string>
#include <type_traits>
 
 
// Framework includes
#include "AthenaBaseComps/AthCommonDataStore.h"
#include "AthenaBaseComps/AthCommonMsg.h"
#include "AthenaBaseComps/AthMemMacros.h"
#include "CxxUtils/checker_macros.h"
#include "Gaudi/Algorithm.h"
 
class EventContext;
 
 
class AthAlgorithm 
  : public AthCommonDataStore<AthCommonMsg< Gaudi::Algorithm >>
{ 
 public: 

  AthAlgorithm(const std::string& name, ISvcLocator* pSvcLocator);

  virtual ~AthAlgorithm(); 

  virtual StatusCode sysInitialize() override;
 
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Woverloaded-virtual"

  virtual StatusCode execute(const EventContext& ctx) = 0;
 
 private:
  // This is the base-class execute method that gets called by the scheduler.
  virtual StatusCode execute ( const EventContext& ctx ) const override final {
    // "Thread-safe" because scheduler ensures algorithm never gets called concurrently.
    auto nc_this ATLAS_THREAD_SAFE = const_cast<AthAlgorithm*>( this );
    return nc_this->execute( ctx );
  }
 
#pragma GCC diagnostic pop
 
 public:

  virtual const DataObjIDColl& extraOutputDeps() const override;


  const EventContext& getContext() const;
  bool filterPassed() const;
  void setFilterPassed(bool state) const;
 
  bool filterPassed(const EventContext& ctx) const;
  void setFilterPassed( bool state, const EventContext& ctx ) const;
 
 protected:
  virtual bool isReEntrant() const override final { return false; }
 
 private:
  DataObjIDColl m_extendedExtraObjects;
 
}; 
 
#endif //> !ATHENABASECOMPS_ATHALGORITHM_H