Satellite System type. More...

Public Types
enum	Enum : uint8_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::optional< std::string >	getSatelliteInfo (uint16_t satNum) const
	Get additional information about the satellite if available.

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::optional< std::string >	GetSatelliteInfo (SatelliteSystem satSys, uint16_t satNum)
	Get additional information about the satellite if available.

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.

Private Attributes
SatelliteSystem_	value
	Internal value.

Friends
constexpr bool	operator== (const SatelliteSystem &lhs, const SatelliteSystem &rhs)
	Equal compares values.

Detailed Description

Satellite System type.

Member Enumeration Documentation

◆ Enum

enum NAV::SatelliteSystem::Enum : uint8_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]

NAV::SatelliteSystem::SatelliteSystem ( SatelliteSystem_ type )

inlineconstexpr

Implicit Constructor from Value type.

Parameters

[in] type Value type to construct from

◆ SatelliteSystem() [2/2]

NAV::SatelliteSystem::SatelliteSystem ( Enum enumeration )

inline

Implicit Constructor from Enum type.

Parameters

[in] enumeration Enum type to construct from

Member Function Documentation

◆ fromChar()

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

static

Construct new object from char.

Parameters

[in] typeChar Character representation of the satellite system

◆ fromEnum()

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

static

Constructs a new object from continuous enumeration.

Parameters

[in] enumeration Continuous enumeration of the satellite system

◆ fromString()

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

static

Construct new object from std::string.

Parameters

[in] typeString String representation of the satellite system

◆ GetSatelliteInfo()

static std::optional< std::string > NAV::SatelliteSystem::GetSatelliteInfo	(	SatelliteSystem	satSys,
		uint16_t	satNum )

static

Get additional information about the satellite if available.

Parameters

[in]	satSys	Satellite System
[in]	satNum	Satellite Number

Returns: Optional String of additional information

◆ getSatelliteInfo()

std::optional< std::string > NAV::SatelliteSystem::getSatelliteInfo ( uint16_t satNum ) const

nodiscard

Get additional information about the satellite if available.

Parameters

[in] satNum Satellite Number

Returns: Optional String of additional information

◆ GetSatellitesForSatelliteSystem()

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

static

Get a list of satellites in the constellation.

Parameters

[in] satSys Satellite 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] satSys Satellite 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()

NAV::SatelliteSystem::operator uint64_t ( ) const

inlineexplicitconstexpr

int conversion operator

Returns: A int representation of the type

◆ operator<()

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

inlineconstexpr

Less than comparison (needed for map)

Parameters

[in] rhs Right hand side of the operator

Returns: True if lhs < rhs

◆ operator=()

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

inlineconstexpr

Assignment operator from Value type.

Parameters

[in] v Value 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] satSys Satellite 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] satSys Satellite 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] satSys Satellite System to get the vector for

Friends And Related Symbol Documentation

◆ operator==

bool operator==	(	const SatelliteSystem &	lhs,
		const SatelliteSystem &	rhs )

friend

Equal compares values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns: Whether the comparison was successful

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

/home/runner/work/INSTINCT/INSTINCT/src/Navigation/GNSS/Core/SatelliteSystem.hpp

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Enum

Constructor & Destructor Documentation

◆ SatelliteSystem() [1/2]

◆ SatelliteSystem() [2/2]

Member Function Documentation

◆ fromChar()

◆ fromEnum()

◆ fromString()

◆ GetSatelliteInfo()

◆ getSatelliteInfo()

◆ GetSatellitesForSatelliteSystem()

◆ GetTimeSystemForSatelliteSystem()

◆ operator char()

◆ operator std::string()

◆ operator uint64_t()

◆ operator<()

◆ operator=()

◆ ToChar()

◆ ToEnumeration()

◆ ToVector()

Friends And Related Symbol Documentation

◆ operator==