0.2.0
Loading...
Searching...
No Matches
Classes | Enumerations | Functions | Variables
Frequency.hpp File Reference

Frequency definition for different satellite systems. More...

Go to the source code of this file.

Classes

class  NAV::Frequency
 Frequency definition for different satellite systems. More...
 
struct  std::hash< NAV::Frequency >
 Hash function for Frequency (needed for unordered_map) More...
 
struct  std::hash< NAV::Frequency_ >
 Hash function for Frequency (needed for unordered_map) More...
 

Enumerations

enum  NAV::Frequency_ : uint64_t {
  NAV::Freq_None ,
  NAV::G01 ,
  NAV::G02 ,
  NAV::G05 ,
  NAV::E01 ,
  NAV::E05 ,
  NAV::E06 ,
  NAV::E07 ,
  NAV::E08 ,
  NAV::R01 ,
  NAV::R02 ,
  NAV::R03 ,
  NAV::R04 ,
  NAV::R06 ,
  NAV::B01 ,
  NAV::B02 ,
  NAV::B05 ,
  NAV::B06 ,
  NAV::B07 ,
  NAV::B08 ,
  NAV::J01 ,
  NAV::J02 ,
  NAV::J05 ,
  NAV::J06 ,
  NAV::I05 ,
  NAV::I09 ,
  NAV::S01 ,
  NAV::S05
}
 Enumerate for GNSS frequencies. More...
 

Functions

void NAV::from_json (const json &j, Frequency &data)
 Converts the provided json object into a link object.
 
constexpr bool NAV::operator!= (const Frequency &lhs, const Frequency &rhs)
 Inequal compares values.
 
constexpr bool NAV::operator!= (const Frequency &lhs, const Frequency_ &rhs)
 Inequal compares values.
 
constexpr bool NAV::operator!= (const Frequency_ &lhs, const Frequency &rhs)
 Inequal compares values.
 
