readout_types_fhicl.h

Go to the documentation of this file.

#ifndef LARCOREOBJ_SIMPLETYPESANDCONSTANTS_READOUT_TYPES_FHICL_H
#define LARCOREOBJ_SIMPLETYPESANDCONSTANTS_READOUT_TYPES_FHICL_H

// LArSoft libraries
#include "larcoreobj/SimpleTypesAndConstants/geo_types_fhicl.h"
#include "larcoreobj/SimpleTypesAndConstants/readout_types.h"

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

namespace geo::fhicl {

  template <>
  struct IDConfig<readout::TPCsetID> : public IDConfig<readout::CryostatID> {
    using ID_t = readout::TPCsetID; 

    ::fhicl::Atom<readout::TPCsetID::TPCsetID_t> S{
      ::fhicl::Name("S"),
      ::fhicl::Comment("TPC set number within the cryostat"),
      [this]() { return valid(); }};

    ID_t ID() const { return !valid() ? ID_t{} : ID_t{IDConfig<readout::CryostatID>::ID(), S()}; }
    operator ID_t() const { return ID(); }
  }; // struct IDConfig<readout::TPCsetID>

  template <>
  struct IDConfig<readout::ROPID> : public IDConfig<readout::TPCsetID> {
    using ID_t = readout::ROPID; 

    ::fhicl::Atom<readout::ROPID::ROPID_t> R{
      ::fhicl::Name("R"),
      ::fhicl::Comment("Readout plane number within the TPC set"),
      [this]() { return valid(); }};

    ID_t ID() const { return !valid() ? ID_t{} : ID_t{IDConfig<readout::TPCsetID>::ID(), R()}; }
    operator ID_t() const { return ID(); }
  }; // struct IDConfig<readout::ROPID>

} // namespace geo::fhicl

namespace readout::fhicl {

  // --- BEGIN -- Importing from geo::fhicl namespace --------------------------

  //
  // types
  //
  using geo::fhicl::IDConfig;
  using geo::fhicl::IDof;
  using geo::fhicl::IDparameter;
  using geo::fhicl::IDparameterTraits;
  using geo::fhicl::IDsequence;
  using geo::fhicl::OptionalID;
  using geo::fhicl::OptionalIDsequence;

  //
  // utilities
  //
  using geo::fhicl::readID;
  using geo::fhicl::readIDsequence;
  using geo::fhicl::readOptionalID;
  using geo::fhicl::readOptionalIDsequence;
  using geo::fhicl::readParameter;

  // --- END -- Importing from geo::fhicl namespace ----------------------------

  // --- BEGIN -- Validated configuration parameters for readout ID objects ----

  // --- BEGIN -- Cryostat ID --------------------------------------------------
  //
  // because `readout::CryostatID` is an alias of `geo::CryostatID`,
  // the following types are also aliases of the corresponding `geo::fhicl` ones
  //

  using CryostatID = IDparameter<readout::CryostatID>;

  using OptionalCryostatID = OptionalID<readout::CryostatID>;

  using CryostatIDsequence = IDsequence<readout::CryostatID>;

  using OptionalCryostatIDsequence = OptionalIDsequence<readout::CryostatID>;

  // --- END -- Cryostat ID ----------------------------------------------------

  // --- BEGIN -- TPC set ID ---------------------------------------------------

  using TPCsetID = IDparameter<readout::TPCsetID>;

  using OptionalTPCsetID = OptionalID<readout::TPCsetID>;

  using TPCsetIDsequence = IDsequence<readout::TPCsetID>;

  using OptionalTPCsetIDsequence = OptionalIDsequence<readout::TPCsetID>;

  // --- END -- TPC set ID -----------------------------------------------------

  // --- BEGIN -- Readout plane ID ---------------------------------------------

  using ROPID = IDparameter<readout::ROPID>;

  using OptionalROPID = OptionalID<readout::ROPID>;

  using ROPIDsequence = IDsequence<readout::ROPID>;

  using OptionalROPIDsequence = OptionalIDsequence<readout::ROPID>;

  // --- END -- Readout plane ID -----------------------------------------------

  // --- END -- Validated configuration parameters for readout ID objects ------

} // namespace readout::fhicl

// -----------------------------------------------------------------------------

#endif // LARCOREOBJ_SIMPLETYPESANDCONSTANTS_READOUT_TYPES_FHICL_H