LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
readout_types_fhicl.h File Reference

Utilities for using readout IDs in FHiCL validated configuration. More...

Go to the source code of this file.

Classes

struct  geo::fhicl::IDConfig< readout::TPCsetID >
 Configuration structure for validated readout::TPCsetID parameter. More...
 
struct  geo::fhicl::IDConfig< readout::ROPID >
 Configuration structure for validated readout::ROPID parameter. More...
 

Namespaces

 geo::fhicl
 FHiCL objects representing geometry classes as configuration parameters.
 
 readout::fhicl
 FHiCL objects representing geometry classes as configuration parameters.
 

Typedefs

Validated configuration parameters for readout ID objects

These data types can be used in a class for validated FHiCL configuration. They are implemented as configuration tables (fhicl::Table) of a configuration structure containing one parameter (fhicl::Atom) per index in the ID. They do not support default values, but optional parameters may be used as a workaround.

These objects have the same type of implementation and follow the same usage patterns as the ones for geometry ID objects defined and documented in geo::fhicl namespace.

This namespace offers:

  • a set of readout aliases, e.g. readout::fhicl::CryostatID, for cryostat IDs;
  • a set of classes for TPC set parameters, characterized by a configuration like { C:0 S:1 };
  • a set of classes for readout plane parameters, characterized by a configuration like { C:0 S:1 R:2 };
  • no facility for raw::ChannelID_t, which is a regular type and can be directly read with the standard fhicl objects.
using readout::fhicl::CryostatID = IDparameter< readout::CryostatID >
 Member type of validated readout::CryostatID parameter. More...
 
using readout::fhicl::OptionalCryostatID = OptionalID< readout::CryostatID >
 Member type of optional validated readout::CryostatID parameter. More...
 
using readout::fhicl::CryostatIDsequence = IDsequence< readout::CryostatID >
 Member type of sequence of readout::CryostatID parameters. More...
 
using readout::fhicl::OptionalCryostatIDsequence = OptionalIDsequence< readout::CryostatID >
 Member type of optional sequence of readout::CryostatID parameters. More...
 
using readout::fhicl::TPCsetID = IDparameter< readout::TPCsetID >
 Member type of validated readout::TPCsetID parameter. More...
 
using readout::fhicl::OptionalTPCsetID = OptionalID< readout::TPCsetID >
 Member type of optional validated readout::TPCsetID parameter. More...
 
using readout::fhicl::TPCsetIDsequence = IDsequence< readout::TPCsetID >
 Member type of sequence of readout::TPCsetID parameters. More...
 
using readout::fhicl::OptionalTPCsetIDsequence = OptionalIDsequence< readout::TPCsetID >
 Member type of optional sequence of readout::TPCsetID parameters. More...
 
using readout::fhicl::ROPID = IDparameter< readout::ROPID >
 Member type of validated readout::ROPID parameter. More...
 
using readout::fhicl::OptionalROPID = OptionalID< readout::ROPID >
 Member type of optional validated readout::ROPID parameter. More...
 
using readout::fhicl::ROPIDsequence = IDsequence< readout::ROPID >
 Member type of sequence of readout::ROPID parameters. More...
 
using readout::fhicl::OptionalROPIDsequence = OptionalIDsequence< readout::ROPID >
 Member type of optional sequence of readout::ROPID parameters. More...
 

Detailed Description

Utilities for using readout IDs in FHiCL validated configuration.

Author
Gianluca Petrillo (petri.nosp@m.llo@.nosp@m.slac..nosp@m.stan.nosp@m.ford..nosp@m.edu)
Date
November 26, 2019

This library is header-only.

Definition in file readout_types_fhicl.h.