Plugins/Json/ProtoAxisJsonConverter.hpp

0001 // This file is part of the ACTS project.
0002 //
0003 // Copyright (C) 2016 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 https://mozilla.org/MPL/2.0/.
0008
0009 #pragma once
0010
0011 #include "Acts/Plugins/Json/ActsJson.hpp"
0012 #include "Acts/Utilities/ProtoAxis.hpp"
0013
0014 #include <nlohmann/json.hpp>
0015
0016 /// Custom Json encoder/decoders. Naming is mandated by nlohmann::json and thus
0017 /// can not match our naming guidelines.
0018 ///
0019 /// This uses a custom API and nomenclature as it would
0020 /// otherwise require the ProtoAxis to have a default
0021 /// constructor which is deleted
0022 namespace Acts::ProtoAxisJsonConverter {
0023
0024 /// Write the ProtoAxis to a json object
0025 ///
0026 /// @param pa the proto axis to be written out
0027 nlohmann::json toJson(const ProtoAxis& pa);
0028
0029 /// Create a ProtoAxis from a json object
0030 ///
0031 /// @param j the json object to be read from
0032 Acts::ProtoAxis fromJson(const nlohmann::json& j);
0033
0034 }  // namespace Acts::ProtoAxisJsonConverter