Public Member Functions | Private Attributes | List of all members
gnsstk::ValidType< T > Class Template Reference

Detailed Description

template<class T>
class gnsstk::ValidType< T >

Definition at line 66 of file ValidType.hpp.

#include <ValidType.hpp>

Public Member Functions

get_value () const
 
bool is_valid () const
 
 operator T () const
 
bool operator!= (const ValidType &r) const
 
ValidTypeoperator+= (const T &r) noexcept
 
ValidTypeoperator-= (const T &r) noexcept
 
ValidTypeoperator= (const T &v) noexcept
 
bool operator== (const ValidType &r) const
 
void set_valid (const bool &v) noexcept
 
 ValidType ()
 
 ValidType (const T &v)
 

Private Attributes

bool valid
 
value
 

Constructor & Destructor Documentation

◆ ValidType() [1/2]

template<class T >
gnsstk::ValidType< T >::ValidType ( const T &  v)
inline

Definition at line 69 of file ValidType.hpp.

◆ ValidType() [2/2]

template<class T >
gnsstk::ValidType< T >::ValidType ( )
inline

Definition at line 70 of file ValidType.hpp.

Member Function Documentation

◆ get_value()

template<class T >
T gnsstk::ValidType< T >::get_value ( ) const
inline

Definition at line 97 of file ValidType.hpp.

◆ is_valid()

template<class T >
bool gnsstk::ValidType< T >::is_valid ( ) const
inline

Definition at line 96 of file ValidType.hpp.

◆ operator T()

template<class T >
gnsstk::ValidType< T >::operator T ( ) const
inline

A conversion operator, will throw an exception if the object is marked invalid.

Exceptions
InvalidValue

Definition at line 82 of file ValidType.hpp.

◆ operator!=()

template<class T >
bool gnsstk::ValidType< T >::operator!= ( const ValidType< T > &  r) const
inline

Definition at line 93 of file ValidType.hpp.

◆ operator+=()

template<class T >
ValidType& gnsstk::ValidType< T >::operator+= ( const T &  r)
inlinenoexcept

Definition at line 75 of file ValidType.hpp.

◆ operator-=()

template<class T >
ValidType& gnsstk::ValidType< T >::operator-= ( const T &  r)
inlinenoexcept

Definition at line 76 of file ValidType.hpp.

◆ operator=()

template<class T >
ValidType& gnsstk::ValidType< T >::operator= ( const T &  v)
inlinenoexcept

Definition at line 72 of file ValidType.hpp.

◆ operator==()

template<class T >
bool gnsstk::ValidType< T >::operator== ( const ValidType< T > &  r) const
inline

Definition at line 88 of file ValidType.hpp.

◆ set_valid()

template<class T >
void gnsstk::ValidType< T >::set_valid ( const bool &  v)
inlinenoexcept

Definition at line 99 of file ValidType.hpp.

Member Data Documentation

◆ valid

template<class T >
bool gnsstk::ValidType< T >::valid
private

Definition at line 104 of file ValidType.hpp.

◆ value

template<class T >
T gnsstk::ValidType< T >::value
private

Definition at line 103 of file ValidType.hpp.


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


gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:46