ActsExamples/DetectorCommons/Detector.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 "Acts/Geometry/GeometryContext.hpp"
0012
0013 #include <memory>
0014 #include <vector>
0015
0016 namespace Acts {
0017 class GeometryContext;
0018 class TrackingGeometry;
0019 class DetectorElementBase;
0020 class Logger;
0021 }  // namespace Acts
0022
0023 namespace ActsExamples {
0024 class IContextDecorator;
0025 struct Geant4ConstructionOptions;
0026 }  // namespace ActsExamples
0027
0028 class G4VUserDetectorConstruction;
0029
0030 namespace ActsExamples {
0031
0032 ///  @brief Baseline class to represent a complete experimental setup. The Detector
0033 ///         is constructed by an external geometry plugin (e.g. DD4Hep,
0034 ///         GeoModel) and holds the tracking geometry representation & the full
0035 ///         Geant4 geometry description.
0036 class Detector {
0037  public:
0038   /// @brief Standard constructor taking a logger object
0039   explicit Detector(std::unique_ptr<const Acts::Logger> logger);
0040   virtual ~Detector();
0041   /// @brief Returns the reference to the empty unaligned geometry context
0042   virtual const Acts::GeometryContext& nominalGeometryContext() const;
0043   /// @brief Returns the valid pointer to the tracking geometry.
0044   ///        Throws an exception if the pointer is invalid
0045   virtual std::shared_ptr<const Acts::TrackingGeometry> trackingGeometry()
0046       const;
0047   /// @brief Returns the valid pointer to the Gen-2 tracking geometry.
0048   ///        Throws an exception if the pointer is invalid
0049   virtual std::vector<std::shared_ptr<IContextDecorator>> contextDecorators()
0050       const;
0051
0052   /// Build the Geant4 detector construction
0053   /// @note This throws an exception if Geant4 is not enabled
0054   /// @param options The Geant4 construction options
0055   /// @return The Geant4 detector construction
0056   virtual std::unique_ptr<G4VUserDetectorConstruction>
0057   buildGeant4DetectorConstruction(
0058       const Geant4ConstructionOptions& options) const;
0059
0060  protected:
0061   const Acts::Logger& logger() const;
0062
0063   std::unique_ptr<const Acts::Logger> m_logger;
0064
0065   Acts::GeometryContext m_nominalGeometryContext;
0066   std::shared_ptr<const Acts::TrackingGeometry> m_trackingGeometry;
0067   std::vector<std::shared_ptr<const Acts::DetectorElementBase>> m_detectorStore;
0068   std::vector<std::shared_ptr<IContextDecorator>> m_contextDecorators;
0069 };
0070
0071 }  // namespace ActsExamples