0.2.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
NAV::SatelliteSystem Struct Reference

Satellite System type. More...

Public Types

enum  Enum : size_t {
  Enum_GPS ,
  Enum_GAL ,
  Enum_GLO ,
  Enum_BDS ,
  Enum_QZSS ,
  Enum_IRNSS ,
  Enum_SBAS ,
  Enum_COUNT ,
  Enum_None
}
 Satellite System enumeration with continuous range. Not usable as a mask. More...
 

Public Member Functions

std::vector< uint16_t > getSatellites () const
 Get a list of satellites in the constellation.
 
TimeSystem getTimeSystem () const
 Get the Time System of this Satellite System.
 
constexpr operator bool ()=delete
 Prevent usage: if(...)
 
 operator char () const
 char conversion operator
 
constexpr operator SatelliteSystem_ () const
 Allow switch(SatelliteSystem_(type)) and comparisons.
 
 operator std::string () const
 std::string conversion operator
 
constexpr operator uint64_t () const
 int conversion operator
 
constexpr bool operator< (const SatelliteSystem &rhs) const
 Less than comparison (needed for map)
 
constexpr SatelliteSystem & operator= (SatelliteSystem_ v)
 Assignment operator from Value type.
 
constexpr SatelliteSystem ()=default
 Default Constructor.
 
 SatelliteSystem (Enum enumeration)
 Implicit Constructor from Enum type.
 
constexpr SatelliteSystem (SatelliteSystem_ type)
 Implicit Constructor from Value type.
 
char toChar () const
 Returns the char representation of the object.
 
Enum toEnumeration () const
 Returns a continuous enumeration of the object.
 
std::vector< SatelliteSystem > toVector () const
 Get a vector representation of the specified Satellite Systems.
 

Static Public Member Functions

static SatelliteSystem fromChar (char typeChar)
 Construct new object from char.
 
static SatelliteSystem fromEnum (Enum enumeration)
 Constructs a new object from continuous enumeration.
 
static SatelliteSystem fromString (const std::string &typeString)
 Construct new object from std::string.
 
static std::vector< SatelliteSystem > GetAll ()
 Returns a list with all possible satellite systems.
 
static std::vector< uint16_t > GetSatellitesForSatelliteSystem (SatelliteSystem satSys)
 Get a list of satellites in the constellation.
 
static TimeSystem GetTimeSystemForSatelliteSystem (SatelliteSystem satSys)
 Get the Time System of the specified Satellite System.
 
static char ToChar (SatelliteSystem satSys)
 Get char representation of the specified Satellite System.
 
static Enum ToEnumeration (SatelliteSystem satSys)
 Get the continuous enumeration of the specified Satellite System.
 
static std::vector< SatelliteSystem > ToVector (SatelliteSystem satSys)
 Get a vector representation of the specified Satellite Systems.
 

Detailed Description

Satellite System type.

Member Enumeration Documentation

◆ Enum

enum NAV::SatelliteSystem::Enum : size_t

Satellite System enumeration with continuous range. Not usable as a mask.

Enumerator
Enum_GPS 

Global Positioning System.

Enum_GAL 

Galileo.

Enum_GLO 

Globalnaja nawigazionnaja sputnikowaja sistema (GLONASS)

Enum_BDS 

Beidou.

Enum_QZSS 

Quasi-Zenith Satellite System.

Enum_IRNSS 

Indian Regional Navigation Satellite System.

Enum_SBAS 

Satellite Based Augmentation System.

Enum_COUNT 

Count variable.

Enum_None 

No Satellite system.

Constructor & Destructor Documentation

◆ SatelliteSystem() [1/2]

constexpr NAV::SatelliteSystem::SatelliteSystem ( SatelliteSystem_ type)
inlineconstexpr

Implicit Constructor from Value type.

Parameters
[in]typeValue type to construct from

◆ SatelliteSystem() [2/2]

NAV::SatelliteSystem::SatelliteSystem ( Enum enumeration)
inline

Implicit Constructor from Enum type.

Parameters
[in]enumerationEnum type to construct from

Member Function Documentation

◆ fromChar()

static SatelliteSystem NAV::SatelliteSystem::fromChar ( char typeChar)
static

Construct new object from char.

Parameters
[in]typeCharCharacter representation of the satellite system

◆ fromEnum()

static SatelliteSystem NAV::SatelliteSystem::fromEnum ( Enum enumeration)
static

Constructs a new object from continuous enumeration.

Parameters
[in]enumerationContinuous enumeration of the satellite system

◆ fromString()

static SatelliteSystem NAV::SatelliteSystem::fromString ( const std::string & typeString)
static

Construct new object from std::string.

Parameters
[in]typeStringString representation of the satellite system

◆ GetSatellitesForSatelliteSystem()

static std::vector< uint16_t > NAV::SatelliteSystem::GetSatellitesForSatelliteSystem ( SatelliteSystem satSys)
static

Get a list of satellites in the constellation.

Parameters
[in]satSysSatellite System to get the list for

◆ GetTimeSystemForSatelliteSystem()

static TimeSystem NAV::SatelliteSystem::GetTimeSystemForSatelliteSystem ( SatelliteSystem satSys)
static

Get the Time System of the specified Satellite System.

Parameters
[in]satSysSatellite System to get the time system for

◆ operator char()

NAV::SatelliteSystem::operator char ( ) const
explicit

char conversion operator

Returns
A char representation of the type

◆ operator std::string()

NAV::SatelliteSystem::operator std::string ( ) const
explicit

std::string conversion operator

Returns
A std::string representation of the type

◆ operator uint64_t()

constexpr NAV::SatelliteSystem::operator uint64_t ( ) const
inlineexplicitconstexpr

int conversion operator

Returns
A int representation of the type

◆ operator<()

constexpr bool NAV::SatelliteSystem::operator< ( const SatelliteSystem & rhs) const
inlineconstexpr

Less than comparison (needed for map)

Parameters
[in]rhsRight hand side of the operator
Returns
True if lhs < rhs

◆ operator=()

constexpr SatelliteSystem & NAV::SatelliteSystem::operator= ( SatelliteSystem_ v)
inlineconstexpr

Assignment operator from Value type.

Parameters
[in]vValue type to construct from
Returns
The Type type from the value type

◆ ToChar()

static char NAV::SatelliteSystem::ToChar ( SatelliteSystem satSys)
static

Get char representation of the specified Satellite System.

Parameters
[in]satSysSatellite System to get the continuous enumeration for

◆ ToEnumeration()

static Enum NAV::SatelliteSystem::ToEnumeration ( SatelliteSystem satSys)
static

Get the continuous enumeration of the specified Satellite System.

Parameters
[in]satSysSatellite System to get the continuous enumeration for

◆ ToVector()

static std::vector< SatelliteSystem > NAV::SatelliteSystem::ToVector ( SatelliteSystem satSys)
static

Get a vector representation of the specified Satellite Systems.

Parameters
[in]satSysSatellite System to get the vector for
The documentation for this struct was generated from the following file: