Public Member Functions | List of all members
IOstreamOption::versionNumber Class Reference

Representation of a major/minor version number. More...

Public Member Functions

constexpr versionNumber (int major, int minor) noexcept
 Construct from major, number. More...
 
constexpr versionNumber (const float ver) noexcept
 Construct from floating-point version number. More...
 
 versionNumber (Istream &is)
 Construct from Istream by reading in a float. More...
 
 versionNumber (const std::string &verNum)
 Construct by parsing string "major.minor". More...
 
int canonical () noexcept
 The canonical major/minor pair as an integer value. More...
 
int getMajor () const noexcept
 Return the major version number. More...
 
int getMinor () const noexcept
 Return the minor version number. More...
 
std::string str () const
 A string representation of major.minor. More...
 
bool operator== (const versionNumber &rhs) const noexcept
 Version number equality. More...
 
bool operator!= (const versionNumber &rhs) const noexcept
 Version number inequality. More...
 
bool operator< (const versionNumber &rhs) const noexcept
 Version number older than rhs. More...
 
bool operator<= (const versionNumber &rhs) const noexcept
 Version number is the same or older than rhs. More...
 
bool operator> (const versionNumber &rhs) const noexcept
 Version number newer than rhs. More...
 
bool operator>= (const versionNumber &rhs) const noexcept
 Version number same or newer than rhs. More...
 

Detailed Description

Representation of a major/minor version number.

Definition at line 79 of file IOstreamOption.H.

Constructor & Destructor Documentation

◆ versionNumber() [1/4]

constexpr versionNumber ( int  major,
int  minor 
)
inlineconstexprnoexcept

Construct from major, number.

Definition at line 89 of file IOstreamOption.H.

◆ versionNumber() [2/4]

constexpr versionNumber ( const float  ver)
inlineexplicitconstexprnoexcept

Construct from floating-point version number.

Definition at line 95 of file IOstreamOption.H.

◆ versionNumber() [3/4]

versionNumber ( Istream &  is)
inline

Construct from Istream by reading in a float.

Non-explicit for convenience

Definition at line 102 of file IOstreamOption.H.

◆ versionNumber() [4/4]

versionNumber ( const std::string &  verNum)
inlineexplicit

Construct by parsing string "major.minor".

Definition at line 108 of file IOstreamOption.H.

Member Function Documentation

◆ canonical()

int canonical ( )
inlinenoexcept

The canonical major/minor pair as an integer value.

Definition at line 117 of file IOstreamOption.H.

◆ getMajor()

int getMajor ( ) const
inlinenoexcept

Return the major version number.

Definition at line 123 of file IOstreamOption.H.

Referenced by IOstreamOption::versionNumber::str().

Here is the caller graph for this function:

◆ getMinor()

int getMinor ( ) const
inlinenoexcept

Return the minor version number.

Definition at line 129 of file IOstreamOption.H.

Referenced by IOstreamOption::versionNumber::str().

Here is the caller graph for this function:

◆ str()

std::string str ( ) const
inline

A string representation of major.minor.

Definition at line 135 of file IOstreamOption.H.

References IOstreamOption::versionNumber::getMajor(), and IOstreamOption::versionNumber::getMinor().

Referenced by decomposedBlockData::writeData().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator==()

bool operator== ( const versionNumber &  rhs) const
inlinenoexcept

Version number equality.

Definition at line 147 of file IOstreamOption.H.

◆ operator!=()

bool operator!= ( const versionNumber &  rhs) const
inlinenoexcept

Version number inequality.

Definition at line 153 of file IOstreamOption.H.

◆ operator<()

bool operator< ( const versionNumber &  rhs) const
inlinenoexcept

Version number older than rhs.

Definition at line 159 of file IOstreamOption.H.

◆ operator<=()

bool operator<= ( const versionNumber &  rhs) const
inlinenoexcept

Version number is the same or older than rhs.

Definition at line 165 of file IOstreamOption.H.

◆ operator>()

bool operator> ( const versionNumber &  rhs) const
inlinenoexcept

Version number newer than rhs.

Definition at line 171 of file IOstreamOption.H.

◆ operator>=()

bool operator>= ( const versionNumber &  rhs) const
inlinenoexcept

Version number same or newer than rhs.

Definition at line 177 of file IOstreamOption.H.

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