Skip to main content

Enums and helper functions for describing GNSS

satellites and their signals. More...

Topics Index

 @ref SatelliteType Bitmask Support

These values can be used to specify a bitmask for controlling enabled GNSS constellations. More...

 @ref FrequencyBand Bitmask Support

These values can be used to specify a bitmask for controlling enabled GNSS frequency bands. More...

Enumerations Index

enum classBeiDouSignalName : uint8_t { ... }

The name of a signal from a BeiDou satellite. More...

enum classFrequencyBand : uint8_t { ... }

GNSS frequency band definitions. More...

enum classGalileoSignalName : uint8_t { ... }

The name of a signal from a Galileo satellite. More...

enum classGLONASSSignalName : uint8_t { ... }

The name of a signal from a GLONASS satellite. More...

enum classGNSSComponent : uint8_t { ... }

The component being tracked for signals that have separate data and pilot components. More...

enum classGNSSSignalType : uint16_t { ... }

Representation of the combination of GNSS constellation, signal type, and component being tracked (pilot/data). More...

enum classGPSSignalName : uint8_t { ... }

The name of a signal from a GPS satellite. More...

enum classQZSSSignalName : uint8_t { ... }

The name of a signal from a QZSS satellite. More...

enum classSatelliteType : uint8_t { ... }

System/constellation type definitions. More...

enum classSBASSignalName : uint8_t { ... }

The name of a signal from a SBAS satellite. More...

Operators Index

p1_ostream &operator<< (p1_ostream &stream, BeiDouSignalName type)

BeiDouSignalName stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, FrequencyBand type)

FrequencyBand stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, GalileoSignalName type)

GalileoSignalName stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, GLONASSSignalName type)

GLONASSSignalName stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, GNSSComponent type)

GNSSComponent stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, GNSSSignalType type)

GNSSSignalType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, GPSSignalName type)

GPSSignalName stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, QZSSSignalName type)

QZSSSignalName stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, SatelliteType type)

SatelliteType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, SBASSignalName type)

SBASSignalName stream operator. More...

Functions Index

P1_CONSTEXPR_FUNC BeiDouSignalNameGetBeiDouSignalName (GNSSSignalType signal_type)

Extract the BeiDouSignalName enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC FrequencyBandGetFrequencyBand (GNSSSignalType signal_type)

Extract the FrequencyBand enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC GalileoSignalNameGetGalileoSignalName (GNSSSignalType signal_type)

Extract the GalileoSignalName enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC GLONASSSignalNameGetGLONASSSignalName (GNSSSignalType signal_type)

Extract the GLONASSSignalName enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC GNSSComponentGetGNSSComponent (GNSSSignalType signal_type)

Extract the GNSSComponent enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC GPSSignalNameGetGPSSignalName (GNSSSignalType signal_type)

Extract the GPSSignalName enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC QZSSSignalNameGetQZSSSignalName (GNSSSignalType signal_type)

Extract the QZSSSignalName enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC SatelliteTypeGetSatelliteType (GNSSSignalType signal_type)

Extract the SatelliteType enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC SBASSignalNameGetSBASSignalName (GNSSSignalType signal_type)

Extract the SBASSignalName enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC const char *to_string (BeiDouSignalName type)

Get a string representation of the BeiDouSignalName enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (FrequencyBand type)

Get a string representation of the FrequencyBand enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (GalileoSignalName type)

Get a string representation of the GalileoSignalName enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (GLONASSSignalName type)

Get a string representation of the GLONASSSignalName enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (GNSSComponent type)

Get a string representation of the GNSSComponent enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (GNSSSignalType type)

Get a string representation of the GNSSSignalType enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (GPSSignalName type)

Get a string representation of the GPSSignalName enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (QZSSSignalName type)

Get a string representation of the QZSSSignalName enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (SatelliteType type)

Get a string representation of the SatelliteType enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (SBASSignalName type)

Get a string representation of the SBASSignalName enum value. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (BeiDouSignalName type)

Get a human-friendly string for the specified BeiDouSignalName. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (FrequencyBand type)

Get a human-friendly string for the specified FrequencyBand. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (GalileoSignalName type)

Get a human-friendly string for the specified GalileoSignalName. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (GLONASSSignalName type)

Get a human-friendly string for the specified GLONASSSignalName. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (GNSSComponent type)

Get a human-friendly string for the specified GNSSComponent. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (GNSSSignalType type)

Get a human-friendly string for the specified GNSSSignalType. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (GPSSignalName type)

Get a human-friendly string for the specified GPSSignalName. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (QZSSSignalName type)

Get a human-friendly string for the specified QZSSSignalName. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (SatelliteType type)

Get a human-friendly string for the specified SatelliteType. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (SBASSignalName type)

Get a human-friendly string for the specified SBASSignalName. More...

template <typename SignalName>
P1_CONSTEXPR_FUNC GNSSSignalTypeToSignalType (SatelliteType sv_type, FrequencyBand freq_band, SignalName signal_name, GNSSComponent component)

Create a GNSSSignalType from the enums that it's made up from. More...

template <typename SignalName>
constexpr uint16_tToSignalVal (SatelliteType sv_type, FrequencyBand freq_band, SignalName signal_name, GNSSComponent component)

Create a GNSSSignalType from the enums that it's made up from. More...

