geo::CryostatID Struct Reference

The data type to uniquely identify a cryostat. More...

#include <geo_types.h>

Inheritance diagram for geo::CryostatID:

Public Types
using	CryostatID_t = unsigned int
	Type for the ID number. More...
using	ThisID_t = CryostatID
	Type of this ID. More...
using	ParentID_t = void
	Type of the parent ID (none!). More...
template<std::size_t L>
using	ID_t = details::AbsIDtype< L, ThisID_t >
	Type of the ID with the specified level L. More...
template<std::size_t A>
using	UpperID_t = details::RelIDtype< A, ThisID_t >
	Type of the ID A levels above this one. More...

Public Member Functions
constexpr	CryostatID ()=default
	Default constructor: an invalid cryostat. More...
constexpr	CryostatID (CryostatID_t c)
	Constructor: valid ID of cryostat with index c. More...
constexpr	CryostatID (CryostatID_t c, bool valid)
	Constructor: valid ID of cryostat with index c. More...
constexpr auto const &	deepestIndex () const
	Returns the value of the deepest ID available (cryostat's). More...
auto &	deepestIndex ()
	Returns the deepest ID available (cryostat's). More...
constexpr ParentID_t	parentID () const
	Return the parent ID of this one (void). More...
ParentID_t	parentID ()
	Return the parent ID of this one (void). More...
template<std::size_t Index = 0U>
constexpr auto	getIndex () const
	Returns the index level Index of this type. More...
template<std::size_t Index = 0U>
auto &	writeIndex ()
	Returns the index level Index of this type. More...
template<std::size_t Above>
constexpr auto	getRelIndex () const
	Returns the index Above levels higher than Level. More...
constexpr int	cmp (CryostatID const &other) const
	Returns < 0 if this is smaller than other, 0 if equal, > 0 if larger. More...
constexpr CryostatID const &	asCryostatID () const
	Conversion to CryostatID (for convenience of notation). More...
CryostatID &	asCryostatID ()
	Conversion to CryostatID (for convenience of notation). More...
constexpr CryostatID const &	asConstCryostatID ()
	Conversion to CryostatID (for convenience of notation). More...
ID validity
constexpr	operator bool () const
	Returns true if the ID is valid. More...
constexpr bool	operator! () const
	Returns true if the ID is not valid. More...
void	setValidity (bool valid)
	Sets the validity of the ID. More...
void	markValid ()
	Sets the ID as valid. More...
void	markInvalid ()
	Sets the ID as invalid. More...
std::string	toString () const
	Human-readable representation of the cryostat ID. More...
	operator std::string () const

Static Public Member Functions
static constexpr CryostatID_t	getInvalidID ()
	Return the value of the invalid ID as a r-value. More...
template<typename T >
static constexpr int	ThreeWayComparison (T a, T b)
	Returns < 0 if a < b, 0 if a == b, > 0 if a > b. More...

Public Attributes
bool	isValid = false
	Whether this ID points to a valid element. More...
CryostatID_t	Cryostat = InvalidID
	Index of cryostat. More...

Static Public Attributes
static constexpr CryostatID_t	InvalidID = std::numeric_limits<CryostatID_t>::max()
	Special code for an invalid ID. More...
static constexpr auto	Level = geo::ElementLevel::Cryostat
	Level of this element. More...

Detailed Description

The data type to uniquely identify a cryostat.

Definition at line 190 of file geo_types.h.

Member Typedef Documentation

using geo::CryostatID::CryostatID_t = unsigned int

Type for the ID number.

Definition at line 191 of file geo_types.h.

template<std::size_t L>

using geo::CryostatID::ID_t = details::AbsIDtype<L, ThisID_t>

Type of the ID with the specified level L.

Definition at line 198 of file geo_types.h.

using geo::CryostatID::ParentID_t = void

Type of the parent ID (none!).

Definition at line 194 of file geo_types.h.

using geo::CryostatID::ThisID_t = CryostatID

Type of this ID.

Definition at line 193 of file geo_types.h.

template<std::size_t A>

using geo::CryostatID::UpperID_t = details::RelIDtype<A, ThisID_t>

Type of the ID A levels above this one.

Definition at line 202 of file geo_types.h.

Constructor & Destructor Documentation

constexpr geo::CryostatID::CryostatID ( )

default

Default constructor: an invalid cryostat.

constexpr geo::CryostatID::CryostatID ( CryostatID_t  c )

inlineexplicit

Constructor: valid ID of cryostat with index c.

Definition at line 218 of file geo_types.h.

: isValid(true), Cryostat(c) {}

constexpr geo::CryostatID::CryostatID ( CryostatID_t  c, bool  valid  )

inline

Constructor: valid ID of cryostat with index c.

Definition at line 221 of file geo_types.h.

      : isValid(valid), Cryostat(c) {}

Member Function Documentation

constexpr CryostatID const& geo::CryostatID::asConstCryostatID ( )

inline

Conversion to CryostatID (for convenience of notation).

Definition at line 279 of file geo_types.h.

{ return *this; }

constexpr CryostatID const& geo::CryostatID::asCryostatID ( ) const

inline

Conversion to CryostatID (for convenience of notation).

Definition at line 275 of file geo_types.h.

{ return *this; }

CryostatID& geo::CryostatID::asCryostatID ( )

inline

Conversion to CryostatID (for convenience of notation).

Definition at line 277 of file geo_types.h.

{ return *this; }

constexpr int geo::CryostatID::cmp ( CryostatID const &  other ) const

inline

Returns < 0 if this is smaller than other, 0 if equal, > 0 if larger.

Definition at line 271 of file geo_types.h.

      { return ThreeWayComparison(deepestIndex(), other.deepestIndex()); }

constexpr auto const& geo::CryostatID::deepestIndex ( ) const

inline

Returns the value of the deepest ID available (cryostat's).

Definition at line 253 of file geo_types.h.

{ return Cryostat; }

auto& geo::CryostatID::deepestIndex ( )

inline

Returns the deepest ID available (cryostat's).

Definition at line 255 of file geo_types.h.

{ return Cryostat; }

template<std::size_t Index>

constexpr auto geo::CryostatID::getIndex

(

)

const

Returns the index level Index of this type.

Definition at line 881 of file geo_types.h.

                                             {
  static_assert
    (Index <= Level, "This ID type does not have the requested Index level.");
  return details::getAbsIDindex<Index>(*this);
} // geo::CryostatID::getIndex() const

static constexpr CryostatID_t geo::CryostatID::getInvalidID ( )

inlinestatic

Return the value of the invalid ID as a r-value.

Definition at line 285 of file geo_types.h.

      { return CryostatID::InvalidID; }

template<std::size_t Above>

constexpr auto geo::CryostatID::getRelIndex

(

)

const

Returns the index Above levels higher than Level.

Definition at line 895 of file geo_types.h.

                                                {
  static_assert
    (Above <= Level, "This ID type does not have the requested Index level.");
  return getIndex<Level - Above>();
} // geo::CryostatID::getRelIndex()

void geo::CryostatID::markInvalid ( )

inline

Sets the ID as invalid.

Definition at line 240 of file geo_types.h.

{ setValidity(false); }

void geo::CryostatID::markValid ( )

inline

Sets the ID as valid.

Definition at line 237 of file geo_types.h.

{ setValidity(true); }

constexpr geo::CryostatID::operator bool ( ) const

inlineexplicit

Returns true if the ID is valid.

Definition at line 228 of file geo_types.h.

{ return isValid; }

geo::CryostatID::operator std::string ( ) const

inlineexplicit

Definition at line 248 of file geo_types.h.

{ return toString(); }

constexpr bool geo::CryostatID::operator! ( ) const

inline

Returns true if the ID is not valid.

Definition at line 231 of file geo_types.h.

{ return !isValid; }

constexpr ParentID_t geo::CryostatID::parentID ( ) const

inline

Return the parent ID of this one (void).

Definition at line 257 of file geo_types.h.

{}

ParentID_t geo::CryostatID::parentID ( )

inline

Return the parent ID of this one (void).

Definition at line 259 of file geo_types.h.

{}

void geo::CryostatID::setValidity ( bool  valid )

inline

Sets the validity of the ID.

Definition at line 234 of file geo_types.h.

{ isValid = valid; }

template<typename T >

static constexpr int geo::CryostatID::ThreeWayComparison ( T  a, T  b  )

inlinestatic

Returns < 0 if a < b, 0 if a == b, > 0 if a > b.

Definition at line 290 of file geo_types.h.

      { return (a == b)? 0: ((a < b)? -1: +1); }

std::string geo::CryostatID::toString ( ) const

inline

Human-readable representation of the cryostat ID.

Definition at line 247 of file geo_types.h.

{ return details::writeToString(*this); }

template<std::size_t Index>

auto & geo::CryostatID::writeIndex

(

)

Returns the index level Index of this type.

Definition at line 888 of file geo_types.h.

                                {
  static_assert
    (Index <= Level, "This ID type does not have the requested Index level.");
  return details::getAbsIDindex<Index>(*this);
} // geo::CryostatID::writeIndex()

Member Data Documentation

CryostatID_t geo::CryostatID::Cryostat = InvalidID

Index of cryostat.

Definition at line 212 of file geo_types.h.

constexpr CryostatID_t geo::CryostatID::InvalidID = std::numeric_limits<CryostatID_t>::max()

static

Special code for an invalid ID.

Definition at line 208 of file geo_types.h.

bool geo::CryostatID::isValid = false

Whether this ID points to a valid element.

Definition at line 211 of file geo_types.h.

constexpr auto geo::CryostatID::Level = geo::ElementLevel::Cryostat

static

Level of this element.

Definition at line 282 of file geo_types.h.

---

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

• larcoreobj/larcoreobj/SimpleTypesAndConstants/geo_types.h