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 >:

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_t >	P
::fhicl::Atom< geo::TPCID::TPCID_t >	T
::fhicl::Atom< geo::CryostatID::CryostatID_t >	C
::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

using geo::fhicl::IDConfig< geo::PlaneID >::ID_t = geo::PlaneID

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().

{ return !valid() ? ID_t{} : ID_t{IDConfig<geo::TPCID>::ID(), P()}; }

geo::fhicl::IDConfig< geo::PlaneID >::operator ID_t ( ) const

inline

Definition at line 351 of file geo_types_fhicl.h.

{ return ID(); }

bool geo::fhicl::ValidIDConfig::valid ( ) const

inlineinherited

Definition at line 228 of file geo_types_fhicl.h.

References geo::fhicl::ValidIDConfig::isValid.

Referenced by geo::fhicl::IDConfig< geo::CryostatID >::ID(), geo::fhicl::IDConfig< geo::TPCID >::ID(), geo::fhicl::IDConfig< geo::OpDetID >::ID(), ID(), and geo::fhicl::IDConfig< geo::WireID >::ID().

{ return isValid(); }

Member Data Documentation

::fhicl::Atom<geo::CryostatID::CryostatID_t> geo::fhicl::IDConfig< geo::CryostatID >::C

inherited

Initial value:

{::fhicl::Name("C"),
                                                   ::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().

::fhicl::Atom<geo::PlaneID::PlaneID_t> geo::fhicl::IDConfig< geo::PlaneID >::P

Initial value:

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

Definition at line 346 of file geo_types_fhicl.h.

::fhicl::Atom<geo::TPCID::TPCID_t> geo::fhicl::IDConfig< geo::TPCID >::T

inherited

Initial value:

{::fhicl::Name("T"),
                                         ::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:

• larcoreobj/v09_10_01/source/larcoreobj/SimpleTypesAndConstants/geo_types_fhicl.h