const char *ToString (BeiDouSignalName type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (FrequencyBand type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (GalileoSignalName type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (GLONASSSignalName type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (GNSSComponent type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (GNSSSignalType type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (GPSSignalName type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (QZSSSignalName type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (SatelliteType type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (SBASSignalName type)

Get a human-friendly string name for the specified ConfigType. More...

Description

satellites and their signals.

gnss_enums_to_bitmasks

The GNSS signal enumerations can be used in bitmasks, such as listing enabled/disabled signal types. In this case, the bit mask corresponds with the enum value as follows: mask = (1 << bit value)

For example, for GPS signal types, to enable L1 C/A (enum value of 0) and L5 (enum value of 5) signals, a mask of 0x21 would be used, calculated as shown: 0x21 (0b0010 0001) = 0x1 (0b0000 0001) | 0x20 (0b0010 0000)

Enumerations

BeiDouSignalName

enum class point_one::fusion_engine::messages::BeiDouSignalName : uint8_t
strong

The name of a signal from a BeiDou satellite.

Enumeration values
B1I (= 0)
B1C (= 1)
B2I (= 2)
B2B (= 3)
B2A (= 4)
B3I (= 5)

For some purposes, this enum may be used as part of a bitmask. See gnss_enums_to_bitmasks.

This needs to be packed into 3 bits so no values above 7 are allowed.

Definition at line 779 of file signal_defs.h.

780 B1I = 0,
781 B1C = 1,
782 B2I = 2,
783 B2B = 3,
784 B2A = 4,
785 B3I = 5,
786};

FrequencyBand

enum class point_one::fusion_engine::messages::FrequencyBand : uint8_t
strong

GNSS frequency band definitions.

Enumeration values
L1 (= 0)
L2 (= 1)
L5 (= 2)
L6 (= 3)
L1_L2_WIDE_LANE (= 4)
L1_L5_WIDE_LANE (= 5)
S (= 6)

A frequency band generally includes multiple GNSS carrier frequencies and signal types, which can usually be captured by a single antenna element. For example, an L1 antenna typically has sufficient bandwidth to capture signals on the BeiDou B1I (1561.098 MHz), GPS L1 (1575.42 MHz), and GLONASS G1 (1602.0 MHz) frequencies.

For some purposes, this enum may be used as part of a bitmask. See gnss_enums_to_bitmasks.

This needs to be packed into 4 bits so no values about 15 are allowed.

Definition at line 270 of file signal_defs.h.

270enum class FrequencyBand : uint8_t {
271 // ~L1 = 1561.098 MHz (B1) -> 1602 (G1)
272 // Includes: GPS L1, Galileo E1, BeiDou B1I (and B1C == L1), GLONASS G1
273 L1 = 0,
274 // ~L2 = 1202.025 MHz (G3) -> 1248.06 (G2)
275 // Includes: GPS L2, Galileo E5b, BeiDou B2I, GLONASS G2 & G3
276 L2 = 1,
277 // ~L5 = 1176.45 MHz (L5)
278 // Includes: GPS L5, Galileo E5a, BeiDou B2a, IRNSS L5
279 L5 = 2,
280 // ~L6 = 1268.52 MHz (B3) -> 1278.75 MHz (L6)
281 // Includes: Galileo E6, BeiDou B3, QZSS L6
282 L6 = 3,
283 // ~(L1 - L2) = 296.67 MHz (QZSS L6) -> 373.395 MHz (G3)
285 // ~(L1 - L5) = 398.97 MHz (L5)
287 // S band 2 -> 4 GHz
288 // IRNSS S band is 2492.028 MHz
289 S = 6,
290};

GalileoSignalName

enum class point_one::fusion_engine::messages::GalileoSignalName : uint8_t
strong

The name of a signal from a Galileo satellite.

Enumeration values
E1A (= 0)
E1BC (= 1)
E5A (= 2)
E5B (= 3)
E6A (= 4)
E6BC (= 5)

For some purposes, this enum may be used as part of a bitmask. See gnss_enums_to_bitmasks.

This needs to be packed into 3 bits so no values above 7 are allowed.

Definition at line 673 of file signal_defs.h.

674 E1A = 0,
675 E1BC = 1,
676 E5A = 2,
677 E5B = 3,
678 E6A = 4,
679 E6BC = 5,
680};

GLONASSSignalName

enum class point_one::fusion_engine::messages::GLONASSSignalName : uint8_t
strong

The name of a signal from a GLONASS satellite.

Enumeration values
L1CA (= 0)
L1P (= 1)
L2CA (= 2)
L2P (= 3)

For some purposes, this enum may be used as part of a bitmask. See gnss_enums_to_bitmasks.

This needs to be packed into 3 bits so no values above 7 are allowed.

Definition at line 581 of file signal_defs.h.

582 L1CA = 0,
583 L1P = 1,
584 L2CA = 2,
585 L2P = 3,
586};

GNSSComponent

enum class point_one::fusion_engine::messages::GNSSComponent : uint8_t
strong

The component being tracked for signals that have separate data and pilot components.

Enumeration values
COMBINED (= 0)
DATA (= 1)
PILOT (= 2)

This needs to be packed into 2 bits so no values above 3 are allowed.

Definition at line 392 of file signal_defs.h.

392enum class GNSSComponent : uint8_t {
393 COMBINED = 0,
394 DATA = 1,
395 PILOT = 2,
396};

GNSSSignalType

enum class point_one::fusion_engine::messages::GNSSSignalType : uint16_t
strong

Representation of the combination of GNSS constellation, signal type, and component being tracked (pilot/data).

Enumeration values
UNKNOWN (= 0)
GPS_L1CA GPS C/A: 4096 (0x1000) (= ToSignalVal(SatelliteType::GPS, FrequencyBand::L1, GPSSignalName::L1CA, GNSSComponent::COMBINED))
GPS_L1P GPS L1 P(Y): 4100 (0x1004) (= ToSignalVal(SatelliteType::GPS, FrequencyBand::L1, GPSSignalName::L1P, GNSSComponent::COMBINED))
GPS_L1C GPS L1C: 4104 (0x1008) (= ToSignalVal(SatelliteType::GPS, FrequencyBand::L1, GPSSignalName::L1C, GNSSComponent::COMBINED))
GPS_L1C_D GPS L1C-D (Data): 4105 (0x1009) (= ToSignalVal(SatelliteType::GPS, FrequencyBand::L1, GPSSignalName::L1C, GNSSComponent::DATA))
GPS_L1C_P GPS L1C-P (Pilot): 4106 (0x100A) (= ToSignalVal(SatelliteType::GPS, FrequencyBand::L1, GPSSignalName::L1C, GNSSComponent::PILOT))
GPS_L2C GPS L2C: 4172 (0x104C) (= ToSignalVal(SatelliteType::GPS, FrequencyBand::L2, GPSSignalName::L2C, GNSSComponent::COMBINED))
GPS_L2C_M GPS L2C-M (Data): 4173 (0x104D) (= ToSignalVal(SatelliteType::GPS, FrequencyBand::L2, GPSSignalName::L2C, GNSSComponent::DATA))
GPS_L2C_L GPS L2C-L (Pilot): 4174 (0x104E) (= ToSignalVal(SatelliteType::GPS, FrequencyBand::L2, GPSSignalName::L2C, GNSSComponent::PILOT))
GPS_L2P GPS L2 P(Y): 4176 (0x1050) (= ToSignalVal(SatelliteType::GPS, FrequencyBand::L2, GPSSignalName::L2P, GNSSComponent::COMBINED))
GPS_L5 GPS L5: 4244 (0x1094) (= ToSignalVal(SatelliteType::GPS, FrequencyBand::L5, GPSSignalName::L5, GNSSComponent::COMBINED))
GPS_L5_I GPS L5-I (Data): 4245 (0x1095) (= ToSignalVal(SatelliteType::GPS, FrequencyBand::L5, GPSSignalName::L5, GNSSComponent::DATA))
GPS_L5_Q GPS L5-Q (Pilot): 4246 (0x1096) (= ToSignalVal(SatelliteType::GPS, FrequencyBand::L5, GPSSignalName::L5, GNSSComponent::PILOT))
GLONASS_L1CA GLONASS L1 C/A: 8192 (0x2000) (= ToSignalVal(SatelliteType::GLONASS, FrequencyBand::L1, GLONASSSignalName::L1CA, GNSSComponent::COMBINED))
GLONASS_L1P GLONASS L1P: 8196 (0x2004) (= ToSignalVal(SatelliteType::GLONASS, FrequencyBand::L1, GLONASSSignalName::L1P, GNSSComponent::COMBINED))
GLONASS_L2CA GLONASS L2 C/A: 8264 (0x2048) (= ToSignalVal(SatelliteType::GLONASS, FrequencyBand::L2, GLONASSSignalName::L2CA, GNSSComponent::COMBINED))
GLONASS_L2P GLONASS L2P: 8268 (0x204C) (= ToSignalVal(SatelliteType::GLONASS, FrequencyBand::L2, GLONASSSignalName::L2P, GNSSComponent::COMBINED))
GALILEO_E1A Galileo E1-A: 16384 (0x4000) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L1, GalileoSignalName::E1A, GNSSComponent::COMBINED))
GALILEO_E1BC Galileo E1-B/C: 16388 (0x4004) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L1, GalileoSignalName::E1BC, GNSSComponent::COMBINED))
GALILEO_E1B Galileo E1-B (Data): 16389 (0x4005) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L1, GalileoSignalName::E1BC, GNSSComponent::DATA))
GALILEO_E1C Galileo E1-C (Pilot): 16390 (0x4006) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L1, GalileoSignalName::E1BC, GNSSComponent::PILOT))
GALILEO_E5B Galileo E5b: 16460 (0x404C) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L2, GalileoSignalName::E5B, GNSSComponent::COMBINED))
GALILEO_E5B_I Galileo E5b-I (Data): 16461 (0x404D) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L2, GalileoSignalName::E5B, GNSSComponent::DATA))
GALILEO_E5B_Q Galileo E5b-Q (Pilot): 16462 (0x404E) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L2, GalileoSignalName::E5B, GNSSComponent::PILOT))
GALILEO_E5A Galileo E5a: 16520 (0x4088) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L5, GalileoSignalName::E5A, GNSSComponent::COMBINED))
GALILEO_E5A_I Galileo E5a-I (Data): 16521 (0x4089) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L5, GalileoSignalName::E5A, GNSSComponent::DATA))
GALILEO_E5A_Q Galileo E5a-Q (Pilot): 16522 (0x408A) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L5, GalileoSignalName::E5A, GNSSComponent::PILOT))
GALILEO_E6A Galileo E6-A: 16592 (0x40D0) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L6, GalileoSignalName::E6A, GNSSComponent::COMBINED))
GALILEO_E6BC Galileo E6-B/C: 16596 (0x40D4) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L6, GalileoSignalName::E6BC, GNSSComponent::COMBINED))
GALILEO_E6B Galileo E6-B (Data): 16597 (0x40D5) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L6, GalileoSignalName::E6BC, GNSSComponent::DATA))
GALILEO_E6C Galileo E6-C (Pilot): 16598 (0x40D6) (= ToSignalVal(SatelliteType::GALILEO, FrequencyBand::L6, GalileoSignalName::E6BC, GNSSComponent::PILOT))
BEIDOU_B1I BeiDou B1I: 20480 (0x5000) (= ToSignalVal(SatelliteType::BEIDOU, FrequencyBand::L1, BeiDouSignalName::B1I, GNSSComponent::COMBINED))
BEIDOU_B1C BeiDou B1C: 20484 (0x5004) (= ToSignalVal(SatelliteType::BEIDOU, FrequencyBand::L1, BeiDouSignalName::B1C, GNSSComponent::COMBINED))
BEIDOU_B1C_D BeiDou B1C-D (Data): 20485 (0x5005) (= ToSignalVal(SatelliteType::BEIDOU, FrequencyBand::L1, BeiDouSignalName::B1C, GNSSComponent::DATA))
BEIDOU_B1C_P BeiDou B1C-P (Pilot): 20486 (0x5006) (= ToSignalVal(SatelliteType::BEIDOU, FrequencyBand::L1, BeiDouSignalName::B1C, GNSSComponent::PILOT))
BEIDOU_B2I BeiDou B2I: 20552 (0x5048) (= ToSignalVal(SatelliteType::BEIDOU, FrequencyBand::L2, BeiDouSignalName::B2I, GNSSComponent::COMBINED))
BEIDOU_B2B BeiDou B2b: 20556 (0x504C) (= ToSignalVal(SatelliteType::BEIDOU, FrequencyBand::L2, BeiDouSignalName::B2B, GNSSComponent::COMBINED))
BEIDOU_B2A BeiDou B2a: 20624 (0x5090) (= ToSignalVal(SatelliteType::BEIDOU, FrequencyBand::L5, BeiDouSignalName::B2A, GNSSComponent::COMBINED))
BEIDOU_B2A_D BeiDou B2a-D (Data): 20625 (0x5091) (= ToSignalVal(SatelliteType::BEIDOU, FrequencyBand::L5, BeiDouSignalName::B2A, GNSSComponent::DATA))
BEIDOU_B2A_P BeiDou B2a-P (Pilot): 20626 (0x5092) (= ToSignalVal(SatelliteType::BEIDOU, FrequencyBand::L5, BeiDouSignalName::B2A, GNSSComponent::PILOT))
BEIDOU_B3I BeiDou B3I: 20692 (0x50D4) (= ToSignalVal(SatelliteType::BEIDOU, FrequencyBand::L6, BeiDouSignalName::B3I, GNSSComponent::COMBINED))
QZSS_L1CA QZSS C/A: 24576 (0x6000) (= ToSignalVal(SatelliteType::QZSS, FrequencyBand::L1, QZSSSignalName::L1CA, GNSSComponent::COMBINED))
QZSS_L1C QZSS L1C: 24580 (0x6004) (= ToSignalVal(SatelliteType::QZSS, FrequencyBand::L1, QZSSSignalName::L1C, GNSSComponent::COMBINED))
QZSS_L1C_D QZSS L1C-D (Data): 24581 (0x6005) (= ToSignalVal(SatelliteType::QZSS, FrequencyBand::L1, QZSSSignalName::L1C, GNSSComponent::DATA))
QZSS_L1C_P QZSS L1C-P (Pilot): 24582 (0x6006) (= ToSignalVal(SatelliteType::QZSS, FrequencyBand::L1, QZSSSignalName::L1C, GNSSComponent::PILOT))
QZSS_L2C QZSS L2C: 24648 (0x6048) (= ToSignalVal(SatelliteType::QZSS, FrequencyBand::L2, QZSSSignalName::L2C, GNSSComponent::COMBINED))
QZSS_L2C_M QZSS L2C-M (Data): 24649 (0x6049) (= ToSignalVal(SatelliteType::QZSS, FrequencyBand::L2, QZSSSignalName::L2C, GNSSComponent::DATA))
QZSS_L2C_L QZSS L2C-L (Pilot): 24650 (0x604A) (= ToSignalVal(SatelliteType::QZSS, FrequencyBand::L2, QZSSSignalName::L2C, GNSSComponent::PILOT))
QZSS_L6 QZSS L6: 24656 (0x6050) (= ToSignalVal(SatelliteType::QZSS, FrequencyBand::L2, QZSSSignalName::L6, GNSSComponent::COMBINED))
QZSS_L6_M QZSS L6-M (Data): 24657 (0x6051) (= ToSignalVal(SatelliteType::QZSS, FrequencyBand::L2, QZSSSignalName::L6, GNSSComponent::DATA))
QZSS_L6_L QZSS L6-L (Pilot): 24658 (0x6052) (= ToSignalVal(SatelliteType::QZSS, FrequencyBand::L2, QZSSSignalName::L6, GNSSComponent::PILOT))
QZSS_L5 QZSS L5: 24716 (0x608C) (= ToSignalVal(SatelliteType::QZSS, FrequencyBand::L5, QZSSSignalName::L5, GNSSComponent::COMBINED))
QZSS_L5_I QZSS L5-I (Data): 24717 (0x608D) (= ToSignalVal(SatelliteType::QZSS, FrequencyBand::L5, QZSSSignalName::L5, GNSSComponent::DATA))
QZSS_L5_Q QZSS L5-Q (Pilot): 24718 (0x608E) (= ToSignalVal(SatelliteType::QZSS, FrequencyBand::L5, QZSSSignalName::L5, GNSSComponent::PILOT))
SBAS_L1CA SBAS C/A: 32768 (0x8000) (= ToSignalVal(SatelliteType::SBAS, FrequencyBand::L1, SBASSignalName::L1CA, GNSSComponent::COMBINED))
SBAS_L5 SBAS L5: 32900 (0x8084) (= ToSignalVal(SatelliteType::SBAS, FrequencyBand::L5, SBASSignalName::L5, GNSSComponent::COMBINED))
SBAS_L5_I SBAS L5-I (Data): 32901 (0x8085) (= ToSignalVal(SatelliteType::SBAS, FrequencyBand::L5, SBASSignalName::L5, GNSSComponent::DATA))
SBAS_L5_Q SBAS L5-Q (Pilot): 32902 (0x8086) (= ToSignalVal(SatelliteType::SBAS, FrequencyBand::L5, SBASSignalName::L5, GNSSComponent::PILOT))

