sbgEComLogGnssVel.h

Go to the documentation of this file.

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

typedef enum _SbgEComGnssVelStatus
{
    SBG_ECOM_GNSS_VEL_STATUS_SOL_COMPUTED      = 0,                            
    SBG_ECOM_GNSS_VEL_STATUS_INSUFFICIENT_OBS  = 1,                            
    SBG_ECOM_GNSS_VEL_STATUS_INTERNAL_ERROR      = 2,                            
    SBG_ECOM_GNSS_VEL_STATUS_LIMIT                = 3                             
} SbgEComGnssVelStatus;

typedef enum _SbgEComGnssVelType
{
    SBG_ECOM_GNSS_VEL_TYPE_NO_SOLUTION            = 0,                            
    SBG_ECOM_GNSS_VEL_TYPE_UNKNOWN                = 1,                            
    SBG_ECOM_GNSS_VEL_TYPE_DOPPLER                = 2,                            
    SBG_ECOM_GNSS_VEL_TYPE_DIFFERENTIAL          = 3                             
} SbgEComGnssVelType;
 
//----------------------------------------------------------------------//
//- Log structure definitions                                          -//
//----------------------------------------------------------------------//

typedef struct _SbgEComLogGnssVel
{
    uint32_t        timeStamp;             
    uint32_t        status;                   
    uint32_t        timeOfWeek;               
    float           velocity[3];            
    float           velocityAcc[3];          
    float           course;                   
    float           courseAcc;             
} SbgEComLogGnssVel;
 
//----------------------------------------------------------------------//
//- Public methods                                                     -//
//----------------------------------------------------------------------//

void sbgEComLogGnssVelZeroInit(SbgEComLogGnssVel *pLogData);

SbgErrorCode sbgEComLogGnssVelReadFromStream(SbgEComLogGnssVel *pLogData, SbgStreamBuffer *pStreamBuffer);

SbgErrorCode sbgEComLogGnssVelWriteToStream(const SbgEComLogGnssVel *pLogData, SbgStreamBuffer *pStreamBuffer);
 
//----------------------------------------------------------------------//
//- Public setters/getters                                             -//
//----------------------------------------------------------------------//

void sbgEComLogGnssVelSetStatus(SbgEComLogGnssVel *pLogData, SbgEComGnssVelStatus status);

SbgEComGnssVelStatus sbgEComLogGnssVelGetStatus(const SbgEComLogGnssVel *pLogData);

void sbgEComLogGnssVelSetType(SbgEComLogGnssVel *pLogData, SbgEComGnssVelType posType);

SbgEComGnssVelType sbgEComLogGnssVelGetType(const SbgEComLogGnssVel *pLogData);

bool sbgEComLogGnssVelDownVelocityIsValid(const SbgEComLogGnssVel *pLogData);
 
//----------------------------------------------------------------------//
//- DEPRECATED - Used for backward compatibility                       -//
//----------------------------------------------------------------------//
 
#ifdef SBG_ECOM_USE_DEPRECATED_MACROS
    #define SBG_ECOM_VEL_SOL_COMPUTED           (SBG_ECOM_GNSS_VEL_STATUS_SOL_COMPUTED)
    #define SBG_ECOM_VEL_INSUFFICIENT_OBS       (SBG_ECOM_GNSS_VEL_STATUS_INSUFFICIENT_OBS)
    #define SBG_ECOM_VEL_INTERNAL_ERROR         (SBG_ECOM_GNSS_VEL_STATUS_INTERNAL_ERROR)
    #define SBG_ECOM_VEL_LIMIT                  (SBG_ECOM_GNSS_VEL_STATUS_LIMIT)
        
    #define SBG_ECOM_VEL_NO_SOLUTION            (SBG_ECOM_GNSS_VEL_TYPE_NO_SOLUTION)
    #define SBG_ECOM_VEL_UNKNOWN_TYPE           (SBG_ECOM_GNSS_VEL_TYPE_UNKNOWN)
    #define SBG_ECOM_VEL_DOPPLER                (SBG_ECOM_GNSS_VEL_TYPE_DOPPLER)
    #define SBG_ECOM_VEL_DIFFERENTIAL           (SBG_ECOM_GNSS_VEL_TYPE_DIFFERENTIAL)
#endif
 
SBG_DEPRECATED_TYPEDEF(typedef enum _SbgEComGnssVelStatus    SbgEComGpsVelStatus);
SBG_DEPRECATED_TYPEDEF(typedef enum _SbgEComGnssVelType        SbgEComGpsVelType);
SBG_DEPRECATED_TYPEDEF(typedef struct _SbgEComLogGnssVel    SbgLogGpsVel);
 
SBG_DEPRECATED(uint32_t sbgEComLogGpsVelBuildStatus(SbgEComGnssVelStatus status, SbgEComGnssVelType type));
SBG_DEPRECATED(SbgEComGnssVelStatus sbgEComLogGpsVelGetStatus(uint32_t status));
SBG_DEPRECATED(SbgEComGnssVelType sbgEComLogGpsVelGetType(uint32_t status));
 
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogParseGpsVelData(SbgStreamBuffer *pStreamBuffer, SbgEComLogGnssVel *pLogData));
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogWriteGpsVelData(SbgStreamBuffer *pStreamBuffer, const SbgEComLogGnssVel *pLogData));
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_LOG_GNSS_VEL_H