sbgEComLogGnssHdt.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_LOG_GNSS_HDT_H
#define SBG_ECOM_LOG_GNSS_HDT_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Public definitions                                                 -//
//----------------------------------------------------------------------//

typedef enum _SbgEComGnssHdtStatus
{
    SBG_ECOM_GNSS_HDT_STATUS_SOL_COMPUTED      = 0,                            
    SBG_ECOM_GNSS_HDT_STATUS_INSUFFICIENT_OBS  = 1,                            
    SBG_ECOM_GNSS_HDT_STATUS_INTERNAL_ERROR      = 2,                            
    SBG_ECOM_GNSS_HDT_STATUS_HEIGHT_LIMIT      = 3                             
} SbgEComGnssHdtStatus;
 
//----------------------------------------------------------------------//
//- Log structure definitions                                          -//
//----------------------------------------------------------------------//

typedef struct _SbgEComLogGnssHdt
{
    uint32_t        timeStamp;             
    uint16_t        status;                   
    uint32_t        timeOfWeek;               
    float           heading;             
    float           headingAccuracy;     
    float           pitch;                 
    float           pitchAccuracy;         
    float           baseline;               
    uint8_t         numSvTracked;           
    uint8_t         numSvUsed;             
} SbgEComLogGnssHdt;
 
//----------------------------------------------------------------------//
//- Public methods                                                     -//
//----------------------------------------------------------------------//

void sbgEComLogGnssHdtZeroInit(SbgEComLogGnssHdt *pLogData);

SbgErrorCode sbgEComLogGnssHdtReadFromStream(SbgEComLogGnssHdt *pLogData, SbgStreamBuffer *pStreamBuffer);

SbgErrorCode sbgEComLogGnssHdtWriteToStream(const SbgEComLogGnssHdt *pLogData, SbgStreamBuffer *pStreamBuffer);
 
//----------------------------------------------------------------------//
//- Public setters/getters                                             -//
//----------------------------------------------------------------------//

void sbgEComLogGnssHdtSetStatus(SbgEComLogGnssHdt *pLogData, SbgEComGnssHdtStatus status);

SbgEComGnssHdtStatus sbgEComLogGnssHdtGetStatus(const SbgEComLogGnssHdt *pLogData);

bool sbgEComLogGnssHdtHeadingIsValid(const SbgEComLogGnssHdt *pLogData);

bool sbgEComLogGnssHdtPitchIsValid(const SbgEComLogGnssHdt *pLogData);

void sbgEComLogGnssHdtSetBaseLineValid(SbgEComLogGnssHdt *pLogData, bool isValid);

bool sbgEComLogGnssHdtBaseLineIsValid(const SbgEComLogGnssHdt *pLogData);

bool sbgEComLogGnssHdtNumSvTrackedIsValid(const SbgEComLogGnssHdt *pLogData);

bool sbgEComLogGnssHdtNumSvUsedIsValid(const SbgEComLogGnssHdt *pLogData);
 
//----------------------------------------------------------------------//
//- DEPRECATED - Used for backward compatibility                       -//
//----------------------------------------------------------------------//
 
#ifdef SBG_ECOM_USE_DEPRECATED_MACROS
    #define SBG_ECOM_GPS_HDT_BASELINE_VALID (0x0001 << 6)
 
    #define SBG_ECOM_HDT_SOL_COMPUTED           (SBG_ECOM_GNSS_HDT_STATUS_SOL_COMPUTED)
    #define SBG_ECOM_HDT_INSUFFICIENT_OBS       (SBG_ECOM_GNSS_HDT_STATUS_INSUFFICIENT_OBS)
    #define SBG_ECOM_HDT_INTERNAL_ERROR         (SBG_ECOM_GNSS_HDT_STATUS_INTERNAL_ERROR)
    #define SBG_ECOM_HDT_HEIGHT_LIMIT           (SBG_ECOM_GNSS_HDT_STATUS_HEIGHT_LIMIT)
#endif
 
SBG_DEPRECATED_TYPEDEF(typedef enum _SbgEComGnssHdtStatus    SbgEComGpsHdtStatus);
SBG_DEPRECATED_TYPEDEF(typedef struct _SbgEComLogGnssHdt    SbgLogGpsHdt);
 
SBG_DEPRECATED(uint32_t sbgEComLogGpsHdtBuildStatus(SbgEComGnssHdtStatus status, uint32_t masks));
SBG_DEPRECATED(SbgEComGnssHdtStatus sbgEComLogGpsHdtGetStatus(uint32_t status));
 
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogParseGpsHdtData(SbgStreamBuffer *pStreamBuffer, SbgEComLogGnssHdt *pLogData));
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogWriteGpsHdtData(SbgStreamBuffer *pStreamBuffer, const SbgEComLogGnssHdt *pLogData));
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_LOG_GNSS_HDT_H