GeometryBuilderStandard.h

Go to the documentation of this file.

#ifndef LARCOREALG_GEOMETRY_GEOMETRYBUILDERSTANDARD_H
#define LARCOREALG_GEOMETRY_GEOMETRYBUILDERSTANDARD_H

// LArSoft libraries
#include "larcorealg/Geometry/AuxDetGeo.h"
#include "larcorealg/Geometry/AuxDetSensitiveGeo.h"
#include "larcorealg/Geometry/CryostatGeo.h"
#include "larcorealg/Geometry/GeometryBuilder.h"
#include "larcorealg/Geometry/OpDetGeo.h"
#include "larcorealg/Geometry/PlaneGeo.h"
#include "larcorealg/Geometry/TPCGeo.h"
#include "larcorealg/Geometry/WireGeo.h"

// support libraries
#include "fhiclcpp/types/Atom.h"

// ROOT libraries
#include "TGeoNode.h"

// C++ standard library
#include <functional>
#include <limits> // std::numeric_limits<>
#include <string_view>

namespace geo {

  class GeometryBuilderStandard : public GeometryBuilder {

  public:
    struct Config {

      using Name = fhicl::Name;
      using Comment = fhicl::Comment;

      fhicl::Atom<Path_t::Depth_t> maxDepth{
        Name("maxDepth"),
        Comment("maximum number of level of the geometry structure to descend"),
        std::numeric_limits<Path_t::Depth_t>::max() // default
      };

      fhicl::Atom<std::string> opDetGeoName{
        Name("opDetGeoName"),
        Comment("the start of the name of optical detector GDML nodes"),
        "volOpDetSensitive" // default
      };

    }; // struct Config

    GeometryBuilderStandard(Config const& config);

    //
    // we don't expand the public interface here
    //

  protected:
    Path_t::Depth_t fMaxDepth = std::numeric_limits<Path_t::Depth_t>::max();

    std::string fOpDetGeoName = "volOpDetSensitive";

    // --- BEGIN Auxiliary detector information --------------------------------

    // extractAuxiliaryDetectors() and AuxDets_t are inherited public interface

    geo::AuxDetGeo makeAuxDet(Path_t& path) { return doMakeAuxDet(path); }

    virtual AuxDets_t doExtractAuxiliaryDetectors(Path_t& path) override;

    virtual geo::AuxDetGeo doMakeAuxDet(Path_t& path);

    // --- END Auxiliary detector information ----------------------------------

    // --- BEGIN Auxiliary detector sensitive volume information ---------------

    using AuxDetSensitive_t = GeoColl_t<geo::AuxDetSensitiveGeo>;

    AuxDetSensitive_t extractAuxDetSensitive(Path_t& path)
    {
      auto localPath = path;
      return doExtractAuxDetSensitive(localPath);
    }

    geo::AuxDetSensitiveGeo makeAuxDetSensitive(Path_t& path)
    {
      return doMakeAuxDetSensitive(path);
    }

    virtual AuxDetSensitive_t doExtractAuxDetSensitive(Path_t& path);

    virtual geo::AuxDetSensitiveGeo doMakeAuxDetSensitive(Path_t& path);

    // --- END Auxiliary detector sensitive volume information -----------------

    // --- BEGIN Cryostat information ------------------------------------------

    // extractCryostats() and Cryostats_t are inherited public interface

    geo::CryostatGeo makeCryostat(Path_t& path) { return doMakeCryostat(path); }

    virtual Cryostats_t doExtractCryostats(Path_t& path) override;

    virtual geo::CryostatGeo doMakeCryostat(Path_t& path);

    // --- END Cryostat information --------------------------------------------

    // --- BEGIN Optical detector information ----------------------------------

    using OpDets_t = GeoColl_t<geo::OpDetGeo>;

    OpDets_t extractOpDets(Path_t& path)
    {
      auto localPath = path;
      return doExtractOpDets(localPath);
    }

    geo::OpDetGeo makeOpDet(Path_t& path) { return doMakeOpDet(path); }

    virtual OpDets_t doExtractOpDets(Path_t& path);

    virtual geo::OpDetGeo doMakeOpDet(Path_t& path);

    // --- END Optical detector information ------------------------------------

    // --- BEGIN TPC information -----------------------------------------------

    using TPCs_t = GeoColl_t<geo::TPCGeo>;

    TPCs_t extractTPCs(Path_t& path)
    {
      auto localPath = path;
      return doExtractTPCs(localPath);
    }

    geo::TPCGeo makeTPC(Path_t& path) { return doMakeTPC(path); }

    virtual TPCs_t doExtractTPCs(Path_t& path);

    virtual geo::TPCGeo doMakeTPC(Path_t& path);

    // --- END TPC information -------------------------------------------------

    // --- BEGIN Plane information ---------------------------------------------

    using Planes_t = GeoColl_t<geo::PlaneGeo>;

    Planes_t extractPlanes(Path_t& path)
    {
      auto localPath = path;
      return doExtractPlanes(localPath);
    }

    geo::PlaneGeo makePlane(Path_t& path) { return doMakePlane(path); }

    virtual Planes_t doExtractPlanes(Path_t& path);

    virtual geo::PlaneGeo doMakePlane(Path_t& path);

    // --- END Plane information -----------------------------------------------

    // --- BEGIN Wire information ----------------------------------------------

    using Wires_t = GeoColl_t<geo::WireGeo>;

    Wires_t extractWires(Path_t& path)
    {
      auto localPath = path;
      return doExtractWires(localPath);
    }

    geo::WireGeo makeWire(Path_t& path) { return doMakeWire(path); }

    virtual Wires_t doExtractWires(Path_t& path);

    virtual geo::WireGeo doMakeWire(Path_t& path);

    // --- END Wire information ------------------------------------------------

  private:
    template <typename ObjGeo>
    GeoColl_t<ObjGeo> doExtractGeometryObjects(
      Path_t& path,
      std::function<bool(TGeoNode const&)> IsObj,
      ObjGeo (geo::GeometryBuilderStandard::*MakeObj)(Path_t&));

  }; // class GeometryBuilderStandard

} // namespace geo

#endif // LARCOREALG_GEOMETRY_GEOMETRYBUILDERSTANDARD_H