Plugins/Json/IVolumeMaterialJsonDecorator.hpp

0001 // This file is part of the Acts project.
0002 //
0003 // Copyright (C) 2017-2023 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 "Acts/Plugins/Json/ActsJson.hpp"
0012
0013 namespace Acts {
0014 class ISurfaceMaterial;
0015 class IVolumeMaterial;
0016
0017 /// helper class to add extra information to surface or volume json objects
0018 class IVolumeMaterialJsonDecorator {
0019  public:
0020   virtual ~IVolumeMaterialJsonDecorator() = default;
0021
0022   /// Add extra elements to the json object already filled for the given
0023   /// surface material
0024   ///
0025   /// @param material the surface material which was used to
0026   ///    fill the json object
0027   /// @param json the json object that is enhanced
0028   virtual void decorate(const Acts::ISurfaceMaterial &material,
0029                         nlohmann::json &json) const = 0;
0030
0031   /// Add extra elements to the json object already filled for the given
0032   /// volume material
0033   ///
0034   /// @param material the volume material which was used to
0035   ///    fill the json object
0036   /// @param json the json object that is enhanced
0037   virtual void decorate(const Acts::IVolumeMaterial &material,
0038                         nlohmann::json &json) const = 0;
0039 };
0040 }  // namespace Acts