geo::fhicl::IDConfig< geo::OpDetID > Struct Template Reference

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

#include "geo_types_fhicl.h"

Inheritance diagram for geo::fhicl::IDConfig< geo::OpDetID >:

Public Types
using	ID_t = geo::OpDetID
	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::OpDetID::OpDetID_t >	O
::fhicl::Atom< geo::CryostatID::CryostatID_t >	C
::fhicl::Atom< bool >	isValid

Detailed Description

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

Configuration structure for validated geo::OpDetID parameter.

Definition at line 314 of file geo_types_fhicl.h.

Member Typedef Documentation

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

Type read by this configuration.

Definition at line 315 of file geo_types_fhicl.h.

Member Function Documentation

ID_t geo::fhicl::IDConfig< geo::OpDetID >::ID ( ) const

inline

Definition at line 322 of file geo_types_fhicl.h.

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

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

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

inline

Definition at line 323 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(), ID(), geo::fhicl::IDConfig< geo::PlaneID >::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::OpDetID::OpDetID_t> geo::fhicl::IDConfig< geo::OpDetID >::O

Initial value:

{
      ::fhicl::Name("O"),
      ::fhicl::Comment("Optical detector number within the cryostat"),
      [this]() { return valid(); }}

Definition at line 317 of file geo_types_fhicl.h.

---

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

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