IAlgorithm.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file IAlgorithm.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2017-2023 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.


#pragma once

#include "ActsExamples/Framework/ProcessCode.hpp"
#include "ActsExamples/Framework/SequenceElement.hpp"
#include <Acts/Utilities/Logger.hpp>

#include <memory>
#include <string>

namespace ActsExamples {
struct AlgorithmContext;

class IAlgorithm : public SequenceElement {
 public:
  IAlgorithm(std::string name,
             Acts::Logging::Level level = Acts::Logging::INFO);

  std::string name() const override;

  virtual ProcessCode execute(const AlgorithmContext& context) const = 0;

  ProcessCode internalExecute(const AlgorithmContext& context) final {
    return execute(context);
  };

  ProcessCode initialize() override { return ProcessCode::SUCCESS; }
  ProcessCode finalize() override { return ProcessCode::SUCCESS; }

 protected:
  const Acts::Logger& logger() const { return *m_logger; }

 private:
  std::string m_name;
  std::unique_ptr<const Acts::Logger> m_logger;
};
}  // namespace ActsExamples