Acts/Geometry/ITrackingVolumeBuilder.hpp

0001 // This file is part of the Acts project.
0002 //
0003 // Copyright (C) 2016-2018 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 #include <tuple>
0015 #include <vector>
0016
0017 namespace Acts {
0018
0019 class VolumeBounds;
0020 class TrackingVolume;
0021 class Layer;
0022 class Volume;
0023 using TrackingVolumePtr = std::shared_ptr<const TrackingVolume>;
0024 using MutableTrackingVolumePtr = std::shared_ptr<TrackingVolume>;
0025 using LayerPtr = std::shared_ptr<const Layer>;
0026 using LayerVector = std::vector<LayerPtr>;
0027 ///  @class ITrackingVolumeBuilder
0028 ///
0029 /// Interface class ITrackingVolumeBuilders
0030 ///
0031 /// this returns the sub-detector tracking volume that is wrapped by the next
0032 /// outer one
0033 /// in the TrackingGeometry building process
0034 ///
0035 /// If an innerVolume is given, this is wrapped
0036 /// If a VolumeBounds object is given this defines the maximum extent.
0037 ///
0038
0039 class ITrackingVolumeBuilder {
0040  public:
0041   /// Virtual destructor
0042   virtual ~ITrackingVolumeBuilder() = default;
0043
0044   /// ITrackingVolumeBuilder interface method
0045   ///
0046   /// @param gctx is the geometry context for witch the volume is built
0047   /// @param oppositeVolume is an (optional) volume to be wrapped
0048   /// @param outsideBounds is an (optional) outside confinement
0049   ///
0050   /// @return shared pointer to a newly created TrackingVolume
0051   virtual MutableTrackingVolumePtr trackingVolume(
0052       const GeometryContext& gctx, TrackingVolumePtr oppositeVolume = nullptr,
0053       std::shared_ptr<const VolumeBounds> outsideBounds = nullptr) const = 0;
0054 };
0055
0056 }  // namespace Acts