This enum is organized as a bitmask, defined as follows:

The *SignalName mappings are specific to each SatelliteType. For example, use GPSSignalName for GPS signal definitions.

Each enumeration entry uniquely identifies an individual GNSS signal being tracked by the GNSS receiver. For signals that have separate data and pilot components, the entry indicates which component is being tracked.

Definition at line 1069 of file signal_defs.h.

1070 // clang-format off
1071 UNKNOWN = 0,
1072
1073 //////////////////////////////////////////////////////////////////////////////
1074 // GPS
1075 //////////////////////////////////////////////////////////////////////////////
1076
1077 // L1 Band
1078
1079 /// GPS C/A: 4096 (0x1000)
1082 /// GPS L1 P(Y): 4100 (0x1004)
1085 /// GPS L1C: 4104 (0x1008)
1088 /// GPS L1C-D (Data): 4105 (0x1009)
1091 /// GPS L1C-P (Pilot): 4106 (0x100A)
1094
1095 // L2 Band
1096
1097 /// GPS L2C: 4172 (0x104C)
1100 /// GPS L2C-M (Data): 4173 (0x104D)
1103 /// GPS L2C-L (Pilot): 4174 (0x104E)
1106 /// GPS L2 P(Y): 4176 (0x1050)
1109
1110 // L5 Band
1111
1112 /// GPS L5: 4244 (0x1094)
1115 /// GPS L5-I (Data): 4245 (0x1095)
1118 /// GPS L5-Q (Pilot): 4246 (0x1096)
1121
1122 //////////////////////////////////////////////////////////////////////////////
1123 // GLONASS
1124 //////////////////////////////////////////////////////////////////////////////
1125
1126 // L1 Band
1127
1128 /// GLONASS L1 C/A: 8192 (0x2000)
1131 /// GLONASS L1P: 8196 (0x2004)
1134
1135 // L2 Band
1136
1137 /// GLONASS L2 C/A: 8264 (0x2048)
1140 /// GLONASS L2P: 8268 (0x204C)
1143
1144 //////////////////////////////////////////////////////////////////////////////
1145 // Galileo
1146 //////////////////////////////////////////////////////////////////////////////
1147
1148 // L1 Band
1149
1150 /// Galileo E1-A: 16384 (0x4000)
1153 /// Galileo E1-B/C: 16388 (0x4004)
1156 /// Galileo E1-B (Data): 16389 (0x4005)
1159 /// Galileo E1-C (Pilot): 16390 (0x4006)
1162
1163 // L2 Band
1164
1165 /// Galileo E5b: 16460 (0x404C)
1168 /// Galileo E5b-I (Data): 16461 (0x404D)
1171 /// Galileo E5b-Q (Pilot): 16462 (0x404E)
1174
1175 // L5 Band
1176
1177 /// Galileo E5a: 16520 (0x4088)
1180 /// Galileo E5a-I (Data): 16521 (0x4089)
1183 /// Galileo E5a-Q (Pilot): 16522 (0x408A)
1186
1187 // L6 Band
1188
1189 /// Galileo E6-A: 16592 (0x40D0)
1192 /// Galileo E6-B/C: 16596 (0x40D4)
1195 /// Galileo E6-B (Data): 16597 (0x40D5)
1198 /// Galileo E6-C (Pilot): 16598 (0x40D6)
1201
1202 //////////////////////////////////////////////////////////////////////////////
1203 // BeiDou
1204 //////////////////////////////////////////////////////////////////////////////
1205
1206 // L1 Band
1207
1208 /// BeiDou B1I: 20480 (0x5000)
1211 /// BeiDou B1C: 20484 (0x5004)
1214 /// BeiDou B1C-D (Data): 20485 (0x5005)
1217 /// BeiDou B1C-P (Pilot): 20486 (0x5006)
1220
1221 // L2 Band
1222
1223 /// BeiDou B2I: 20552 (0x5048)
1226 /// BeiDou B2b: 20556 (0x504C)
1229
1230 // L5 Band
1231
1232 /// BeiDou B2a: 20624 (0x5090)
1235 /// BeiDou B2a-D (Data): 20625 (0x5091)
1238 /// BeiDou B2a-P (Pilot): 20626 (0x5092)
1241
1242 // L6 Band
1243
1244 /// BeiDou B3I: 20692 (0x50D4)
1247
1248 //////////////////////////////////////////////////////////////////////////////
1249 // QZSS
1250 //////////////////////////////////////////////////////////////////////////////
1251
1252 // L1 Band
1253
1254 /// QZSS C/A: 24576 (0x6000)
1257 /// QZSS L1C: 24580 (0x6004)
1260 /// QZSS L1C-D (Data): 24581 (0x6005)
1263 /// QZSS L1C-P (Pilot): 24582 (0x6006)
1266
1267 // L2 Band
1268
1269 /// QZSS L2C: 24648 (0x6048)
1272 /// QZSS L2C-M (Data): 24649 (0x6049)
1275 /// QZSS L2C-L (Pilot): 24650 (0x604A)
1278 /// QZSS L6: 24656 (0x6050)
1281 /// QZSS L6-M (Data): 24657 (0x6051)
1284 /// QZSS L6-L (Pilot): 24658 (0x6052)
1287
1288 // L5 Band
1289
1290 /// QZSS L5: 24716 (0x608C)
1293 /// QZSS L5-I (Data): 24717 (0x608D)
1296 /// QZSS L5-Q (Pilot): 24718 (0x608E)
1299
1300 //////////////////////////////////////////////////////////////////////////////
1301 // SBAS
1302 //////////////////////////////////////////////////////////////////////////////
1303
1304 // L1 Band
1305
1306 /// SBAS C/A: 32768 (0x8000)
1309
1310 // L5 Band
1311
1312 /// SBAS L5: 32900 (0x8084)
1315 /// SBAS L5-I (Data): 32901 (0x8085)
1318 /// SBAS L5-Q (Pilot): 32902 (0x8086)
1321 // clang-format on
1322};

