FHiCL objects representing geometry classes as configuration parameters. More...
Classes | |
| struct | IDConfig |
| Type of ID configuration structure (requires specialization) More... | |
| struct | IDConfig< geo::CryostatID > |
Configuration structure for validated geo::CryostatID parameter. More... | |
| struct | IDConfig< geo::OpDetID > |
Configuration structure for validated geo::OpDetID parameter. More... | |
| struct | IDConfig< geo::PlaneID > |
Configuration structure for validated geo::PlaneID parameter. More... | |
| struct | IDConfig< geo::TPCID > |
Configuration structure for validated geo::TPCID parameter. More... | |
| struct | IDConfig< geo::WireID > |
Configuration structure for validated geo::PlaneID parameter. More... | |
| struct | IDConfig< readout::ROPID > |
Configuration structure for validated readout::ROPID parameter. More... | |
| struct | IDConfig< readout::TPCsetID > |
Configuration structure for validated readout::TPCsetID parameter. More... | |
| struct | IDparameterTraits |
| Traits for ID parameter objects. More... | |
| struct | IDparameterTraits< geo::fhicl::IDparameter< ID > > |
| struct | IDparameterTraits< geo::fhicl::IDsequence< ID > > |
| struct | IDparameterTraits< geo::fhicl::OptionalID< ID > > |
| struct | IDparameterTraits< geo::fhicl::OptionalIDsequence< ID > > |
| struct | ValidIDConfig |
| Helper class holding the ID validity flag. More... | |
Typedefs | |
| template<typename IDtype > | |
| using | IDparameter = ::fhicl::Table< IDConfig< IDtype >> |
| Member type of validated ID parameter. More... | |
| template<typename IDtype > | |
| using | OptionalID = ::fhicl::OptionalTable< IDConfig< IDtype >> |
| Member type of optional validated ID parameter. More... | |
| template<typename IDtype > | |
| using | IDsequence = ::fhicl::Sequence< IDparameter< IDtype >> |
| Member type of sequence of ID parameters. More... | |
| template<typename IDtype > | |
| using | OptionalIDsequence = ::fhicl::OptionalSequence< IDparameter< IDtype >> |
| Member type of optional sequence of ID parameters. More... | |
| using | CryostatID = IDparameter< geo::CryostatID > |
Member type of validated geo::CryostatID parameter. More... | |
| using | OptionalCryostatID = OptionalID< geo::CryostatID > |
Member type of optional validated geo::CryostatID parameter. More... | |
| using | CryostatIDsequence = IDsequence< geo::CryostatID > |
Member type of sequence of geo::CryostatID parameters. More... | |
| using | OptionalCryostatIDsequence = OptionalIDsequence< geo::CryostatID > |
Member type of optional sequence of geo::CryostatID parameters. More... | |
| using | TPCID = IDparameter< geo::TPCID > |
Member type of validated geo::TPCID parameter. More... | |
| using | OptionalTPCID = OptionalID< geo::TPCID > |
Member type of optional validated geo::TPCID parameter. More... | |
| using | TPCIDsequence = IDsequence< geo::TPCID > |
Member type of sequence of geo::TPCID parameters. More... | |
| using | OptionalTPCIDsequence = OptionalIDsequence< geo::TPCID > |
Member type of optional sequence of geo::TPCID parameters. More... | |
| using | OpDetID = IDparameter< geo::OpDetID > |
Member type of validated geo::OpDetID parameter. More... | |
| using | OptionalOpDetID = OptionalID< geo::OpDetID > |
Member type of optional validated geo::OpDetID parameter. More... | |
| using | OpDetIDsequence = IDsequence< geo::OpDetID > |
Member type of sequence of geo::OpDetID parameters. More... | |
| using | OptionalOpDetIDsequence = OptionalIDsequence< geo::OpDetID > |
Member type of optional sequence of geo::OpDetID parameters. More... | |
| using | PlaneID = IDparameter< geo::PlaneID > |
Member type of validated geo::PlaneID parameter. More... | |
| using | OptionalPlaneID = OptionalID< geo::PlaneID > |
Member type of optional validated geo::PlaneID parameter. More... | |
| using | PlaneIDsequence = IDsequence< geo::PlaneID > |
Member type of sequence of geo::PlaneID parameters. More... | |
| using | OptionalPlaneIDsequence = OptionalIDsequence< geo::PlaneID > |
Member type of optional sequence of geo::PlaneID parameters. More... | |
| using | WireID = IDparameter< geo::WireID > |
Member type of validated geo::WireID parameter. More... | |
| using | OptionalWireID = OptionalID< geo::WireID > |
Member type of optional validated geo::WireID parameter. More... | |
| using | WireIDsequence = IDsequence< geo::WireID > |
Member type of sequence of geo::WireID parameters. More... | |
| using | OptionalWireIDsequence = OptionalIDsequence< geo::WireID > |
Member type of optional sequence of geo::WireID parameters. More... | |
| template<typename IDparam > | |
| using | IDof = typename IDparameterTraits< IDparam >::ID_t |
| Type of ID of the specified ID FHiCL parameter object/. More... | |
Functions | |
| template<typename SrcID , typename ID = SrcID> | |
| ID | readID (IDparameter< SrcID > const &atom) |
| Returns an ID extracted from the specified ID atom. More... | |
| template<typename SrcID , typename ID = SrcID> | |
| ID | readParameter (IDparameter< SrcID > const &atom) |
| template<typename SrcID , typename ID = SrcID> | |
| std::optional< ID > | readOptionalID (OptionalID< SrcID > const &atom) |
| Returns an ID extracted from the specified optional ID atom. More... | |
| template<typename SrcID , typename ID = SrcID> | |
| std::optional< ID > | readParameter (OptionalID< SrcID > const &atom) |
| template<typename SrcID , typename ID = SrcID> | |
| ID | readOptionalID (OptionalID< SrcID > const &atom, ID const &defValue) |
| Returns an ID extracted from the specified optional ID atom. More... | |
| template<typename SrcID , typename ID = SrcID> | |
| ID | readOptionalID (OptionalID< SrcID > const &atom, ID &&defValue) |
| template<typename SrcID , typename ID = SrcID> | |
| ID | readParameter (OptionalID< SrcID > const &atom, ID const &defValue) |
| template<typename SrcID , typename ID = SrcID> | |
| ID | readParameter (OptionalID< SrcID > const &atom, ID &&defValue) |
| template<typename SrcID , typename ID = SrcID> | |
| std::vector< ID > | readIDsequence (IDsequence< SrcID > const &seq) |
| Returns a vector of IDs extracted from the specified ID sequence. More... | |
| template<typename SrcID , typename ID = SrcID> | |
| std::vector< ID > | readParameter (IDsequence< SrcID > const &seq) |
| template<typename SrcID , typename ID = SrcID> | |
| std::optional< std::vector< ID > > | readOptionalIDsequence (OptionalIDsequence< SrcID > const &seq) |
| Returns a vector of IDs extracted from the specified optional ID sequence. More... | |
| template<typename SrcID , typename ID = SrcID> | |
| std::optional< std::vector< ID > > | readParameter (OptionalIDsequence< SrcID > const &seq) |
| template<typename SrcID , typename ID = SrcID> | |
| std::vector< ID > | readOptionalIDsequence (OptionalIDsequence< SrcID > const &seq, std::vector< ID > const &defValue) |
| Returns a vector of IDs extracted from the specified optional ID sequence, or a default value. More... | |
| template<typename SrcID , typename ID = SrcID> | |
| std::vector< ID > | readOptionalIDsequence (OptionalIDsequence< SrcID > const &seq, std::vector< ID > &&defValue) |
| template<typename SrcID , typename ID = SrcID> | |
| std::vector< ID > | readParameter (OptionalIDsequence< SrcID > const &seq, std::vector< ID > const &defValue) |
| template<typename SrcID , typename ID = SrcID> | |
| std::vector< ID > | readParameter (OptionalIDsequence< SrcID > const &seq, std::vector< ID > &&defValue) |
FHiCL objects representing geometry classes as configuration parameters.
| using geo::fhicl::CryostatID = typedef IDparameter<geo::CryostatID> |
Member type of validated geo::CryostatID parameter.
Definition at line 279 of file geo_types_fhicl.h.
| using geo::fhicl::CryostatIDsequence = typedef IDsequence<geo::CryostatID> |
Member type of sequence of geo::CryostatID parameters.
Definition at line 285 of file geo_types_fhicl.h.
| using geo::fhicl::IDof = typedef typename IDparameterTraits<IDparam>::ID_t |
Type of ID of the specified ID FHiCL parameter object/.
Definition at line 219 of file geo_types_fhicl.h.
| using geo::fhicl::IDparameter = typedef ::fhicl::Table<IDConfig<IDtype>> |
Member type of validated ID parameter.
Definition at line 244 of file geo_types_fhicl.h.
| using geo::fhicl::IDsequence = typedef ::fhicl::Sequence<IDparameter<IDtype>> |
Member type of sequence of ID parameters.
Definition at line 252 of file geo_types_fhicl.h.
| using geo::fhicl::OpDetID = typedef IDparameter<geo::OpDetID> |
Member type of validated geo::OpDetID parameter.
Definition at line 343 of file geo_types_fhicl.h.
| using geo::fhicl::OpDetIDsequence = typedef IDsequence<geo::OpDetID> |
Member type of sequence of geo::OpDetID parameters.
Definition at line 349 of file geo_types_fhicl.h.
| using geo::fhicl::OptionalCryostatID = typedef OptionalID<geo::CryostatID> |
Member type of optional validated geo::CryostatID parameter.
Definition at line 282 of file geo_types_fhicl.h.
| using geo::fhicl::OptionalCryostatIDsequence = typedef OptionalIDsequence<geo::CryostatID> |
Member type of optional sequence of geo::CryostatID parameters.
Definition at line 288 of file geo_types_fhicl.h.
| using geo::fhicl::OptionalID = typedef ::fhicl::OptionalTable<IDConfig<IDtype>> |
Member type of optional validated ID parameter.
Definition at line 248 of file geo_types_fhicl.h.
| using geo::fhicl::OptionalIDsequence = typedef ::fhicl::OptionalSequence<IDparameter<IDtype>> |
Member type of optional sequence of ID parameters.
Definition at line 256 of file geo_types_fhicl.h.
| using geo::fhicl::OptionalOpDetID = typedef OptionalID<geo::OpDetID> |
Member type of optional validated geo::OpDetID parameter.
Definition at line 346 of file geo_types_fhicl.h.
| using geo::fhicl::OptionalOpDetIDsequence = typedef OptionalIDsequence<geo::OpDetID> |
Member type of optional sequence of geo::OpDetID parameters.
Definition at line 352 of file geo_types_fhicl.h.
| using geo::fhicl::OptionalPlaneID = typedef OptionalID<geo::PlaneID> |
Member type of optional validated geo::PlaneID parameter.
Definition at line 378 of file geo_types_fhicl.h.
| using geo::fhicl::OptionalPlaneIDsequence = typedef OptionalIDsequence<geo::PlaneID> |
Member type of optional sequence of geo::PlaneID parameters.
Definition at line 384 of file geo_types_fhicl.h.
| using geo::fhicl::OptionalTPCID = typedef OptionalID<geo::TPCID> |
Member type of optional validated geo::TPCID parameter.
Definition at line 314 of file geo_types_fhicl.h.
| using geo::fhicl::OptionalTPCIDsequence = typedef OptionalIDsequence<geo::TPCID> |
Member type of optional sequence of geo::TPCID parameters.
Definition at line 320 of file geo_types_fhicl.h.
| using geo::fhicl::OptionalWireID = typedef OptionalID<geo::WireID> |
Member type of optional validated geo::WireID parameter.
Definition at line 410 of file geo_types_fhicl.h.
| using geo::fhicl::OptionalWireIDsequence = typedef OptionalIDsequence<geo::WireID> |
Member type of optional sequence of geo::WireID parameters.
Definition at line 416 of file geo_types_fhicl.h.
| using geo::fhicl::PlaneID = typedef IDparameter<geo::PlaneID> |
Member type of validated geo::PlaneID parameter.
Definition at line 375 of file geo_types_fhicl.h.
| using geo::fhicl::PlaneIDsequence = typedef IDsequence<geo::PlaneID> |
Member type of sequence of geo::PlaneID parameters.
Definition at line 381 of file geo_types_fhicl.h.
| using geo::fhicl::TPCID = typedef IDparameter<geo::TPCID> |
Member type of validated geo::TPCID parameter.
Definition at line 311 of file geo_types_fhicl.h.
| using geo::fhicl::TPCIDsequence = typedef IDsequence<geo::TPCID> |
Member type of sequence of geo::TPCID parameters.
Definition at line 317 of file geo_types_fhicl.h.
| using geo::fhicl::WireID = typedef IDparameter<geo::WireID> |
Member type of validated geo::WireID parameter.
Definition at line 407 of file geo_types_fhicl.h.
| using geo::fhicl::WireIDsequence = typedef IDsequence<geo::WireID> |
Member type of sequence of geo::WireID parameters.
Definition at line 413 of file geo_types_fhicl.h.
| ID geo::fhicl::readID | ( | IDparameter< SrcID > const & | atom | ) |
Returns an ID extracted from the specified ID atom.
| SrcID | type of the ID read by the FHiCL parameter |
| ID | type of the returned ID (default: same as SrcID) |
| atom | the ID atom parameter to convert |
ID object converted from atomThis function is trivial and provided mostly for uniformity of interface. In the standard usage is equivalent to using the atom directly:
has newInterface() and classicInterface() completely equivalent. Note however that because of inplementation details, config().TPC() (classic interface) does not return a geo::TPCID object, but a different, implementation dependent object that is converted upon assignment. This implies that the following variables may have different types, and the new interface is the one guaranteeing the right type:
ID is provided as an added bonus to choose which type to convert the configuration parameters into, and it's not enforced to be a ID type at all. Definition at line 781 of file geo_types_fhicl.h.
| std::vector< ID > geo::fhicl::readIDsequence | ( | IDsequence< SrcID > const & | seq | ) |
Returns a vector of IDs extracted from the specified ID sequence.
| SrcID | type of the ID read by the FHiCL parameter |
| ID | type of the returned ID (default: same as SrcID) |
| seq | the sequence of ID parameters to convert |
ID objects converted from seq parameter valuesThis function returns the value of the specified FHiCL sequence object (fhicl::Sequence). It supports both fixed and variable size sequences, but it always returns a STL vector as a result.
Example of usage: the configuration object Config and the data member to store the configuration parameter value are defined in a class as:
The constructor of that class should have an entry in the initializer list like:
(note that the argument is just config().TPCs, not config().TPCs()).
ID is provided as an added bonus to choose which type to convert the configuration parameters into, and it's not enforced to be a ID type at all. Definition at line 810 of file geo_types_fhicl.h.
| std::optional< ID > geo::fhicl::readOptionalID | ( | OptionalID< SrcID > const & | atom | ) |
Returns an ID extracted from the specified optional ID atom.
| SrcID | type of the ID read by the FHiCL parameter |
| ID | type of the returned ID (default: same as SrcID) |
| atom | the optional ID atom parameter to convert |
ID object converted from atom, or no value if omittedThe return type of this function is of type std::optional. This function returns the value of the specified FHiCL optional atom (fhicl::OptionalAtom). If the parameter was omitted, no value is returned.
Example of usage: the configuration object Config and the data member to store the configuration parameter value are defined in a class as:
The constructor of that class should have an entry in the initializer list like:
(note that the argument is just config().RefTPC, not config().RefTPC()).
ID is provided as an added bonus to choose which type to convert the configuration parameters into, and it's not enforced to be a ID type at all. Definition at line 788 of file geo_types_fhicl.h.
| ID geo::fhicl::readOptionalID | ( | OptionalID< SrcID > const & | atom, |
| ID const & | defValue | ||
| ) |
Returns an ID extracted from the specified optional ID atom.
| SrcID | type of the ID read by the FHiCL parameter |
| ID | type of the returned ID (default: same as SrcID) |
| atom | the optional ID atom parameter to convert |
| defValue | a value to use if the parameter was omitted |
ID object converted from atom, or defValue if omittedThis function returns the value of the specified FHiCL optional atom (fhicl::OptionalAtom). If the parameter was omitted, the defValue is copied or moved depending on the function.
Example of usage: the configuration object Config and the data member to store the configuration parameter value are defined in a class as:
The constructor of that class should have an entry in the initializer list like:
will set fRefTPC to C:0 T:0 TPC ID if refTPC was omitted from the configuration (note that the argument is just config().RefTPC, not config().RefTPC()).
ID is provided as an added bonus to choose which type to convert the configuration parameters into, and it's not enforced to be a ID type at all. Definition at line 798 of file geo_types_fhicl.h.
| ID geo::fhicl::readOptionalID | ( | OptionalID< SrcID > const & | atom, |
| ID && | defValue | ||
| ) |
Definition at line 804 of file geo_types_fhicl.h.
| std::optional< std::vector< ID > > geo::fhicl::readOptionalIDsequence | ( | OptionalIDsequence< SrcID > const & | seq | ) |
Returns a vector of IDs extracted from the specified optional ID sequence.
| SrcID | type of the ID read by the FHiCL parameter |
| ID | type of the returned ID (default: same as SrcID) |
| seq | the optional sequence of ID parameters to convert |
ID objects converted from seq parameter values, or no value if the parameter was omittedThis function returns the value of the specified FHiCL optional sequence object (fhicl::OptionalSequence). It supports both fixed and variable size optional sequences, but it always returns an optional STL vector as a result.
Example of usage: the configuration object Config and the data member to store the configuration parameter value are defined in a class as:
The constructor of that class should have an entry in the initializer list like:
(note that the argument is just config().TPCs, not config().TPCs()). If instead a "default value" needs to be provided, the data member is simply:
and the value can be assigned via the standard std::optional interface:
(in this case the default value is an empty collection of TPC IDs) or using a different overload of readOptionalIDsequence():
ID is provided as an added bonus to choose which type to convert the configuration parameters into, and it's not enforced to be a ID type at all. Definition at line 825 of file geo_types_fhicl.h.
| std::vector< ID > geo::fhicl::readOptionalIDsequence | ( | OptionalIDsequence< SrcID > const & | seq, |
| std::vector< ID > const & | defValue | ||
| ) |
Returns a vector of IDs extracted from the specified optional ID sequence, or a default value.
| SrcID | type of the ID read by the FHiCL parameter |
| ID | type of the returned ID (default: same as SrcID) |
| seq | the optional sequence of ID parameters to convert |
| defValue | value to be returned if the optional parameter was omitted |
ID objects converted either from seq parameter values or from defValueThis function is based on readOptionalIDsequence(IDsequence const&). The operating mode is the same, but if the value is not available from the parameters, a copy of defValue is returned, or defValue content is moved into the returned value.
Definition at line 843 of file geo_types_fhicl.h.
| std::vector< ID > geo::fhicl::readOptionalIDsequence | ( | OptionalIDsequence< SrcID > const & | seq, |
| std::vector< ID > && | defValue | ||
| ) |
Definition at line 854 of file geo_types_fhicl.h.
| ID geo::fhicl::readParameter | ( | IDparameter< SrcID > const & | atom | ) |
Definition at line 473 of file geo_types_fhicl.h.
| std::optional<ID> geo::fhicl::readParameter | ( | OptionalID< SrcID > const & | atom | ) |
Definition at line 519 of file geo_types_fhicl.h.
| ID geo::fhicl::readParameter | ( | OptionalID< SrcID > const & | atom, |
| ID const & | defValue | ||
| ) |
Definition at line 569 of file geo_types_fhicl.h.
| ID geo::fhicl::readParameter | ( | OptionalID< SrcID > const & | atom, |
| ID && | defValue | ||
| ) |
Definition at line 573 of file geo_types_fhicl.h.
| std::vector<ID> geo::fhicl::readParameter | ( | IDsequence< SrcID > const & | seq | ) |
Definition at line 617 of file geo_types_fhicl.h.
| std::optional<std::vector<ID> > geo::fhicl::readParameter | ( | OptionalIDsequence< SrcID > const & | seq | ) |
Definition at line 681 of file geo_types_fhicl.h.
| std::vector<ID> geo::fhicl::readParameter | ( | OptionalIDsequence< SrcID > const & | seq, |
| std::vector< ID > const & | defValue | ||
| ) |
Definition at line 711 of file geo_types_fhicl.h.
| std::vector<ID> geo::fhicl::readParameter | ( | OptionalIDsequence< SrcID > const & | seq, |
| std::vector< ID > && | defValue | ||
| ) |
Definition at line 716 of file geo_types_fhicl.h.
1.8.11