constexpr Frequency_ NAV::operator& (Frequency lhs, Frequency rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency_ NAV::operator& (Frequency lhs, Frequency_ rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency_ NAV::operator& (Frequency lhs, SatelliteSystem rhs)
 Allows filtering Frequency with SatelliteSystem.
 
constexpr Frequency_ NAV::operator& (Frequency lhs, SatelliteSystem_ rhs)
 Allows filtering Frequency with SatelliteSystem.
 
constexpr Frequency_ NAV::operator& (Frequency_ lhs, Frequency rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency_ NAV::operator& (Frequency_ lhs, Frequency_ rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency_ NAV::operator& (Frequency_ lhs, SatelliteSystem rhs)
 Allows filtering Frequency with SatelliteSystem.
 
constexpr Frequency_ NAV::operator& (Frequency_ lhs, SatelliteSystem_ rhs)
 Allows filtering Frequency with SatelliteSystem.
 
constexpr Frequency_ NAV::operator& (SatelliteSystem lhs, Frequency rhs)
 Allows filtering Frequency with SatelliteSystem.
 
constexpr Frequency_ NAV::operator& (SatelliteSystem lhs, Frequency_ rhs)
 Allows filtering Frequency with SatelliteSystem.
 
constexpr Frequency_ NAV::operator& (SatelliteSystem_ lhs, Frequency rhs)
 Allows filtering Frequency with SatelliteSystem.
 
constexpr Frequency_ NAV::operator& (SatelliteSystem_ lhs, Frequency_ rhs)
 Allows filtering Frequency with SatelliteSystem.
 
constexpr Frequency & NAV::operator&= (Frequency &lhs, const Frequency &rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency & NAV::operator&= (Frequency &lhs, const Frequency_ &rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency & NAV::operator&= (Frequency &lhs, const SatelliteSystem &rhs)
 Allows filtering Frequency with SatelliteSystem.
 
constexpr Frequency & NAV::operator&= (Frequency &lhs, const SatelliteSystem_ &rhs)
 Allows filtering Frequency with SatelliteSystem.
 
constexpr Frequency_ & NAV::operator&= (Frequency_ &lhs, const Frequency &rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency_ & NAV::operator&= (Frequency_ &lhs, const Frequency_ &rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency_ & NAV::operator&= (Frequency_ &lhs, const SatelliteSystem &rhs)
 Allows filtering Frequency with SatelliteSystem.
 
constexpr Frequency_ & NAV::operator&= (Frequency_ &lhs, const SatelliteSystem_ &rhs)
 Allows filtering Frequency with SatelliteSystem.
 
std::ostream & operator<< (std::ostream &os, const NAV::Frequency &obj)
 Stream insertion operator overload.
 
constexpr bool NAV::operator== (const Frequency &lhs, const Frequency &rhs)
 Equal compares values.
 
constexpr bool NAV::operator== (const Frequency &lhs, const Frequency_ &rhs)
 Equal compares values.
 
constexpr bool NAV::operator== (const Frequency_ &lhs, const Frequency &rhs)
 Equal compares values.
 
constexpr Frequency_ NAV::operator| (Frequency lhs, Frequency rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency_ NAV::operator| (Frequency lhs, Frequency_ rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency_ NAV::operator| (Frequency_ lhs, Frequency rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency_ NAV::operator| (Frequency_ lhs, Frequency_ rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency & NAV::operator|= (Frequency &lhs, const Frequency &rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency & NAV::operator|= (Frequency &lhs, const Frequency_ &rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency_ & NAV::operator|= (Frequency_ &lhs, const Frequency &rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency_ & NAV::operator|= (Frequency_ &lhs, const Frequency_ &rhs)
 Allows combining flags of the Frequency enum.
 
constexpr Frequency_ NAV::operator~ (Frequency rhs)
 Allows negating flags of the Frequency enum.
 
constexpr Frequency_ NAV::operator~ (Frequency_ rhs)
 Allows negating flags of the Frequency enum.
 
bool NAV::ShowFrequencySelector (const char *label, Frequency &frequency, bool singleSelect=false)
 Shows a ComboBox to select GNSS frequencies.
 
void NAV::to_json (json &j, const Frequency &data)
 Converts the provided link into a json object.
 

Variables

constexpr Frequency_ NAV::Freq_All
 All Frequencies.
 

Detailed Description

Frequency definition for different satellite systems.

Author
T. Topp (topp@.nosp@m.ins..nosp@m.uni-s.nosp@m.tutt.nosp@m.gart..nosp@m.de)
Date
2022-04-26

Enumeration Type Documentation

◆ Frequency_

enum NAV::Frequency_ : uint64_t

Enumerate for GNSS frequencies.

Enumerator
Freq_None 

None.

G01 

GPS L1 (1575.42 MHz).

G02 

GPS L2 (1227.6 MHz).

G05 

GPS L5 (1176.45 MHz).

E01 

Galileo, "E1" (1575.42 MHz).

E05 

Galileo E5a (1176.45 MHz).

E06 

Galileo E6 (1278.75 MHz).

E07 

Galileo E5b (1207.14 MHz).

E08 

Galileo E5 (E5a + E5b) (1191.795MHz).

R01 

GLONASS, "G1" (1602 MHZ).

R02 

GLONASS, "G2" (1246 MHz).

R03 

GLONASS, "G3" (1202.025 MHz).

R04 

GLONASS, "G1a" (1600.995 MHZ).

R06 

GLONASS, "G2a" (1248.06 MHz).

B01 

Beidou B1 (1575.42 MHz).

B02 

Beidou B1-2 (1561.098 MHz).

B05 

Beidou B2a (1176.45 MHz).

B06 

Beidou B3 (1268.52 MHz).

B07 

Beidou B2b (1207.14 MHz).

B08 

Beidou B2 (B2a + B2b) (1191.795MHz).

J01 

QZSS L1 (1575.42 MHz).

J02 

QZSS L2 (1227.6 MHz).

J05 

QZSS L5 (1176.45 MHz).

J06 

QZSS L6 / LEX (1278.75 MHz).

I05 

IRNSS L5 (1176.45 MHz).

I09 

IRNSS S (2492.028 MHz).

S01 

SBAS L1 (1575.42 MHz).

S05 

SBAS L5 (1176.45 MHz).

Function Documentation

◆ from_json()

void NAV::from_json ( const json & j,
Frequency & data )

Converts the provided json object into a link object.

Parameters
[in]jJson object with the needed values
[out]dataObject to fill from the json

◆ operator!=() [1/3]

constexpr bool NAV::operator!= ( const Frequency & lhs,
const Frequency & rhs )
constexpr

Inequal compares values.

Parameters
[in]lhsLeft-hand side of the operator
[in]rhsRight-hand side of the operator
Returns
Whether the comparison was successful

◆ operator!=() [2/3]

constexpr bool NAV::operator!= ( const Frequency & lhs,
const Frequency_ & rhs )
constexpr

Inequal compares values.

Parameters
[in]lhsLeft-hand side of the operator
[in]rhsRight-hand side of the operator
Returns
Whether the comparison was successful

◆ operator!=() [3/3]

constexpr bool NAV::operator!= ( const Frequency_ & lhs,
const Frequency & rhs )
constexpr

Inequal compares values.

Parameters
[in]lhsLeft-hand side of the operator
[in]rhsRight-hand side of the operator
Returns
Whether the comparison was successful

◆ operator&() [1/12]

constexpr Frequency_ NAV::operator& ( Frequency lhs,
Frequency rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&() [2/12]

constexpr Frequency_ NAV::operator& ( Frequency lhs,
Frequency_ rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&() [3/12]

constexpr Frequency_ NAV::operator& ( Frequency lhs,
SatelliteSystem rhs )
constexpr

Allows filtering Frequency with SatelliteSystem.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&() [4/12]

constexpr Frequency_ NAV::operator& ( Frequency lhs,
SatelliteSystem_ rhs )
constexpr

Allows filtering Frequency with SatelliteSystem.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&() [5/12]

constexpr Frequency_ NAV::operator& ( Frequency_ lhs,
Frequency rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&() [6/12]

constexpr Frequency_ NAV::operator& ( Frequency_ lhs,
Frequency_ rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&() [7/12]

constexpr Frequency_ NAV::operator& ( Frequency_ lhs,
SatelliteSystem rhs )
constexpr

Allows filtering Frequency with SatelliteSystem.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&() [8/12]

constexpr Frequency_ NAV::operator& ( Frequency_ lhs,
SatelliteSystem_ rhs )
constexpr

Allows filtering Frequency with SatelliteSystem.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&() [9/12]

constexpr Frequency_ NAV::operator& ( SatelliteSystem lhs,
Frequency rhs )
constexpr

Allows filtering Frequency with SatelliteSystem.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&() [10/12]

constexpr Frequency_ NAV::operator& ( SatelliteSystem lhs,
Frequency_ rhs )
constexpr

Allows filtering Frequency with SatelliteSystem.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&() [11/12]

constexpr Frequency_ NAV::operator& ( SatelliteSystem_ lhs,
Frequency rhs )
constexpr

Allows filtering Frequency with SatelliteSystem.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&() [12/12]

constexpr Frequency_ NAV::operator& ( SatelliteSystem_ lhs,
Frequency_ rhs )
constexpr

Allows filtering Frequency with SatelliteSystem.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&=() [1/8]

constexpr Frequency & NAV::operator&= ( Frequency & lhs,
const Frequency & rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&=() [2/8]

constexpr Frequency & NAV::operator&= ( Frequency & lhs,
const Frequency_ & rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&=() [3/8]

constexpr Frequency & NAV::operator&= ( Frequency & lhs,
const SatelliteSystem & rhs )
constexpr

Allows filtering Frequency with SatelliteSystem.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&=() [4/8]

constexpr Frequency & NAV::operator&= ( Frequency & lhs,
const SatelliteSystem_ & rhs )
constexpr

Allows filtering Frequency with SatelliteSystem.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&=() [5/8]

constexpr Frequency_ & NAV::operator&= ( Frequency_ & lhs,
const Frequency & rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&=() [6/8]

constexpr Frequency_ & NAV::operator&= ( Frequency_ & lhs,
const Frequency_ & rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&=() [7/8]

constexpr Frequency_ & NAV::operator&= ( Frequency_ & lhs,
const SatelliteSystem & rhs )
constexpr

Allows filtering Frequency with SatelliteSystem.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator&=() [8/8]

constexpr Frequency_ & NAV::operator&= ( Frequency_ & lhs,
const SatelliteSystem_ & rhs )
constexpr

Allows filtering Frequency with SatelliteSystem.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ANDed value.

◆ operator<<()

std::ostream & operator<< ( std::ostream & os,
const NAV::Frequency & obj )

Stream insertion operator overload.

Parameters
[in,out]osOutput stream object to stream the time into
[in]objObject to print
Returns
Returns the output stream object in order to chain stream insertions

◆ operator==() [1/3]

constexpr bool NAV::operator== ( const Frequency & lhs,
const Frequency & rhs )
constexpr

Equal compares values.

Parameters
[in]lhsLeft-hand side of the operator
[in]rhsRight-hand side of the operator
Returns
Whether the comparison was successful

◆ operator==() [2/3]

constexpr bool NAV::operator== ( const Frequency & lhs,
const Frequency_ & rhs )
constexpr

Equal compares values.

Parameters
[in]lhsLeft-hand side of the operator
[in]rhsRight-hand side of the operator
Returns
Whether the comparison was successful

◆ operator==() [3/3]

constexpr bool NAV::operator== ( const Frequency_ & lhs,
const Frequency & rhs )
constexpr

Equal compares values.

Parameters
[in]lhsLeft-hand side of the operator
[in]rhsRight-hand side of the operator
Returns
Whether the comparison was successful

◆ operator|() [1/4]

constexpr Frequency_ NAV::operator| ( Frequency lhs,
Frequency rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ORed value.

◆ operator|() [2/4]

constexpr Frequency_ NAV::operator| ( Frequency lhs,
Frequency_ rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ORed value.

◆ operator|() [3/4]

constexpr Frequency_ NAV::operator| ( Frequency_ lhs,
Frequency rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ORed value.

◆ operator|() [4/4]

constexpr Frequency_ NAV::operator| ( Frequency_ lhs,
Frequency_ rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ORed value.

◆ operator|=() [1/4]

constexpr Frequency & NAV::operator|= ( Frequency & lhs,
const Frequency & rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ORed value.

◆ operator|=() [2/4]

constexpr Frequency & NAV::operator|= ( Frequency & lhs,
const Frequency_ & rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ORed value.

◆ operator|=() [3/4]

constexpr Frequency_ & NAV::operator|= ( Frequency_ & lhs,
const Frequency & rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ORed value.

◆ operator|=() [4/4]

constexpr Frequency_ & NAV::operator|= ( Frequency_ & lhs,
const Frequency_ & rhs )
constexpr

Allows combining flags of the Frequency enum.

Parameters
[in]lhsLeft-hand side enum value.
[in]rhsRight-hand side enum value.
Returns
The binary ORed value.

◆ operator~() [1/2]

constexpr Frequency_ NAV::operator~ ( Frequency rhs)
constexpr

Allows negating flags of the Frequency enum.

Parameters
[in]rhsRight-hand side enum value.
Returns
The binary NEGed value.

◆ operator~() [2/2]

constexpr Frequency_ NAV::operator~ ( Frequency_ rhs)
constexpr

Allows negating flags of the Frequency enum.

Parameters
[in]rhsRight-hand side enum value.
Returns
The binary NEGed value.

◆ ShowFrequencySelector()

bool NAV::ShowFrequencySelector ( const char * label,
Frequency & frequency,
bool singleSelect = false )

Shows a ComboBox to select GNSS frequencies.

Parameters
[in]labelLabel to show beside the combo box. This has to be a unique id for ImGui.
[in,out]frequencyReference to the frequency object to select
[in]singleSelectIf true, only one code can be selected at a time

◆ to_json()

void NAV::to_json ( json & j,
const Frequency & data )

Converts the provided link into a json object.

Parameters
[out]jJson object which gets filled with the info
[in]dataData to convert into json