GPSSignalName

enum class point_one::fusion_engine::messages::GPSSignalName : uint8_t
strong

The name of a signal from a GPS satellite.

Enumeration values
L1CA (= 0)
L1P (= 1)
L1C (= 2)
L2C (= 3)
L2P (= 4)
L5 (= 5)

For some purposes, this enum may be used as part of a bitmask. See gnss_enums_to_bitmasks.

This needs to be packed into 3 bits so no values above 7 are allowed.

Definition at line 476 of file signal_defs.h.

476enum class GPSSignalName : uint8_t {
477 L1CA = 0,
478 L1P = 1,
479 L1C = 2,
480 L2C = 3,
481 L2P = 4,
482 L5 = 5,
483};

QZSSSignalName

enum class point_one::fusion_engine::messages::QZSSSignalName : uint8_t
strong

The name of a signal from a QZSS satellite.

Enumeration values
L1CA (= 0)
L1C (= 1)
L2C (= 2)
L5 (= 3)
L6 (= 4)

For some purposes, this enum may be used as part of a bitmask. See gnss_enums_to_bitmasks.

This needs to be packed into 3 bits so no values above 7 are allowed.

Definition at line 962 of file signal_defs.h.

962enum class QZSSSignalName : uint8_t {
963 L1CA = 0,
964 L1C = 1,
965 L2C = 2,
966 L5 = 3,
967 L6 = 4,
968};

