LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
readout::fhicl Namespace Reference

FHiCL objects representing geometry classes as configuration parameters. More...

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 CryostatID = IDparameter< readout::CryostatID >
 Member type of validated readout::CryostatID parameter. More...
 
using OptionalCryostatID = OptionalID< readout::CryostatID >
 Member type of optional validated readout::CryostatID parameter. More...
 
using CryostatIDsequence = IDsequence< readout::CryostatID >
 Member type of sequence of readout::CryostatID parameters. More...
 
using OptionalCryostatIDsequence = OptionalIDsequence< readout::CryostatID >
 Member type of optional sequence of readout::CryostatID parameters. More...
 
using TPCsetID = IDparameter< readout::TPCsetID >
 Member type of validated readout::TPCsetID parameter. More...
 
using OptionalTPCsetID = OptionalID< readout::TPCsetID >
 Member type of optional validated readout::TPCsetID parameter. More...
 
using TPCsetIDsequence = IDsequence< readout::TPCsetID >
 Member type of sequence of readout::TPCsetID parameters. More...
 
using OptionalTPCsetIDsequence = OptionalIDsequence< readout::TPCsetID >
 Member type of optional sequence of readout::TPCsetID parameters. More...
 
using ROPID = IDparameter< readout::ROPID >
 Member type of validated readout::ROPID parameter. More...
 
using OptionalROPID = OptionalID< readout::ROPID >
 Member type of optional validated readout::ROPID parameter. More...
 
using ROPIDsequence = IDsequence< readout::ROPID >
 Member type of sequence of readout::ROPID parameters. More...
 
using OptionalROPIDsequence = OptionalIDsequence< readout::ROPID >
 Member type of optional sequence of readout::ROPID parameters. More...
 

Detailed Description

FHiCL objects representing geometry classes as configuration parameters.

Typedef Documentation

using readout::fhicl::CryostatID = typedef IDparameter<readout::CryostatID>

Member type of validated readout::CryostatID parameter.

Definition at line 113 of file readout_types_fhicl.h.

Member type of sequence of readout::CryostatID parameters.

Definition at line 119 of file readout_types_fhicl.h.

Member type of optional validated readout::CryostatID parameter.

Definition at line 116 of file readout_types_fhicl.h.

Member type of optional sequence of readout::CryostatID parameters.

Definition at line 122 of file readout_types_fhicl.h.

using readout::fhicl::OptionalROPID = typedef OptionalID<readout::ROPID>

Member type of optional validated readout::ROPID parameter.

Definition at line 148 of file readout_types_fhicl.h.

using readout::fhicl::OptionalROPIDsequence = typedef OptionalIDsequence<readout::ROPID>

Member type of optional sequence of readout::ROPID parameters.

Definition at line 154 of file readout_types_fhicl.h.

Member type of optional validated readout::TPCsetID parameter.

Definition at line 132 of file readout_types_fhicl.h.

using readout::fhicl::OptionalTPCsetIDsequence = typedef OptionalIDsequence<readout::TPCsetID>

Member type of optional sequence of readout::TPCsetID parameters.

Definition at line 138 of file readout_types_fhicl.h.

using readout::fhicl::ROPID = typedef IDparameter<readout::ROPID>

Member type of validated readout::ROPID parameter.

Definition at line 145 of file readout_types_fhicl.h.

using readout::fhicl::ROPIDsequence = typedef IDsequence<readout::ROPID>

Member type of sequence of readout::ROPID parameters.

Definition at line 151 of file readout_types_fhicl.h.

using readout::fhicl::TPCsetID = typedef IDparameter<readout::TPCsetID>

Member type of validated readout::TPCsetID parameter.

Definition at line 129 of file readout_types_fhicl.h.

Member type of sequence of readout::TPCsetID parameters.

Definition at line 135 of file readout_types_fhicl.h.