ARTS 2.5.4 (git: 31ce4f0e)
Species::IsotopeRecord Struct Reference

Struct containing all information needed about one isotope. More...

#include <isotopologues.h>

Public Member Functions

constexpr IsotopeRecord (Species spec_, const std::string_view isotname_=Joker, Numeric mass_=std::numeric_limits< Numeric >::quiet_NaN(), Index gi_=-1) noexcept
 
constexpr IsotopeRecord () noexcept
 
constexpr bool operator== (const IsotopeRecord &that) const noexcept
 
constexpr bool operator== (const std::string_view specstr) const noexcept
 A comparison with pure named string (this is not an exact comparison) More...
 
template<typename T >
constexpr bool operator!= (T x) const noexcept
 
String FullName () const noexcept
 
constexpr bool joker () const noexcept
 
constexpr bool OK () const noexcept
 

Public Attributes

Species spec
 Species type as defined in species.h. More...
 
std::string_view isotname
 A custom name that is unique for this Species type. More...
 
Numeric mass
 The mass of the isotope in units of grams per mol. It is Nan if not defined. More...
 
Index gi
 The degeneracy of states of the molecule. It is -1 if not defined. More...
 

Friends

std::ostream & operator<< (std::ostream &os, const IsotopeRecord &ir)
 

Detailed Description

Struct containing all information needed about one isotope.

Definition at line 16 of file isotopologues.h.

Constructor & Destructor Documentation

◆ IsotopeRecord() [1/2]

constexpr Species::IsotopeRecord::IsotopeRecord ( Species  spec_,
const std::string_view  isotname_ = Joker,
Numeric  mass_ = std::numeric_limits<Numeric>::quiet_NaN(),
Index  gi_ = -1 
)
inlineexplicitconstexprnoexcept

Definition at line 29 of file isotopologues.h.

◆ IsotopeRecord() [2/2]

constexpr Species::IsotopeRecord::IsotopeRecord ( )
inlineconstexprnoexcept

Definition at line 32 of file isotopologues.h.

Member Function Documentation

◆ FullName()

String Species::IsotopeRecord::FullName ( ) const
inlinenoexcept

◆ joker()

constexpr bool Species::IsotopeRecord::joker ( ) const
inlineconstexprnoexcept

Definition at line 50 of file isotopologues.h.

References isotname, and Species::Joker.

◆ OK()

constexpr bool Species::IsotopeRecord::OK ( ) const
inlineconstexprnoexcept

Definition at line 51 of file isotopologues.h.

References good_enum(), and spec.

◆ operator!=()

template<typename T >
constexpr bool Species::IsotopeRecord::operator!= ( x) const
inlineconstexprnoexcept

Definition at line 47 of file isotopologues.h.

References operator==().

◆ operator==() [1/2]

constexpr bool Species::IsotopeRecord::operator== ( const IsotopeRecord that) const
inlineconstexprnoexcept

Definition at line 37 of file isotopologues.h.

References isotname, and spec.

Referenced by operator!=().

◆ operator==() [2/2]

constexpr bool Species::IsotopeRecord::operator== ( const std::string_view  specstr) const
inlineconstexprnoexcept

A comparison with pure named string (this is not an exact comparison)

Definition at line 42 of file isotopologues.h.

References isotname, and spec.

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const IsotopeRecord ir 
)
friend

Definition at line 34 of file isotopologues.h.

Member Data Documentation

◆ gi

Index Species::IsotopeRecord::gi

The degeneracy of states of the molecule. It is -1 if not defined.

Definition at line 27 of file isotopologues.h.

◆ isotname

std::string_view Species::IsotopeRecord::isotname

◆ mass

Numeric Species::IsotopeRecord::mass

The mass of the isotope in units of grams per mol. It is Nan if not defined.

Definition at line 24 of file isotopologues.h.

◆ spec


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