SatelliteType

enum class point_one::fusion_engine::messages::SatelliteType : uint8_t
strong

System/constellation type definitions.

Enumeration values
UNKNOWN (= 0)
GPS (= 1)
GLONASS (= 2)
LEO (= 3)
GALILEO (= 4)
BEIDOU (= 5)
QZSS (= 6)
MIXED (= 7)
SBAS (= 8)
IRNSS (= 9)

For some purposes, this enum may be used as part of a bitmask. See gnss_enums_to_bitmasks.

This needs to be packed into 4 bits so no values above 15 are allowed.

Definition at line 131 of file signal_defs.h.

131enum class SatelliteType : uint8_t {
132 UNKNOWN = 0,
133 GPS = 1,
134 GLONASS = 2,
135 LEO = 3,
136 GALILEO = 4,
137 BEIDOU = 5,
138 QZSS = 6,
139 MIXED = 7,
140 SBAS = 8,
141 IRNSS = 9,
142};

SBASSignalName

enum class point_one::fusion_engine::messages::SBASSignalName : uint8_t
strong

The name of a signal from a SBAS satellite.

Enumeration values
L1CA (= 0)
L5 (= 1)

For some purposes, this enum may be used as part of a bitmask. See gnss_enums_to_bitmasks.

This needs to be packed into 3 bits so no values above 7 are allowed.

Definition at line 885 of file signal_defs.h.

885enum class SBASSignalName : uint8_t {
886 L1CA = 0,
887 L5 = 1,
888};

Operators

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, BeiDouSignalName type)
inline

BeiDouSignalName stream operator.

Definition at line 826 of file signal_defs.h.

827 stream << to_string(type) << " (" << (int)type << ")";
828 return stream;
829}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, FrequencyBand type)
inline

FrequencyBand stream operator.

Definition at line 333 of file signal_defs.h.

334 stream << to_string(type) << " (" << (int)type << ")";
335 return stream;
336}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, GalileoSignalName type)
inline

GalileoSignalName stream operator.

Definition at line 720 of file signal_defs.h.

721 stream << to_string(type) << " (" << (int)type << ")";
722 return stream;
723}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, GLONASSSignalName type)
inline

GLONASSSignalName stream operator.

Definition at line 620 of file signal_defs.h.

621 stream << to_string(type) << " (" << (int)type << ")";
622 return stream;
623}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, GNSSComponent type)
inline

GNSSComponent stream operator.

Definition at line 427 of file signal_defs.h.

428 stream << to_string(type) << " (" << (int)type << ")";
429 return stream;
430}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, GNSSSignalType type)
inline

GNSSSignalType stream operator.

Definition at line 1518 of file signal_defs.h.

1519 stream << to_string(type) << " (" << (int)type << ")";
1520 return stream;
1521}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, GPSSignalName type)
inline

GPSSignalName stream operator.

Definition at line 523 of file signal_defs.h.

524 stream << to_string(type) << " (" << (int)type << ")";
525 return stream;
526}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, QZSSSignalName type)
inline

QZSSSignalName stream operator.

Definition at line 1005 of file signal_defs.h.

1006 stream << to_string(type) << " (" << (int)type << ")";
1007 return stream;
1008}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, SatelliteType type)
inline

SatelliteType stream operator.

Definition at line 194 of file signal_defs.h.

195 stream << to_string(type) << " (" << (int)type << ")";
196 return stream;
197}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, SBASSignalName type)
inline

SBASSignalName stream operator.

Definition at line 916 of file signal_defs.h.

917 stream << to_string(type) << " (" << (int)type << ")";
918 return stream;
919}

Functions

GetBeiDouSignalName()

P1_CONSTEXPR_FUNC BeiDouSignalName point_one::fusion_engine::messages::GetBeiDouSignalName (GNSSSignalType signal_type)

Extract the BeiDouSignalName enum value from a GNSSSignalType.

Parameters
signal_type

The signal type from which the BeiDouSignalName will be extracted.

Returns

The corresponding enum value.

Definition at line 871 of file signal_defs.h.

872 return static_cast<BeiDouSignalName>(static_cast<uint8_t>(
873 (static_cast<uint16_t>(signal_type) >> SIGNAL_NAME_SHIFT) &
874 ((1 << SIGNAL_NAME_BITS) - 1)));
875}

GetFrequencyBand()

P1_CONSTEXPR_FUNC FrequencyBand point_one::fusion_engine::messages::GetFrequencyBand (GNSSSignalType signal_type)

Extract the FrequencyBand enum value from a GNSSSignalType.

Parameters
signal_type

The signal type from which the FrequencyBand will be extracted.

Returns

The corresponding enum value.

Definition at line 380 of file signal_defs.h.

381 return static_cast<FrequencyBand>(static_cast<uint8_t>(
382 (static_cast<uint16_t>(signal_type) >> FREQUENCY_BAND_SHIFT) &
383 ((1 << FREQUENCY_BAND_BITS) - 1)));
384}

GetGalileoSignalName()

P1_CONSTEXPR_FUNC GalileoSignalName point_one::fusion_engine::messages::GetGalileoSignalName (GNSSSignalType signal_type)

Extract the GalileoSignalName enum value from a GNSSSignalType.

Parameters
signal_type

The signal type from which the GalileoSignalName will be extracted.

Returns

The corresponding enum value.

Definition at line 765 of file signal_defs.h.

766 return static_cast<GalileoSignalName>(static_cast<uint8_t>(
767 (static_cast<uint16_t>(signal_type) >> SIGNAL_NAME_SHIFT) &
768 ((1 << SIGNAL_NAME_BITS) - 1)));
769}

GetGLONASSSignalName()

P1_CONSTEXPR_FUNC GLONASSSignalName point_one::fusion_engine::messages::GetGLONASSSignalName (GNSSSignalType signal_type)

Extract the GLONASSSignalName enum value from a GNSSSignalType.

Parameters
signal_type

The signal type from which the GLONASSSignalName will be extracted.

Returns

The corresponding enum value.

Definition at line 659 of file signal_defs.h.

660 return static_cast<GLONASSSignalName>(static_cast<uint8_t>(
661 (static_cast<uint16_t>(signal_type) >> SIGNAL_NAME_SHIFT) &
662 ((1 << SIGNAL_NAME_BITS) - 1)));
663}

GetGNSSComponent()

P1_CONSTEXPR_FUNC GNSSComponent point_one::fusion_engine::messages::GetGNSSComponent (GNSSSignalType signal_type)

Extract the GNSSComponent enum value from a GNSSSignalType.

Parameters
signal_type

The signal type from which the GNSSComponent will be extracted.

Returns

The corresponding enum value.

Definition at line 462 of file signal_defs.h.

463 return static_cast<GNSSComponent>(static_cast<uint8_t>(
464 (static_cast<uint16_t>(signal_type) >> GNSS_COMPONENT_SHIFT) &
465 ((1 << GNSS_COMPONENT_BITS) - 1)));
466}

GetGPSSignalName()

P1_CONSTEXPR_FUNC GPSSignalName point_one::fusion_engine::messages::GetGPSSignalName (GNSSSignalType signal_type)

Extract the GPSSignalName enum value from a GNSSSignalType.

Parameters
signal_type

The signal type from which the GPSSignalName will be extracted.

Returns

The corresponding enum value.

Definition at line 567 of file signal_defs.h.

