Detector/interface/IDetectorBuilder.hpp

0001 // This file is part of the Acts project.
0002 //
0003 // Copyright (C) 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/Geometry/GeometryContext.hpp"
0012
0013 #include <memory>
0014
0015 namespace Acts::Experimental {
0016
0017 class Detector;
0018
0019 /// @brief This is the interface for building a Detector object
0020 ///
0021 /// This is the top level interface, all lower level building
0022 /// blocks should be done with detector component builders.
0023 ///
0024 /// @note As this is the last builder, the returned detector object
0025 /// is const and cannot be modified anymore.
0026 class IDetectorBuilder {
0027  public:
0028   virtual ~IDetectorBuilder() = default;
0029
0030   /// The virtual interface definition for detector builders
0031   ///
0032   /// @param gctx the geometry context at the creation of the internal structure
0033   ///
0034   /// @return a shared detector object
0035   virtual std::shared_ptr<const Detector> construct(
0036       const GeometryContext& gctx) const = 0;
0037 };
0038
0039 }  // namespace Acts::Experimental