Plugins/Json/ITrackingGeometryJsonDecorator.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 TrackingVolume;
0015 class Surface;
0016
0017 /// helper class to add extra information to surface or volume json objects
0018 class ITrackingGeometryJsonDecorator {
0019  public:
0020   virtual ~ITrackingGeometryJsonDecorator() = default;
0021
0022   /// Add extra elements to the json object already filled for the given
0023   /// surface
0024   ///
0025   /// @param surface the surface which was used to fill the json object
0026   /// @param json the json object that is enhanced
0027   virtual void decorate(const Acts::Surface &surface,
0028                         nlohmann::json &json) const = 0;
0029
0030   /// Add extra elements to the json object already filled for the given
0031   /// volume
0032   ///
0033   /// @param volume the volume which was used to fill the json object
0034   /// @param json the json object that is enhanced
0035   virtual void decorate(const Acts::TrackingVolume &volume,
0036                         nlohmann::json &json) const = 0;
0037 };
0038 }  // namespace Acts