568 return static_cast<GPSSignalName>(static_cast<uint8_t>(
569 (static_cast<uint16_t>(signal_type) >> SIGNAL_NAME_SHIFT) &
570 ((1 << SIGNAL_NAME_BITS) - 1)));
571}

GetQZSSSignalName()

P1_CONSTEXPR_FUNC QZSSSignalName point_one::fusion_engine::messages::GetQZSSSignalName (GNSSSignalType signal_type)

Extract the QZSSSignalName enum value from a GNSSSignalType.

Parameters
signal_type

The signal type from which the QZSSSignalName will be extracted.

Returns

The corresponding enum value.

Definition at line 1046 of file signal_defs.h.

1047 return static_cast<QZSSSignalName>(static_cast<uint8_t>(
1048 (static_cast<uint16_t>(signal_type) >> SIGNAL_NAME_SHIFT) &
1049 ((1 << SIGNAL_NAME_BITS) - 1)));
1050}

GetSatelliteType()

P1_CONSTEXPR_FUNC SatelliteType point_one::fusion_engine::messages::GetSatelliteType (GNSSSignalType signal_type)

Extract the SatelliteType enum value from a GNSSSignalType.

Parameters
signal_type

The signal type from which the SatelliteType will be extracted.

Returns

The corresponding enum value.

Definition at line 250 of file signal_defs.h.

251 return static_cast<SatelliteType>(static_cast<uint8_t>(
252 (static_cast<uint16_t>(signal_type) >> SATELLITE_TYPE_SHIFT) &
253 ((1 << SATELLITE_TYPE_BITS) - 1)));
254}

GetSBASSignalName()

P1_CONSTEXPR_FUNC SBASSignalName point_one::fusion_engine::messages::GetSBASSignalName (GNSSSignalType signal_type)

Extract the SBASSignalName enum value from a GNSSSignalType.

Parameters
signal_type

The signal type from which the SBASSignalName will be extracted.

Returns

The corresponding enum value.

Definition at line 948 of file signal_defs.h.

949 return static_cast<SBASSignalName>(static_cast<uint8_t>(
950 (static_cast<uint16_t>(signal_type) >> SIGNAL_NAME_SHIFT) &
951 ((1 << SIGNAL_NAME_BITS) - 1)));
952}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (BeiDouSignalName type)

Get a string representation of the BeiDouSignalName enum value.

Parameters
type

The enum to get the string name for.

Returns

The corresponding string name.

Definition at line 795 of file signal_defs.h.

796 switch (type) {
798 return "B1I";
799
801 return "B1C";
802
804 return "B2I";
805
807 return "B2B";
808
810 return "B2A";
811
813 return "B3I";
814 }
815 return "INVALID";
816}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (FrequencyBand type)

Get a string representation of the FrequencyBand enum value.

Parameters
type

The enum to get the string name for.

Returns

The corresponding string name.

Definition at line 299 of file signal_defs.h.

300 switch (type) {
302 return "L1";
303
305 return "L2";
306
308 return "L5";
309
311 return "L6";
312
314 return "L1_L2_WIDE_LANE";
315
317 return "L1_L5_WIDE_LANE";
318
320 return "S";
321 }
322 return "INVALID";
323}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (GalileoSignalName type)

Get a string representation of the GalileoSignalName enum value.

Parameters
type

The enum to get the string name for.

Returns

The corresponding string name.

Definition at line 689 of file signal_defs.h.

690 switch (type) {
692 return "E1A";
693
695 return "E1BC";
696
698 return "E5A";
699
701 return "E5B";
702
704 return "E6A";
705
707 return "E6BC";
708 }
709 return "INVALID";
710}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (GLONASSSignalName type)

Get a string representation of the GLONASSSignalName enum value.

Parameters
type

The enum to get the string name for.

Returns

The corresponding string name.

Definition at line 595 of file signal_defs.h.

596 switch (type) {
598 return "L1CA";
599
601 return "L1P";
602
604 return "L2CA";
605
607 return "L2P";
608 }
609 return "INVALID";
610}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (GNSSComponent type)

Get a string representation of the GNSSComponent enum value.

Parameters
type

The enum to get the string name for.

Returns

The corresponding string name.

Definition at line 405 of file signal_defs.h.

406 switch (type) {
408 return "COMBINED";
409
411 return "DATA";
412
414 return "PILOT";
415 }
416 return "INVALID";
417}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (GNSSSignalType type)

Get a string representation of the GNSSSignalType enum value.

Parameters
type

The enum to get the string name for.

Returns

The corresponding string name.

Definition at line 1331 of file signal_defs.h.

1332 switch (type) {
1334 return "GPS_L1CA";
1335
1337 return "GPS_L1P";
1338
1340 return "GPS_L1C";
1341
1343 return "GPS_L1C_D";
1344
1346 return "GPS_L1C_P";
1347
1349 return "GPS_L2C";
1350
1352 return "GPS_L2C_M";
1353
1355 return "GPS_L2C_L";
1356
1358 return "GPS_L2P";
1359
1361 return "GPS_L5";
1362
1364 return "GPS_L5_I";
1365
1367 return "GPS_L5_Q";
1368
1370 return "GLONASS_L1CA";
1371
1373 return "GLONASS_L1P";
1374
1376 return "GLONASS_L2CA";
1377
1379 return "GLONASS_L2P";
1380
1382 return "GALILEO_E1A";
1383
1385 return "GALILEO_E1BC";
1386
1388 return "GALILEO_E1B";
1389
1391 return "GALILEO_E1C";
1392
1394 return "GALILEO_E5B";
1395
1397 return "GALILEO_E5B_I";
1398
1400 return "GALILEO_E5B_Q";
1401
1403 return "GALILEO_E5A";
1404
1406 return "GALILEO_E5A_I";
1407
1409 return "GALILEO_E5A_Q";
1410
1412 return "GALILEO_E6A";
1413
1415 return "GALILEO_E6BC";
1416
1418 return "GALILEO_E6B";
1419
1421 return "GALILEO_E6C";
1422
1424 return "BEIDOU_B1I";
1425
1427 return "BEIDOU_B1C";
1428
1430 return "BEIDOU_B1C_D";
1431
1433 return "BEIDOU_B1C_P";
1434
1436 return "BEIDOU_B2I";
1437
1439 return "BEIDOU_B2B";
1440
1442 return "BEIDOU_B2A";
1443
1445 return "BEIDOU_B2A_D";
1446
1448 return "BEIDOU_B2A_P";
1449
1451 return "BEIDOU_B3I";
1452
1454 return "SBAS_L1CA";
1455
1457 return "SBAS_L5";
1458
1460 return "SBAS_L5_I";
1461
1463 return "SBAS_L5_Q";
1464
1466 return "QZSS_L1CA";
1467
1469 return "QZSS_L1C";
1470
1472 return "QZSS_L1C_D";
1473
1475 return "QZSS_L1C_P";
1476
1478 return "QZSS_L2C";
1479
1481 return "QZSS_L2C_M";
1482
1484 return "QZSS_L2C_L";
1485
1487 return "QZSS_L5";
1488
1490 return "QZSS_L5_I";
1491
1493 return "QZSS_L5_Q";
1494
1496 return "QZSS_L6";
1497
1499 return "QZSS_L6_M";
1500
1502 return "QZSS_L6_L";
1503
1505 return "UNKNOWN";
1506 }
1507 return "INVALID";
1508}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (GPSSignalName type)

Get a string representation of the GPSSignalName enum value.

Parameters
type

