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.

Definition at line 43 of file SatelliteSystem.hpp.

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.

Definition at line 46 of file SatelliteSystem.hpp.

Constructor & Destructor Documentation

◆ SatelliteSystem() [1/3]

NAV::SatelliteSystem::SatelliteSystem ( )

constexprdefault

Default Constructor.

◆ SatelliteSystem() [2/3]

NAV::SatelliteSystem::SatelliteSystem ( SatelliteSystem_ type )

inlineconstexpr

Implicit Constructor from Value type.

Parameters

[in] type Value type to construct from

Definition at line 64 of file SatelliteSystem.hpp.

◆ SatelliteSystem() [3/3]

NAV::SatelliteSystem::SatelliteSystem ( Enum enumeration )

inline

Implicit Constructor from Enum type.

Parameters

[in] enumeration Enum type to construct from

Definition at line 70 of file SatelliteSystem.hpp.

Member Function Documentation

◆ fromChar()

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

static

Construct new object from char.

Parameters

[in] typeChar Character representation of the satellite system

Definition at line 55 of file SatelliteSystem.cpp.

◆ fromEnum()

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

static

Constructs a new object from continuous enumeration.

Parameters

[in] enumeration Continuous enumeration of the satellite system

Definition at line 80 of file SatelliteSystem.cpp.

◆ fromString()

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

static

Construct new object from std::string.

Parameters

[in] typeString String representation of the satellite system

Definition at line 21 of file SatelliteSystem.cpp.

◆ GetAll()

std::vector< SatelliteSystem > NAV::SatelliteSystem::GetAll ( )

static

Returns a list with all possible satellite systems.

Definition at line 306 of file SatelliteSystem.cpp.

◆ GetSatelliteInfo()

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

Definition at line 209 of file SatelliteSystem.cpp.

◆ 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

Definition at line 247 of file SatelliteSystem.cpp.

◆ getSatellites()

std::vector< uint16_t > NAV::SatelliteSystem::getSatellites ( ) const

nodiscard

Get a list of satellites in the constellation.

Definition at line 204 of file SatelliteSystem.cpp.

◆ GetSatellitesForSatelliteSystem()

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

Definition at line 173 of file SatelliteSystem.cpp.

◆ getTimeSystem()

TimeSystem NAV::SatelliteSystem::getTimeSystem ( ) const

nodiscard

Get the Time System of this Satellite System.

Definition at line 168 of file SatelliteSystem.cpp.

◆ GetTimeSystemForSatelliteSystem()

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

Definition at line 144 of file SatelliteSystem.cpp.

◆ operator bool()

NAV::SatelliteSystem::operator bool ( )

explicitconstexprdelete

Prevent usage: if(...)

◆ operator char()

NAV::SatelliteSystem::operator char ( ) const

explicit

char conversion operator

Returns: A char representation of the type

Definition at line 119 of file SatelliteSystem.cpp.

◆ operator SatelliteSystem_()

NAV::SatelliteSystem::operator SatelliteSystem_ ( ) const

inlineexplicitconstexpr

Allow switch(SatelliteSystem_(type)) and comparisons.

Definition at line 103 of file SatelliteSystem.hpp.

◆ operator std::string()

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

explicit

std::string conversion operator

Returns: A std::string representation of the type

Definition at line 105 of file SatelliteSystem.cpp.

◆ operator uint64_t()

NAV::SatelliteSystem::operator uint64_t ( ) const

inlineexplicitconstexpr

int conversion operator

Returns: A int representation of the type

Definition at line 109 of file SatelliteSystem.hpp.

◆ 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

Definition at line 100 of file SatelliteSystem.hpp.

◆ 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

Definition at line 89 of file SatelliteSystem.hpp.

◆ ToChar()

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

Definition at line 281 of file SatelliteSystem.cpp.

◆ toChar()

char NAV::SatelliteSystem::toChar ( ) const

nodiscard

Returns the char representation of the object.

Definition at line 286 of file SatelliteSystem.cpp.

◆ ToEnumeration()

SatelliteSystem::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

Definition at line 252 of file SatelliteSystem.cpp.

◆ toEnumeration()

SatelliteSystem::Enum NAV::SatelliteSystem::toEnumeration ( ) const

nodiscard

Returns a continuous enumeration of the object.

Definition at line 276 of file SatelliteSystem.cpp.

◆ ToVector()

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

Definition at line 291 of file SatelliteSystem.cpp.

◆ toVector()

std::vector< SatelliteSystem > NAV::SatelliteSystem::toVector ( ) const

nodiscard

Get a vector representation of the specified Satellite Systems.

Definition at line 301 of file SatelliteSystem.cpp.

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

Definition at line 347 of file SatelliteSystem.hpp.

Field Documentation

◆ value

SatelliteSystem_ NAV::SatelliteSystem::value

private

Internal value.

Definition at line 170 of file SatelliteSystem.hpp.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Enum

Constructor & Destructor Documentation

◆ SatelliteSystem() [1/3]

◆ SatelliteSystem() [2/3]

◆ SatelliteSystem() [3/3]

Member Function Documentation

◆ fromChar()

◆ fromEnum()

◆ fromString()

◆ GetAll()

◆ GetSatelliteInfo()

◆ getSatelliteInfo()

◆ getSatellites()

◆ GetSatellitesForSatelliteSystem()

◆ getTimeSystem()

◆ GetTimeSystemForSatelliteSystem()

◆ operator bool()

◆ operator char()

◆ operator SatelliteSystem_()

◆ operator std::string()

◆ operator uint64_t()

◆ operator<()

◆ operator=()

◆ ToChar()

◆ toChar()

◆ ToEnumeration()

◆ toEnumeration()

◆ ToVector()

◆ toVector()

Friends And Related Symbol Documentation

◆ operator==

Field Documentation

◆ value