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 class | BeiDouSignalName : uint8_t { ... } |
|
The name of a signal from a BeiDou satellite. More... | |
| enum class | FrequencyBand : uint8_t { ... } |
|
GNSS frequency band definitions. More... | |
| enum class | GalileoSignalName : uint8_t { ... } |
|
The name of a signal from a Galileo satellite. More... | |
| enum class | GLONASSSignalName : uint8_t { ... } |
|
The name of a signal from a GLONASS satellite. More... | |
| enum class | GNSSComponent : uint8_t { ... } |
|
The component being tracked for signals that have separate data and pilot components. More... | |
| enum class | GNSSSignalType : uint16_t { ... } |
|
Representation of the combination of GNSS constellation, signal type, and component being tracked (pilot/data). More... | |
| enum class | GPSSignalName : uint8_t { ... } |
|
The name of a signal from a GPS satellite. More... | |
| enum class | QZSSSignalName : uint8_t { ... } |
|
The name of a signal from a QZSS satellite. More... | |
| enum class | SatelliteType : uint8_t { ... } |
|
System/constellation type definitions. More... | |
| enum class | SBASSignalName : 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 BeiDouSignalName | GetBeiDouSignalName (GNSSSignalType signal_type) |
|
Extract the BeiDouSignalName enum value from a GNSSSignalType. More... | |
| P1_CONSTEXPR_FUNC FrequencyBand | GetFrequencyBand (GNSSSignalType signal_type) |
|
Extract the FrequencyBand enum value from a GNSSSignalType. More... | |
| P1_CONSTEXPR_FUNC GalileoSignalName | GetGalileoSignalName (GNSSSignalType signal_type) |
|
Extract the GalileoSignalName enum value from a GNSSSignalType. More... | |
| P1_CONSTEXPR_FUNC GLONASSSignalName | GetGLONASSSignalName (GNSSSignalType signal_type) |
|
Extract the GLONASSSignalName enum value from a GNSSSignalType. More... | |
| P1_CONSTEXPR_FUNC GNSSComponent | GetGNSSComponent (GNSSSignalType signal_type) |
|
Extract the GNSSComponent enum value from a GNSSSignalType. More... | |
| P1_CONSTEXPR_FUNC GPSSignalName | GetGPSSignalName (GNSSSignalType signal_type) |
|
Extract the GPSSignalName enum value from a GNSSSignalType. More... | |
| P1_CONSTEXPR_FUNC QZSSSignalName | GetQZSSSignalName (GNSSSignalType signal_type) |
|
Extract the QZSSSignalName enum value from a GNSSSignalType. More... | |
| P1_CONSTEXPR_FUNC SatelliteType | GetSatelliteType (GNSSSignalType signal_type) |
|
Extract the SatelliteType enum value from a GNSSSignalType. More... | |
| P1_CONSTEXPR_FUNC SBASSignalName | GetSBASSignalName (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 GNSSSignalType | ToSignalType (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_t | ToSignalVal (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
| strong |
The name of a signal from a BeiDou satellite.
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.
FrequencyBand
| 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.
GalileoSignalName
| strong |
The name of a signal from a Galileo satellite.
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.
GLONASSSignalName
| strong |
The name of a signal from a GLONASS satellite.
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.
GNSSComponent
| strong |
The component being tracked for signals that have separate data and pilot components.
This needs to be packed into 2 bits so no values above 3 are allowed.
Definition at line 392 of file signal_defs.h.
GNSSSignalType
| strong |
Representation of the combination of GNSS constellation, signal type, and component being tracked (pilot/data).
- Enumeration values
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.
GPSSignalName
| strong |
The name of a signal from a GPS satellite.
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.
QZSSSignalName
| strong |
The name of a signal from a QZSS satellite.
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.
SatelliteType
| 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.
SBASSignalName
| strong |
The name of a signal from a SBAS satellite.
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.
Operators
operator<<()
| inline |
BeiDouSignalName stream operator.
Definition at line 826 of file signal_defs.h.
operator<<()
| inline |
FrequencyBand stream operator.
Definition at line 333 of file signal_defs.h.
operator<<()
| inline |
GalileoSignalName stream operator.
Definition at line 720 of file signal_defs.h.
operator<<()
| inline |
GLONASSSignalName stream operator.
Definition at line 620 of file signal_defs.h.
operator<<()
| inline |
GNSSComponent stream operator.
Definition at line 427 of file signal_defs.h.
operator<<()
| inline |
GNSSSignalType stream operator.
Definition at line 1518 of file signal_defs.h.
operator<<()
| inline |
GPSSignalName stream operator.
Definition at line 523 of file signal_defs.h.
operator<<()
| inline |
QZSSSignalName stream operator.
Definition at line 1005 of file signal_defs.h.
operator<<()
| inline |
SatelliteType stream operator.
Definition at line 194 of file signal_defs.h.
operator<<()
| inline |
SBASSignalName stream operator.
Definition at line 916 of file signal_defs.h.
Functions
GetBeiDouSignalName()
|
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.
GetFrequencyBand()
|
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.
GetGalileoSignalName()
|
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.
GetGLONASSSignalName()
|
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.
GetGNSSComponent()
|
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.
GetGPSSignalName()
|
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.
GetQZSSSignalName()
|
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.
GetSatelliteType()
|
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.
GetSBASSignalName()
|
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.
to_string()
|
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.
to_string()
|
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.
to_string()
|
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.
to_string()
|
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.
to_string()
|
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.
to_string()
|
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.
to_string()
|
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.
to_string()
|
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.
to_string()
|
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.
to_string()
|
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.
ToPrettyString()
|
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.
ToPrettyString()
|
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.
ToPrettyString()
|
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.
ToPrettyString()
|
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.
ToPrettyString()
|
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.
ToPrettyString()
|
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.
ToPrettyString()
|
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.
ToPrettyString()
|
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.
ToPrettyString()
|
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.
ToPrettyString()
|
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.
ToSignalType()
|
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.
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()
| 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.
ToString()
| 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.
ToString()
| 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.
ToString()
| 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.
ToString()
| 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.
ToString()
| 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.
ToString()
| 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.
ToString()
| 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.
ToString()
| 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.
ToString()
| 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.
ToString()
| 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.
Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.