SSRStatusMessage Struct
State-space representation (SSR) GNSS corrections status (MessageType::SSR_STATUS, version 1.3). More...
Declaration
Included Headers
Base struct
| struct | MessagePayload |
|
The base class for all message payloads. More... | |
Public Member Attributes Index
| int64_t | system_time_ns = 0 |
|
The current system timestamp (in ns). More... | |
Public Static Attributes Index
| static constexpr uint8_t | INVALID_GRID_ID = 0xFF |
| static constexpr uint16_t | INVALID_SSR_PROVIDER_ID = 0xFFFF |
| static constexpr uint16_t | INVALID_SSR_STREAM_ID = 0xFFFF |
| static constexpr uint16_t | INVALID_STATION_ID = 0xFFFF |
| static constexpr uint32_t | INVALID_TOW_MS = 0xFFFFFFFF |
| static constexpr uint16_t | INVALID_WEEK_NUMBER = 0xFFFF |
| static constexpr MessageType | MESSAGE_TYPE = MessageType::SSR_STATUS |
| static constexpr uint8_t | MESSAGE_VERSION = 3 |
Operating Status Index
| uint16_t | current_week_number = INVALID_WEEK_NUMBER |
|
The current GPS week number according to the time source currently in use (user, GNSS receiver, or time from OSR or SSR data stream). More... | |
| uint32_t | current_tow_ms = INVALID_TOW_MS |
|
The current GPS time of week (in milliseconds) according to the time source currently in use (user, GNSS receiver, or time from OSR or SSR data stream). More... | |
RTCM Output Status Index
| Timestamp | output_gps_time |
|
The GPS time corresponding with the most recently output corrections data. More... | |
| RTKOutputSource | output_source = RTKOutputSource::NONE |
|
The source of the most recent output RTCM corrections data. More... | |
| uint16_t | output_station_id = INVALID_STATION_ID |
|
The RTCM base station ID contained in the most recent corrections data. More... | |
| double | base_latitude_deg = NAN |
|
The base station longitude (in degrees). More... | |
| double | base_longitude_deg = NAN |
|
The base station latitude (in degrees). More... | |
| double | base_altitude_m = NAN |
|
The base station altitude (in meters). More... | |
| uint8_t | num_satellites = 0 |
|
The number of satellites present in the most recent corrections data. More... | |
| uint8_t | num_signals = 0 |
|
The number of GNSS signals present in the most recent corrections data. More... | |
| uint16_t | gnss_systems_mask = 0x0 |
|
A bitmask indicating which GNSS constellations are present in the generated corrections data. More... | |
| uint16_t | gps_signal_types_mask = 0x0 |
|
A bitmask indicating which GPS signal types are present in the generated corrections data. More... | |
| uint16_t | glo_signal_types_mask = 0x0 |
|
A bitmask indicating which GLONASS signal types are present in the generated corrections data. More... | |
| uint16_t | gal_signal_types_mask = 0x0 |
|
A bitmask indicating which Galileo signal types are present in the generated corrections data. More... | |
| uint16_t | bds_signal_types_mask = 0x0 |
|
A bitmask indicating which BeiDou signal types are present in the generated corrections data. More... | |
Satellite Ephemeris Status Index
| uint8_t | num_gps_ephemeris = 0 |
|
The number of GPS satellites for which ephemeris data is available (may include satellites that are not currently visible). More... | |
| uint8_t | num_glo_ephemeris = 0 |
|
The number of GLONASS satellites for which ephemeris data is available (may include satellites that are not currently visible). More... | |
| uint8_t | num_gal_ephemeris = 0 |
|
The number of Galileo satellites for which ephemeris data is available (may include satellites that are not currently visible). More... | |
| uint8_t | num_bds_ephemeris = 0 |
|
The number of BeiDou satellites for which ephemeris data is available (may include satellites that are not currently visible). More... | |
Incoming OSR Base Station Data Status Index
| uint16_t | osr_data_status = 0x0 |
|
A bitmask indicating the status of incoming OSR corrections data from an external base station RTCM data stream. More... | |
Incoming SSR Model Data Status Index
| uint16_t | ssr_data_status = 0x0 |
|
A bitmask indicating the status of incoming SSR corrections data. More... | |
| uint8_t | ssr_grid_id = INVALID_GRID_ID |
|
The identifier of the local SSR corrections grid currently in use. More... | |
| uint16_t | ssr_model_provider_id = INVALID_SSR_PROVIDER_ID |
|
The provider ID for the SSR data currently in use. More... | |
| uint16_t | ssr_model_stream_id = INVALID_SSR_STREAM_ID |
|
The stream ID for the SSR data currently in use. More... | |
| uint16_t | ssr_decode_provider_id = INVALID_SSR_PROVIDER_ID |
|
The provider ID for the SSR data actively being decoded. More... | |
| uint16_t | ssr_decode_stream_id = INVALID_SSR_STREAM_ID |
|
The stream ID for the SSR data actively being decoded. More... | |
| uint16_t | ssr_enabled_component_mask = 0x0 |
|
A bitmask indicating which SSR model components are enabled for the current corrections region. More... | |
| uint16_t | ssr_model_status_mask = 0x0 |
|
A bitmask indicating the status of the individual SSR component models (0 = model data not available/expired, 1 = model data usable). More... | |
| uint16_t | ssr_decode_status_mask = 0x0 |
|
A bitmask indicating the decoding status of the incoming SSR data messages (0 = waiting for data, 1 = decoded data received). More... | |
Incoming Data Interface Status Index
| uint32_t | ssr_primary_message_count = 0 |
|
The number of messages successfully decoded from the primary SSR data interface. More... | |
| uint32_t | ssr_primary_crc_fail_count = 0 |
|
The number of CRC failures detected on the primary SSR interface. More... | |
Description
State-space representation (SSR) GNSS corrections status (MessageType::SSR_STATUS, version 1.3).
Definition at line 115 of file gnss_corrections.h.
Public Member Attributes
system_time_ns
|
The current system timestamp (in ns).
Definition at line 129 of file gnss_corrections.h.
Public Static Attributes
INVALID_GRID_ID
| constexpr static |
Definition at line 126 of file gnss_corrections.h.
INVALID_SSR_PROVIDER_ID
| constexpr static |
Definition at line 122 of file gnss_corrections.h.
INVALID_SSR_STREAM_ID
| constexpr static |
Definition at line 123 of file gnss_corrections.h.
INVALID_STATION_ID
| constexpr static |
Definition at line 125 of file gnss_corrections.h.
INVALID_TOW_MS
| constexpr static |
Definition at line 120 of file gnss_corrections.h.
INVALID_WEEK_NUMBER
| constexpr static |
Definition at line 119 of file gnss_corrections.h.
MESSAGE_TYPE
| constexpr static |
Definition at line 116 of file gnss_corrections.h.
MESSAGE_VERSION
| constexpr static |
Definition at line 117 of file gnss_corrections.h.
Operating Status
current_tow_ms
|
The current GPS time of week (in milliseconds) according to the time source currently in use (user, GNSS receiver, or time from OSR or SSR data stream).
Definition at line 148 of file gnss_corrections.h.
current_week_number
|
The current GPS week number according to the time source currently in use (user, GNSS receiver, or time from OSR or SSR data stream).
Definition at line 142 of file gnss_corrections.h.
RTCM Output Status
base_altitude_m
|
The base station altitude (in meters).
Definition at line 176 of file gnss_corrections.h.
base_latitude_deg
|
The base station longitude (in degrees).
Definition at line 172 of file gnss_corrections.h.
base_longitude_deg
|
The base station latitude (in degrees).
Definition at line 174 of file gnss_corrections.h.
bds_signal_types_mask
|
A bitmask indicating which BeiDou signal types are present in the generated corrections data.
Each bit in the mask corresponds with a BeiDouSignalName enum value.
Definition at line 216 of file gnss_corrections.h.
gal_signal_types_mask
|
A bitmask indicating which Galileo signal types are present in the generated corrections data.
Each bit in the mask corresponds with a GalileoSignalName enum value.
Definition at line 209 of file gnss_corrections.h.
glo_signal_types_mask
|
A bitmask indicating which GLONASS signal types are present in the generated corrections data.
Each bit in the mask corresponds with a GLONASSSignalName enum value.
Definition at line 202 of file gnss_corrections.h.
gnss_systems_mask
|
A bitmask indicating which GNSS constellations are present in the generated corrections data.
Each bit in the mask corresponds with a SatelliteType enum value.
Definition at line 188 of file gnss_corrections.h.
gps_signal_types_mask
|
A bitmask indicating which GPS signal types are present in the generated corrections data.
Each bit in the mask corresponds with a GPSSignalName enum value.
Definition at line 195 of file gnss_corrections.h.
num_satellites
|
The number of satellites present in the most recent corrections data.
Definition at line 179 of file gnss_corrections.h.
num_signals
|
The number of GNSS signals present in the most recent corrections data.
Definition at line 181 of file gnss_corrections.h.
output_gps_time
|
The GPS time corresponding with the most recently output corrections data.
Definition at line 160 of file gnss_corrections.h.
output_source
|
The source of the most recent output RTCM corrections data.
Definition at line 164 of file gnss_corrections.h.
output_station_id
|
The RTCM base station ID contained in the most recent corrections data.
Definition at line 169 of file gnss_corrections.h.
Satellite Ephemeris Status
num_bds_ephemeris
|
The number of BeiDou satellites for which ephemeris data is available (may include satellites that are not currently visible).
Definition at line 246 of file gnss_corrections.h.
num_gal_ephemeris
|
The number of Galileo satellites for which ephemeris data is available (may include satellites that are not currently visible).
Definition at line 241 of file gnss_corrections.h.
num_glo_ephemeris
|
The number of GLONASS satellites for which ephemeris data is available (may include satellites that are not currently visible).
Definition at line 236 of file gnss_corrections.h.
num_gps_ephemeris
|
The number of GPS satellites for which ephemeris data is available (may include satellites that are not currently visible).
Definition at line 231 of file gnss_corrections.h.
Incoming OSR Base Station Data Status
osr_data_status
|
A bitmask indicating the status of incoming OSR corrections data from an external base station RTCM data stream.
| Bit | Description |
|---|---|
| 0 | (Real) OSR corrections data available |
| 1-15 | Reserved for future use |
Definition at line 266 of file gnss_corrections.h.
Incoming SSR Model Data Status
ssr_data_status
|
A bitmask indicating the status of incoming SSR corrections data.
| Bit | Description |
|---|---|
| 0 | SSR model data ready for OSR generation |
| 1-15 | Reserved for future use |
Definition at line 285 of file gnss_corrections.h.
ssr_decode_provider_id
|
The provider ID for the SSR data actively being decoded.
Definition at line 300 of file gnss_corrections.h.
ssr_decode_status_mask
|
A bitmask indicating the decoding status of the incoming SSR data messages (0 = waiting for data, 1 = decoded data received).
Generating OSR measurements requires a complete set of SSR model data from a consistent time epoch. SSR data will be made available to the SSR models after a complete data set arrives. This bitmask indicates the status of the individual incoming data messages as they arrive and get decoded.
When the first SSR message of new time epoch arrives, the decode status for the other SSR models in this bitmask may be cleared. They will be set again as their data messages arrive for the new epoch. In the meantime, the SSR models will continue to produce synthetic OSR measurements using model data from the previous time epoch until either the new epoch is completed or the previous data expires. ssr_model_status_mask indicates the status of the data in use by the SSR models.
See ssr_enabled_component_mask for bit definitions.
Definition at line 363 of file gnss_corrections.h.
ssr_decode_stream_id
|
The stream ID for the SSR data actively being decoded.
Definition at line 302 of file gnss_corrections.h.
ssr_enabled_component_mask
|
A bitmask indicating which SSR model components are enabled for the current corrections region.
The following table describes the bit definitions used by this mask, and by the component status masks in this structure (ssr_decode_status_mask, ssr_model_status_mask).
| Bit | Description |
|---|---|
| 0 | SSR network metadata |
| 1 | Grid definition |
| 2 | Satellite group definition |
| 3 | Geoid model data |
| 4 | Antenna corrections data (ATX) |
| 5 | High-rate satellite corrections data |
| 6 | Low-rate satellite corrections data |
| 7 | Global per-satellite ionosphere (GSI) data |
| 8 | Gridded per-satellite ionosphere (GRI) data |
| 9 | Gridded troposphere (GRT) data |
| 10 | Regional per-satellite ionosphere (RSI) data |
| 11 | Global vertical ionosphere delay (GVI) data |
| 12 | Regional troposphere (RT) data |
| 13-15 | Reserved for future use |
Definition at line 329 of file gnss_corrections.h.
ssr_grid_id
|
The identifier of the local SSR corrections grid currently in use.
Definition at line 292 of file gnss_corrections.h.
ssr_model_provider_id
|
The provider ID for the SSR data currently in use.
Definition at line 295 of file gnss_corrections.h.
ssr_model_status_mask
|
A bitmask indicating the status of the individual SSR component models (0 = model data not available/expired, 1 = model data usable).
See ssr_enabled_component_mask for bit definitions. Synthetic OSR generation is ready when the bits for all models indicated by ssr_enabled_component_mask are set in this mask.
See also ssr_decode_status_mask.
Definition at line 341 of file gnss_corrections.h.
ssr_model_stream_id
|
The stream ID for the SSR data currently in use.
Definition at line 297 of file gnss_corrections.h.
Incoming Data Interface Status
ssr_primary_crc_fail_count
|
The number of CRC failures detected on the primary SSR interface.
The sum of ssr_primary_message_count and ssr_primary_crc_fail_count is an approximation of the total number of SSR messages received on the interface:
- If the data preamble appears in the middle of the data stream, it is possible to count a "failure" for a message that was not present
- If the interface contains both SSR data and other binary interleaved, CRC failures may occur whenever non-SSR data is received if the SSR preamble is present in the non-SSR data
Definition at line 392 of file gnss_corrections.h.
ssr_primary_message_count
|
The number of messages successfully decoded from the primary SSR data interface.
Definition at line 378 of file gnss_corrections.h.
The documentation for this struct was generated from the following file:
Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.