Acts/Geometry/ILayerArrayCreator.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 #include "Acts/Utilities/BinnedArray.hpp"
0013 #include "Acts/Utilities/BinningType.hpp"
0014
0015 #include <memory>
0016 #include <vector>
0017
0018 namespace Acts {
0019
0020 class Layer;
0021 /// A std::shared_ptr to a Layer
0022 using LayerPtr = std::shared_ptr<const Layer>;
0023 /// A BinnedArray to a std::shared_ptr of a layer
0024 using LayerArray = BinnedArray<LayerPtr>;
0025 /// A vector of std::shared_ptr to layers
0026 using LayerVector = std::vector<LayerPtr>;
0027
0028 /// @class ILayerArrayCreator
0029 ///
0030 /// Interface class ILayerArrayCreators, it inherits from IAlgTool.
0031 ///
0032 /// It receives the LayerVector and creaets an array with NaivgationLayer
0033 /// objects
0034 /// filled in between.
0035 class ILayerArrayCreator {
0036  public:
0037   /// Virtual destructor
0038   virtual ~ILayerArrayCreator() = default;
0039
0040   /// LayerArrayCreator interface method
0041   ///
0042   /// @param gctx is the geometry context for witch the volume is built
0043   /// @param layers are the layers to be moved into an array
0044   /// @param min is the minimul value for binning
0045   /// @param max is the maximum value for binning
0046   /// @param btype is the binning type
0047   /// @param bvalue is the value in which the binning should be done
0048   ///
0049   /// @return unique pointer to a new LayerArray
0050   virtual std::unique_ptr<const LayerArray> layerArray(
0051       const GeometryContext& gctx, const LayerVector& layers, double min,
0052       double max, BinningType btype = arbitrary,
0053       BinningValue bvalue = binX) const = 0;
0054 };
0055 }  // namespace Acts