The enum to get the string name for.

Returns

The corresponding string name.

Definition at line 492 of file signal_defs.h.

493 switch (type) {
495 return "L1CA";
496
498 return "L1P";
499
501 return "L1C";
502
504 return "L2C";
505
507 return "L2P";
508
510 return "L5";
511 }
512 return "INVALID";
513}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (QZSSSignalName type)

Get a string representation of the QZSSSignalName enum value.

Parameters
type

The enum to get the string name for.

Returns

The corresponding string name.

Definition at line 977 of file signal_defs.h.

978 switch (type) {
980 return "L1CA";
981
983 return "L1C";
984
986 return "L2C";
987
989 return "L5";
990
992 return "L6";
993 }
994 return "INVALID";
995}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (SatelliteType type)

Get a string representation of the SatelliteType enum value.

Parameters
type

The enum to get the string name for.

Returns

The corresponding string name.

Definition at line 151 of file signal_defs.h.

152 switch (type) {
154 return "UNKNOWN";
155
157 return "GPS";
158
160 return "GLONASS";
161
163 return "LEO";
164
166 return "GALILEO";
167
169 return "BEIDOU";
170
172 return "QZSS";
173
175 return "MIXED";
176
178 return "SBAS";
179
181 return "IRNSS";
182 }
183 return "INVALID";
184}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (SBASSignalName type)

Get a string representation of the SBASSignalName enum value.

Parameters
type

The enum to get the string name for.

Returns

The corresponding string name.

Definition at line 897 of file signal_defs.h.

898 switch (type) {
900 return "L1CA";
901
903 return "L5";
904 }
905 return "INVALID";
906}

ToPrettyString()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::ToPrettyString (BeiDouSignalName type)

Get a human-friendly string for the specified BeiDouSignalName.

Parameters
type

The enum to get the string for.

Returns

The corresponding string.

Definition at line 838 of file signal_defs.h.

839 switch (type) {
841 return "B1I";
842
844 return "B1C";
845
847 return "B2I";
848
850 return "B2b";
851
853 return "B2a";
854
856 return "B3I";
857 }
858 return "Invalid";
859}

ToPrettyString()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::ToPrettyString (FrequencyBand type)

Get a human-friendly string for the specified FrequencyBand.

Parameters
type

The enum to get the string for.

Returns

The corresponding string.

Definition at line 345 of file signal_defs.h.

346 switch (type) {
348 return "L1";
349
351 return "L2";
352
354 return "L5";
355
357 return "L6";
358
360 return "L1-L2 Wide-Lane";
361
363 return "L1-L5 Wide-Lane";
364
366 return "S";
367 }
368 return "Invalid";
369}

ToPrettyString()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::ToPrettyString (GalileoSignalName type)

Get a human-friendly string for the specified GalileoSignalName.

Parameters
type

The enum to get the string for.

Returns

The corresponding string.

Definition at line 732 of file signal_defs.h.

733 switch (type) {
735 return "E1-A";
736
738 return "E1-B/C";
739
741 return "E5a";
742
744 return "E5b";
745
747 return "E6-A";
748
750 return "E6-B/C";
751 }
752 return "Invalid";
753}

ToPrettyString()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::ToPrettyString (GLONASSSignalName type)

Get a human-friendly string for the specified GLONASSSignalName.

Parameters
type

The enum to get the string for.

Returns

The corresponding string.

Definition at line 632 of file signal_defs.h.

633 switch (type) {
635 return "L1 C/A";
636
638 return "L1P";
639
641 return "L2 C/A";
642
644 return "L2P";
645 }
646 return "Invalid";
647}

ToPrettyString()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::ToPrettyString (GNSSComponent type)

Get a human-friendly string for the specified GNSSComponent.

Parameters
type

The enum to get the string for.

Returns

The corresponding string.

Definition at line 439 of file signal_defs.h.

440 switch (type) {
442 return "Combined";
443
445 return "Data";
446
448 return "Pilot";
449 }
450 return "Invalid";
451}

ToPrettyString()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::ToPrettyString (GNSSSignalType type)

Get a human-friendly string for the specified GNSSSignalType.

Parameters
type

The enum to get the string for.

Returns

The corresponding string.

Definition at line 1530 of file signal_defs.h.

1531 switch (type) {
1533 return "GPS C/A";
1534
1536 return "GPS L1 P(Y)";
1537
1539 return "GPS L1C";
1540
1542 return "GPS L1C-D (Data)";
1543
1545 return "GPS L1C-P (Pilot)";
1546
1548 return "GPS L2C";
1549
1551 return "GPS L2C-M (Data)";
1552
1554 return "GPS L2C-L (Pilot)";
1555
1557 return "GPS L2 P(Y)";
1558
1560 return "GPS L5";
1561
1563 return "GPS L5-I (Data)";
1564
1566 return "GPS L5-Q (Pilot)";
1567
1569 return "GLONASS L1 C/A";
1570
1572 return "GLONASS L1P";
1573
1575 return "GLONASS L2 C/A";
1576
1578 return "GLONASS L2P";
1579
1581 return "Galileo E1-A";
1582
1584 return "Galileo E1-B/C";
1585
1587 return "Galileo E1-B (Data)";
1588
1590 return "Galileo E1-C (Pilot)";
1591
1593 return "Galileo E5b";
1594
1596 return "Galileo E5b-I (Data)";
1597
1599 return "Galileo E5b-Q (Pilot)";
1600
1602 return "Galileo E5a";
1603
1605 return "Galileo E5a-I (Data)";
1606
1608 return "Galileo E5a-Q (Pilot)";
1609
1611 return "Galileo E6-A";
1612
1614 return "Galileo E6-B/C";
1615
1617 return "Galileo E6-B (Data)";
1618
1620 return "Galileo E6-C (Pilot)";
1621
1623 return "BeiDou B1I";
1624
1626 return "BeiDou B1C";
1627
1629 return "BeiDou B1C-D (Data)";
1630
1632 return "BeiDou B1C-P (Pilot)";
1633
1635 return "BeiDou B2I";
1636
1638 return "BeiDou B2b";
1639
1641 return "BeiDou B2a";
1642
1644 return "BeiDou B2a-D (Data)";
1645
1647 return "BeiDou B2a-P (Pilot)";
1648
1650 return "BeiDou B3I";
1651
1653 return "SBAS C/A";
1654
1656 return "SBAS L5";
1657
1659 return "SBAS L5-I (Data)";
1660
1662 return "SBAS L5-Q (Pilot)";
1663
1665 return "QZSS C/A";
1666
1668 return "QZSS L1C";
1669
1671 return "QZSS L1C-D (Data)";
1672
1674 return "QZSS L1C-P (Pilot)";
1675
1677 return "QZSS L2C";
1678
1680 return "QZSS L2C-M (Data)";
1681
1683 return "QZSS L2C-L (Pilot)";
1684
1686 return "QZSS L5";
1687
1689 return "QZSS L5-I (Data)";
1690
1692 return "QZSS L5-Q (Pilot)";
1693
1695 return "QZSS L6";
1696
1698 return "QZSS L6-M (Data)";
1699
1701 return "QZSS L6-L (Pilot)";
1702
1704 return "Unknown";
1705 }
1706 return "Invalid";
1707}

ToPrettyString()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::ToPrettyString (GPSSignalName type)

Get a human-friendly string for the specified GPSSignalName.

Parameters
type

The enum to get the string for.

Returns

The corresponding string.

Definition at line 535 of file signal_defs.h.

