ActsExamples/Framework/IWriter.hpp

0001 // This file is part of the Acts project.
0002 //
0003 // Copyright (C) 2017 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 #include "ActsExamples/Framework/SequenceElement.hpp"
0014
0015 #include <string>
0016
0017 namespace ActsExamples {
0018
0019 /// Event data writer interface.
0020 ///
0021 /// Get data from the event store and write it to disk. The writer can have
0022 /// internal state and implementations are responsible to handle concurrent
0023 /// calls.
0024 class IWriter : public SequenceElement {
0025  public:
0026   /// Write data from one event.
0027   virtual ProcessCode write(const AlgorithmContext& context) = 0;
0028
0029   /// Internal execute method forwards to the write method as mutable
0030   /// @param context The algorithm context
0031   ProcessCode internalExecute(const AlgorithmContext& context) final {
0032     return write(context);
0033   }
0034
0035   /// Fulfil the algorithm interface
0036   ProcessCode initialize() override { return ProcessCode::SUCCESS; }
0037 };
0038
0039 }  // namespace ActsExamples