sbgECom Library
5.2.590-stable
Interface SBG Systems IMU/AHRS/INS
|
GNSS position related logs. More...
Go to the source code of this file.
Data Structures | |
struct | _SbgEComLogGnssPos |
Typedefs | |
typedef enum _SbgEComGnssPosStatus | SbgEComGnssPosStatus |
typedef enum _SbgEComGnssPosType | SbgEComGnssPosType |
typedef enum _SbgEComGnssIfmStatus | SbgEComGnssIfmStatus |
typedef enum _SbgEComGnssSpoofingStatus | SbgEComGnssSpoofingStatus |
typedef enum _SbgEComGnssOsnmaStatus | SbgEComGnssOsnmaStatus |
typedef struct _SbgEComLogGnssPos | SbgEComLogGnssPos |
GNSS position related logs.
The MIT license
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#define SBG_ECOM_GNSS_POS_GPS_L1_USED (0x00000001u << 12) |
GNSS signals definitions Set to 1 if GPS L1CA/L1P is used in solution.
#define SBG_ECOM_GNSS_POS_GPS_L2_USED (0x00000001u << 13) |
Set to 1 if GPS L2P/L2C is used in solution.
#define SBG_ECOM_GNSS_POS_GPS_L5_USED (0x00000001u << 14) |
Set to 1 if GPS L5 is used in solution.
#define SBG_ECOM_GNSS_POS_GLO_L1_USED (0x00000001u << 15) |
Set to 1 if GLONASS L1CA is used in solution.
#define SBG_ECOM_GNSS_POS_GLO_L2_USED (0x00000001u << 16) |
Set to 1 if GLONASS L2C/L2P is used in solution.
#define SBG_ECOM_GNSS_POS_GLO_L3_USED (0x00000001u << 17) |
Set to 1 if GLONASS L3 is used in solution.
#define SBG_ECOM_GNSS_POS_GAL_E1_USED (0x00000001u << 18) |
Set to 1 if Galileo E1 is used in solution.
#define SBG_ECOM_GNSS_POS_GAL_E5A_USED (0x00000001u << 19) |
Set to 1 if Galileo E5a is used in solution.
#define SBG_ECOM_GNSS_POS_GAL_E5B_USED (0x00000001u << 20) |
Set to 1 if Galileo E5b is used in solution.
#define SBG_ECOM_GNSS_POS_GAL_E5ALT_USED (0x00000001u << 21) |
Set to 1 if Galileo E5 AltBoc is used in solution.
#define SBG_ECOM_GNSS_POS_GAL_E6_USED (0x00000001u << 22) |
Set to 1 if Galileo E6 is used in solution.
#define SBG_ECOM_GNSS_POS_BDS_B1_USED (0x00000001u << 23) |
Set to 1 if BeiDou B1 is used in solution.
#define SBG_ECOM_GNSS_POS_BDS_B2_USED (0x00000001u << 24) |
Set to 1 if BeiDou B2 is used in solution.
#define SBG_ECOM_GNSS_POS_BDS_B3_USED (0x00000001u << 25) |
Set to 1 if BeiDou B3 is used in solution.
#define SBG_ECOM_GNSS_POS_QZSS_L1_USED (0x00000001u << 26) |
Set to 1 if QZSS L1CA is used in solution.
#define SBG_ECOM_GNSS_POS_QZSS_L2_USED (0x00000001u << 27) |
Set to 1 if QZSS L2C is used in solution.
#define SBG_ECOM_GNSS_POS_QZSS_L5_USED (0x00000001u << 28) |
Set to 1 if QZSS L5 is used in solution.
#define SBG_ECOM_GNSS_POS_QZSS_L6_USED (0x00000001u << 29) |
Set to 1 if QZSS L6 is used in solution.
typedef enum _SbgEComGnssPosStatus SbgEComGnssPosStatus |
GNSS position status definitions.
typedef enum _SbgEComGnssPosType SbgEComGnssPosType |
GNSS position types definitions.
typedef enum _SbgEComGnssIfmStatus SbgEComGnssIfmStatus |
GNSS interference monitoring and mitigation indicator.
typedef enum _SbgEComGnssSpoofingStatus SbgEComGnssSpoofingStatus |
GNSS spoofing monitoring and mitigation indicator.
typedef enum _SbgEComGnssOsnmaStatus SbgEComGnssOsnmaStatus |
GNSS Galileo OSNMA Status.
typedef struct _SbgEComLogGnssPos SbgEComLogGnssPos |
Structure that stores data for the SBG_ECOM_LOG_GPS#_POS message.
GNSS position status definitions.
enum _SbgEComGnssPosType |
GNSS position types definitions.
GNSS interference monitoring and mitigation indicator.
GNSS spoofing monitoring and mitigation indicator.
GNSS Galileo OSNMA Status.
void sbgEComLogGnssPosZeroInit | ( | SbgEComLogGnssPos * | pLogData | ) |
Zero initialize the message struct.
[out] | pLogData | Structure instance to zero init. |
SbgErrorCode sbgEComLogGnssPosReadFromStream | ( | SbgEComLogGnssPos * | pLogData, |
SbgStreamBuffer * | pStreamBuffer ) |
Parse data for the SBG_ECOM_LOG_GPS#_POS message and fill the corresponding structure.
[out] | pLogData | Log structure instance to fill. |
[in] | pStreamBuffer | Input stream buffer to read the log from. |
SbgErrorCode sbgEComLogGnssPosWriteToStream | ( | const SbgEComLogGnssPos * | pLogData, |
SbgStreamBuffer * | pStreamBuffer ) |
Write data for the SBG_ECOM_LOG_GPS#_POS message to the output stream buffer from the provided structure.
[in] | pLogData | Log structure instance to write. |
[out] | pStreamBuffer | Output stream buffer to write the log to. |
void sbgEComLogGnssPosSetStatus | ( | SbgEComLogGnssPos * | pLogData, |
SbgEComGnssPosStatus | status ) |
Set the GNSS position solution status.
[in] | pLogData | Log instance. |
[in] | status | The solution status to set. |
SbgEComGnssPosStatus sbgEComLogGnssPosGetStatus | ( | const SbgEComLogGnssPos * | pLogData | ) |
Returns the GNSS position solution status.
Note: Method doesn't follow standard naming conventions because of legacy sbgEComLogGnssPosGetStatus method.
[in] | pLogData | Log instance. |
void sbgEComLogGnssPosSetType | ( | SbgEComLogGnssPos * | pLogData, |
SbgEComGnssPosType | posType ) |
Set the GNSS position solution type.
[in] | pLogData | Log instance. |
[in] | posType | The solution type to set. |
SbgEComGnssPosType sbgEComLogGnssPosGetType | ( | const SbgEComLogGnssPos * | pLogData | ) |
Returns the GNSS position solution type.
Note: Method doesn't follow standard naming conventions because of legacy sbgEComLogGnssPosGetStatus method.
[in] | pLogData | Log instance. |
void sbgEComLogGnssPosSetSignalsUsed | ( | SbgEComLogGnssPos * | pLogData, |
uint32_t | signalMask ) |
Set the GNSS signals used in solution bitmask.
[in] | pLogData | Log instance. |
[in] | signalMask | Bitmak of signals used in solution to set. |
bool sbgEComLogGnssPosSignalsAreUsed | ( | const SbgEComLogGnssPos * | pLogData, |
uint32_t | signalsMask ) |
Returns true if the signal(s) are used in the solution.
Only returns true if all signals set in signalsMask are used in solution.
[in] | pLogData | Log instance. |
[in] | signalsMask | Bitmask of signals to check if there are used in solution. |
bool sbgEComLogGnssPosNumSvTrackedIsValid | ( | const SbgEComLogGnssPos * | pLogData | ) |
Returns true if the numSvTracked field is valid.
[in] | pLogData | Log instance. |
bool sbgEComLogGnssPosNumSvUsedIsValid | ( | const SbgEComLogGnssPos * | pLogData | ) |
Returns true if the numSvUsed field is valid.
[in] | pLogData | Log instance. |
bool sbgEComLogGnssPosBaseStationIdIsValid | ( | const SbgEComLogGnssPos * | pLogData | ) |
Returns true if the baseStationId field is valid.
[in] | pLogData | Log instance. |
bool sbgEComLogGnssPosDifferentialAgeIsValid | ( | const SbgEComLogGnssPos * | pLogData | ) |
Returns true if the differentialAge field is valid.
[in] | pLogData | Log instance. |
void sbgEComLogGnssPosSetDifferentialAge | ( | SbgEComLogGnssPos * | pLogData, |
float | differentialAge ) |
Set the differential correction age in seconds.
If differential correction age is greater than 655.340 seconds or NaN the field is set to invalid/not available.
[in] | pLogData | Log instance. |
[in] | differentialAge | Differential correction age in seconds (>= 0). |
float sbgEComLogGnssPosGetDifferentialAge | ( | const SbgEComLogGnssPos * | pLogData | ) |
Returns the differential correction age in seconds.
If there is no valid differential age, returns NaN.
[in] | pLogData | Log instance. |
void sbgEComLogGnssPosSetIfmStatus | ( | SbgEComLogGnssPos * | pLogData, |
SbgEComGnssIfmStatus | status ) |
Set the GNSS interference monitoring and mitigation status.
[in] | pLogData | Log instance. |
[in] | status | The status to set. |
SbgEComGnssIfmStatus sbgEComLogGnssPosGetIfmStatus | ( | const SbgEComLogGnssPos * | pLogData | ) |
Returns the GNSS position solution status.
[in] | pLogData | Log instance. |
void sbgEComLogGnssPosSetSpoofingStatus | ( | SbgEComLogGnssPos * | pLogData, |
SbgEComGnssSpoofingStatus | status ) |
Set the GNSS spoofing status.
[in] | pLogData | Log instance. |
[in] | status | The status to set. |
SbgEComGnssSpoofingStatus sbgEComLogGnssPosGetSpoofingStatus | ( | const SbgEComLogGnssPos * | pLogData | ) |
Returns the GNSS spoofing status.
[in] | pLogData | Log instance. |
void sbgEComLogGnssPosSetOsnmaStatus | ( | SbgEComLogGnssPos * | pLogData, |
SbgEComGnssOsnmaStatus | status ) |
Set the GNSS Galileo OSNMA status.
[in] | pLogData | Log instance. |
[in] | status | The status to set. |
SbgEComGnssOsnmaStatus sbgEComLogGnssPosGetOsnmaStatus | ( | const SbgEComLogGnssPos * | pLogData | ) |
Returns the GNSS Galileo OSNMA status.
[in] | pLogData | Log instance. |