536 switch (type) {
538 return "C/A";
539
541 return "L1 P(Y)";
542
544 return "L1C";
545
547 return "L2C";
548
550 return "L2 P(Y)";
551
553 return "L5";
554 }
555 return "Invalid";
556}

ToPrettyString()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::ToPrettyString (QZSSSignalName type)

Get a human-friendly string for the specified QZSSSignalName.

Parameters
type

The enum to get the string for.

Returns

The corresponding string.

Definition at line 1017 of file signal_defs.h.

1018 switch (type) {
1020 return "C/A";
1021
1023 return "L1C";
1024
1026 return "L2C";
1027
1029 return "L5";
1030
1032 return "L6";
1033 }
1034 return "Invalid";
1035}

ToPrettyString()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::ToPrettyString (SatelliteType type)

Get a human-friendly string for the specified SatelliteType.

Parameters
type

The enum to get the string for.

Returns

The corresponding string.

Definition at line 206 of file signal_defs.h.

207 switch (type) {
209 return "UNKNOWN";
210
212 return "GPS";
213
215 return "GLONASS";
216
218 return "LEO";
219
221 return "Galileo";
222
224 return "BeiDou";
225
227 return "QZSS";
228
230 return "MIXED";
231
233 return "SBAS";
234
236 return "IRNSS";
237 }
238 return "Invalid";
239}

ToPrettyString()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::ToPrettyString (SBASSignalName type)

Get a human-friendly string for the specified SBASSignalName.

Parameters
type

The enum to get the string for.

Returns

The corresponding string.

Definition at line 928 of file signal_defs.h.

929 switch (type) {
931 return "C/A";
932
934 return "L5";
935 }
936 return "Invalid";
937}

ToSignalType()

template <typename SignalName>
P1_CONSTEXPR_FUNC GNSSSignalType point_one::fusion_engine::messages::ToSignalType (SatelliteType sv_type, FrequencyBand freq_band, SignalName signal_name, GNSSComponent component)

Create a GNSSSignalType from the enums that it's made up from.

Template Parameters
SignalName

The type of the SignalName (see IsSignalNameType()) that is included in this signal type.

Parameters
sv_type

The constellation of this signal.

freq_band

The frequency band of this signal.

signal_name

The type of signal for the constellation. For example, if the sv_type is SatelliteType::GPS, than this will specify which of the GPSSignalName this signal is.

component

The components of this signal.

Returns

A GNSSSignalType value made from combining the parameters.

warning

If the combination of values is not defined in GNSSSignalType, the returned value will not be valid.

Definition at line 113 of file signal_defs.h.

ToSignalVal()

template <typename SignalName>
constexpr uint16_t point_one::fusion_engine::messages::ToSignalVal (SatelliteType sv_type, FrequencyBand freq_band, SignalName signal_name, GNSSComponent component)
constexpr

Create a GNSSSignalType from the enums that it's made up from.

Template Parameters
SignalName

The type of the SignalName (see IsSignalNameType()) that is included in this signal type.

Parameters
sv_type

The constellation of this signal.

freq_band

The frequency band of this signal.

signal_name

The type of signal for the constellation. For example, if the sv_type is SatelliteType::GPS, than this will specify which of the GPSSignalName this signal is.

component

The components of this signal.

Returns

A GNSSSignalType value made from combining the parameters.

Definition at line 93 of file signal_defs.h.

96#if P1_HAVE_MULTILINE_CONSTEXPR_FUNC
97 static_assert(IsSignalNameType<SignalName>(),
98 "signal_name must be one of the *SignalName types.");
99#endif // P1_HAVE_MULTILINE_CONSTEXPR_FUNC
100 return static_cast<uint8_t>(sv_type) << SATELLITE_TYPE_SHIFT |
101 static_cast<uint8_t>(freq_band) << FREQUENCY_BAND_SHIFT |
102 static_cast<uint8_t>(signal_name) << SIGNAL_NAME_SHIFT |
103 static_cast<uint8_t>(component) << GNSS_COMPONENT_SHIFT;
104}

ToString()

const char * point_one::fusion_engine::messages::ToString (BeiDouSignalName type)
inline

Get a human-friendly string name for the specified ConfigType.

Parameters
type

The desired configuration parameter type.

Returns

The corresponding string name.

Definition at line 821 of file signal_defs.h.

821inline const char* ToString(BeiDouSignalName type) { return to_string(type); }

ToString()

const char * point_one::fusion_engine::messages::ToString (FrequencyBand type)
inline

Get a human-friendly string name for the specified ConfigType.

Parameters
type

The desired configuration parameter type.

Returns

The corresponding string name.

Definition at line 328 of file signal_defs.h.

328inline const char* ToString(FrequencyBand type) { return to_string(type); }

ToString()

const char * point_one::fusion_engine::messages::ToString (GalileoSignalName type)
inline

Get a human-friendly string name for the specified ConfigType.

Parameters
type

The desired configuration parameter type.

Returns

The corresponding string name.

Definition at line 715 of file signal_defs.h.

715inline const char* ToString(GalileoSignalName type) { return to_string(type); }

ToString()

const char * point_one::fusion_engine::messages::ToString (GLONASSSignalName type)
inline

Get a human-friendly string name for the specified ConfigType.

Parameters
type

The desired configuration parameter type.

Returns

The corresponding string name.

Definition at line 615 of file signal_defs.h.

615inline const char* ToString(GLONASSSignalName type) { return to_string(type); }

ToString()

const char * point_one::fusion_engine::messages::ToString (GNSSComponent type)
inline

Get a human-friendly string name for the specified ConfigType.

Parameters
type

The desired configuration parameter type.

Returns

The corresponding string name.

Definition at line 422 of file signal_defs.h.

422inline const char* ToString(GNSSComponent type) { return to_string(type); }

ToString()

const char * point_one::fusion_engine::messages::ToString (GNSSSignalType type)
inline

Get a human-friendly string name for the specified ConfigType.

Parameters
type

The desired configuration parameter type.

Returns

The corresponding string name.

Definition at line 1513 of file signal_defs.h.

1513inline const char* ToString(GNSSSignalType type) { return to_string(type); }

ToString()

const char * point_one::fusion_engine::messages::ToString (GPSSignalName type)
inline

Get a human-friendly string name for the specified ConfigType.

Parameters
type

The desired configuration parameter type.

Returns

The corresponding string name.

Definition at line 518 of file signal_defs.h.

518inline const char* ToString(GPSSignalName type) { return to_string(type); }

ToString()

const char * point_one::fusion_engine::messages::ToString (QZSSSignalName type)
inline

Get a human-friendly string name for the specified ConfigType.

Parameters
type

The desired configuration parameter type.

Returns

The corresponding string name.

Definition at line 1000 of file signal_defs.h.

1000inline const char* ToString(QZSSSignalName type) { return to_string(type); }

ToString()

const char * point_one::fusion_engine::messages::ToString (SatelliteType type)
inline

Get a human-friendly string name for the specified ConfigType.

Parameters
type

The desired configuration parameter type.

Returns

The corresponding string name.

Definition at line 189 of file signal_defs.h.

189inline const char* ToString(SatelliteType type) { return to_string(type); }

ToString()

const char * point_one::fusion_engine::messages::ToString (SBASSignalName type)
inline

Get a human-friendly string name for the specified ConfigType.

Parameters
type

The desired configuration parameter type.

Returns

The corresponding string name.

Definition at line 911 of file signal_defs.h.

911inline const char* ToString(SBASSignalName type) { return to_string(type); }

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.