LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
geo::fhicl::IDConfig< geo::PlaneID > Struct Template Reference

Configuration structure for validated geo::PlaneID parameter. More...

#include "geo_types_fhicl.h"

Inheritance diagram for geo::fhicl::IDConfig< geo::PlaneID >:
geo::fhicl::IDConfig< geo::TPCID > geo::fhicl::IDConfig< geo::CryostatID > geo::fhicl::ValidIDConfig geo::fhicl::IDConfig< geo::WireID >

Public Types

using ID_t = geo::PlaneID
 Type read by this configuration. More...
 

Public Member Functions

ID_t ID () const
 
 operator ID_t () const
 
bool valid () const
 

Public Attributes

::fhicl::Atom< geo::PlaneID::PlaneID_tP
 
::fhicl::Atom< geo::TPCID::TPCID_tT
 
::fhicl::Atom< geo::CryostatID::CryostatID_tC
 
::fhicl::Atom< bool > isValid
 

Detailed Description

template<>
struct geo::fhicl::IDConfig< geo::PlaneID >

Configuration structure for validated geo::PlaneID parameter.

Definition at line 343 of file geo_types_fhicl.h.

Member Typedef Documentation

Type read by this configuration.

Definition at line 344 of file geo_types_fhicl.h.

Member Function Documentation

ID_t geo::fhicl::IDConfig< geo::PlaneID >::ID ( ) const
inline

Definition at line 350 of file geo_types_fhicl.h.

References geo::fhicl::ValidIDConfig::valid().

350 { return !valid() ? ID_t{} : ID_t{IDConfig<geo::TPCID>::ID(), P()}; }
geo::PlaneID ID_t
Type read by this configuration.
::fhicl::Atom< geo::PlaneID::PlaneID_t > P
geo::fhicl::IDConfig< geo::PlaneID >::operator ID_t ( ) const
inline

Definition at line 351 of file geo_types_fhicl.h.

351 { return ID(); }
bool geo::fhicl::ValidIDConfig::valid ( ) const
inlineinherited

Member Data Documentation

Initial value:
::fhicl::Comment("cryostat number"),
[this]() { return valid(); }}

Definition at line 260 of file geo_types_fhicl.h.

::fhicl::Atom<bool> geo::fhicl::ValidIDConfig::isValid
inherited
Initial value:
{::fhicl::Name("isValid"),
::fhicl::Comment("whether the ID is valid"),
true}

Definition at line 224 of file geo_types_fhicl.h.

Referenced by geo::fhicl::ValidIDConfig::valid().

Initial value:
::fhicl::Comment("Plane number within the TPC"),
[this]() { return valid(); }}

Definition at line 346 of file geo_types_fhicl.h.

Initial value:
::fhicl::Comment("TPC number within the cryostat"),
[this]() { return valid(); }}

Definition at line 289 of file geo_types_fhicl.h.


The documentation for this struct was generated from the following file: