Acts/Geometry/IConfinedTrackingVolumeBuilder.hpp

0001 // This file is part of the ACTS project.
0002 //
0003 // Copyright (C) 2016 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 https://mozilla.org/MPL/2.0/.
0008
0009 #pragma once
0010
0011 #include <memory>
0012 #include <vector>
0013
0014 namespace Acts {
0015
0016 class TrackingVolume;
0017
0018 /// @typedef MutableTrackingVolumePtr
0019 /// Shared pointer to a mutable TrackingVolume.
0020 using MutableTrackingVolumePtr = std::shared_ptr<TrackingVolume>;
0021
0022 /// @typedef MutableTrackingVolumeVector
0023 /// Vector of shared pointers to mutable TrackingVolumes.
0024 using MutableTrackingVolumeVector = std::vector<MutableTrackingVolumePtr>;
0025
0026 /// @brief This is an interface class for constructing TrackingVolumes whose are
0027 /// confined in a mother-TrackingVolume
0028 class IConfinedTrackingVolumeBuilder {
0029  public:
0030   /// Virtual destructor
0031   virtual ~IConfinedTrackingVolumeBuilder() = default;
0032
0033   /// Interface for constructing a vector of confined TrackingVolumes
0034   /// @return Vector of shared pointers to the constructed confined tracking volumes
0035   virtual MutableTrackingVolumeVector centralVolumes() const = 0;
0036
0037   /// Interface for retrieving the identification string of the confined volumes
0038   /// @return Const reference to the identification string
0039   virtual const std::string& identification() const = 0;
0040 };
0041
0042 }  // namespace Acts