ActsExamples/Framework/IContextDecorator.hpp

0001 // This file is part of the Acts project.
0002 //
0003 // Copyright (C) 2019 CERN for the benefit of the Acts project
0004 //
0005 // This Source Code Form is subject to the terms of the Mozilla Public
0006 // License, v. 2.0. If a copy of the MPL was not distributed with this
0007 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
0008
0009 #pragma once
0010
0011 #include "ActsExamples/Framework/AlgorithmContext.hpp"
0012 #include "ActsExamples/Framework/ProcessCode.hpp"
0013
0014 #include <string>
0015
0016 namespace ActsExamples {
0017
0018 /// @brief Decorator for the AlgorithmContext with
0019 /// additional event specific information
0020 ///
0021 class IContextDecorator {
0022  public:
0023   /// Virtual destructor
0024   virtual ~IContextDecorator() = default;
0025
0026   /// @brief decorates (adds, modifies) the AlgorithmContext
0027   /// with additional event specific information, it is attached
0028   /// to the Sequencer
0029   ///
0030   /// @note If decorators depend on each other, they have to be
0031   /// added in order.
0032   ///
0033   /// @param context the bare (or at least non-const) Event context
0034   virtual ProcessCode decorate(AlgorithmContext& context) = 0;
0035
0036   /// @brief decorator name() for screen output
0037   virtual const std::string& name() const = 0;
0038 };
0039
0040 }  // namespace ActsExamples