Frequency definition for different satellite systems. More...

Public Types
enum	Enum : size_t { Enum_G01 , Enum_G02 , Enum_G05 , Enum_E01 , Enum_E05 , Enum_E06 , Enum_E07 , Enum_E08 , Enum_R01 , Enum_R02 , Enum_R03 , Enum_R04 , Enum_R06 , Enum_B01 , Enum_B02 , Enum_B05 , Enum_B06 , Enum_B07 , Enum_B08 , Enum_J01 , Enum_J02 , Enum_J05 , Enum_J06 , Enum_I05 , Enum_I09 , Enum_S01 , Enum_S05 , Enum_COUNT , Enum_None }
	Satellite System enumeration with continuous range. Not usable as a mask. More...

Public Member Functions
size_t	count () const
	Counts the amount of frequencies contained.

constexpr	Frequency ()=default
	Default Constructor.

	Frequency (Enum enumeration)
	Implicit Constructor from Enum type.

constexpr	Frequency (Frequency_ type)
	Implicit Constructor from Value type.

double	getFrequency (int8_t num) const
	Get the frequency in [Hz].

Frequency	getL1 () const
	Returns the L1 Frequency for each constellation.

SatelliteSystem	getSatSys () const
	Get the satellite system for which this frequency is defined.

constexpr	operator bool ()=delete
	Prevent usage: if(...)

constexpr	operator Frequency_ () const
	Allow switch(Frequency_(type)) and comparisons.

	operator std::string () const
	std::string conversion operator

constexpr	operator uint64_t () const
	int conversion operator

constexpr bool	operator< (const Frequency &rhs) const
	Less than comparison (needed for map)

constexpr Frequency &	operator= (Frequency_ v)
	Assignment operator from Value type.

Enum	toEnumeration () const
	Returns a continuous enumeration of the object.

Static Public Member Functions
static Frequency	fromEnum (Enum enumeration)
	Constructs a new object from continuous enumeration.

static Frequency	fromString (const std::string &typeString)
	Construct new object from std::string.

static constexpr std::array< Frequency, 27 >	GetAll ()
	Returns a list with all possible frequencies.

static double	GetFrequency (Frequency freq, int8_t num)
	Get the frequency in [Hz].

static Frequency	GetL1 (Frequency freq)
	Returns the L1 Frequency for each constellation.

static SatelliteSystem	GetSatelliteSystemForFrequency (Frequency freq)
	Get the Time System of the specified Frequency.

static Enum	ToEnumeration (Frequency freq)
	Get the continuous enumeration of the specified frequency.

Detailed Description

Frequency definition for different satellite systems.

Member Enumeration Documentation

◆ Enum

enum NAV::Frequency::Enum : size_t

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

Enumerator
Enum_G01	GPS L1 (1575.42 MHz).
Enum_G02	GPS L2 (1227.6 MHz).
Enum_G05	GPS L5 (1176.45 MHz).
Enum_E01	Galileo, "E1" (1575.42 MHz).
Enum_E05	Galileo E5a (1176.45 MHz).
Enum_E06	Galileo E6 (1278.75 MHz).
Enum_E07	Galileo E5b (1207.14 MHz).
Enum_E08	Galileo E5 (E5a + E5b) (1191.795MHz).
Enum_R01	GLONASS, "G1" (1602 MHZ).
Enum_R02	GLONASS, "G2" (1246 MHz).
Enum_R03	GLONASS, "G3" (1202.025 MHz).
Enum_R04	GLONASS, "G1a" (1600.995 MHZ).
Enum_R06	GLONASS, "G2a" (1248.06 MHz).
Enum_B01	Beidou B1 (1575.42 MHz).
Enum_B02	Beidou B1-2 (1561.098 MHz).
Enum_B05	Beidou B2a (1176.45 MHz).
Enum_B06	Beidou B3 (1268.52 MHz).
Enum_B07	Beidou B2b (1207.14 MHz).
Enum_B08	Beidou B2 (B2a + B2b) (1191.795MHz).
Enum_J01	QZSS L1 (1575.42 MHz).
Enum_J02	QZSS L2 (1227.6 MHz).
Enum_J05	QZSS L5 (1176.45 MHz).
Enum_J06	QZSS L6 / LEX (1278.75 MHz).
Enum_I05	IRNSS L5 (1176.45 MHz).
Enum_I09	IRNSS S (2492.028 MHz).
Enum_S01	SBAS L1 (1575.42 MHz).
Enum_S05	SBAS L5 (1176.45 MHz).
Enum_COUNT	Count variable.
Enum_None	No Frequency.

Constructor & Destructor Documentation

◆ Frequency() [1/2]

constexpr NAV::Frequency::Frequency ( Frequency_ type )

inlineconstexpr

Implicit Constructor from Value type.

Parameters

[in] type Value type to construct from

◆ Frequency() [2/2]

NAV::Frequency::Frequency ( Enum enumeration )

inline

Implicit Constructor from Enum type.

Parameters

[in] enumeration Enum type to construct from

Member Function Documentation

◆ fromEnum()

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

static

Constructs a new object from continuous enumeration.

Parameters

[in] enumeration Continuous enumeration of the frequency

◆ fromString()

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

static

Construct new object from std::string.

Parameters

[in] typeString String representation of the frequency

◆ GetFrequency()

static double NAV::Frequency::GetFrequency	(	Frequency	freq,
		int8_t	num )

static

Get the frequency in [Hz].

Parameters

[in]	freq	Frequency to get the value for
[in]	num	Frequency number. Only used for GLONASS G1 and G2

◆ getFrequency()

double NAV::Frequency::getFrequency ( int8_t num ) const

inline

Get the frequency in [Hz].

Parameters

[in] num Frequency number. Only used for GLONASS G1 and G2

◆ GetL1()

static Frequency NAV::Frequency::GetL1 ( Frequency freq )

static

Returns the L1 Frequency for each constellation.

Parameters

[in] freq Frequency to get the value for

◆ GetSatelliteSystemForFrequency()

static SatelliteSystem NAV::Frequency::GetSatelliteSystemForFrequency ( Frequency freq )

static

Get the Time System of the specified Frequency.

Parameters

[in] freq Frequency to get the satellite system for

◆ operator std::string()

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

explicit

std::string conversion operator

Returns: A std::string representation of the type

◆ operator uint64_t()

constexpr NAV::Frequency::operator uint64_t ( ) const

inlineexplicitconstexpr

int conversion operator

Returns: A int representation of the type

◆ operator<()

constexpr bool NAV::Frequency::operator< ( const Frequency & rhs ) const

inlineconstexpr

Less than comparison (needed for map)

Parameters

[in] rhs Right hand side of the operator

Returns: True if lhs < rhs

◆ operator=()

constexpr Frequency & NAV::Frequency::operator= ( Frequency_ v )

inlineconstexpr

Assignment operator from Value type.

Parameters

[in] v Value type to construct from

Returns: The Type type from the value type

◆ ToEnumeration()

static Enum NAV::Frequency::ToEnumeration ( Frequency freq )

static

Get the continuous enumeration of the specified frequency.

Parameters

[in] freq Frequency to get the continuous enumeration for

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

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

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Enum

Constructor & Destructor Documentation

◆ Frequency() [1/2]

◆ Frequency() [2/2]

Member Function Documentation

◆ fromEnum()

◆ fromString()

◆ GetFrequency()

◆ getFrequency()

◆ GetL1()

◆ GetSatelliteSystemForFrequency()

◆ operator std::string()

◆ operator uint64_t()

◆ operator<()

◆ operator=()

◆ ToEnumeration()