sbgEComLogUtc.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_LOG_UTC_H
#define SBG_ECOM_LOG_UTC_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Public definitions                                                 -//
//----------------------------------------------------------------------//
 
typedef enum _SbgEComClockState
{
    SBG_ECOM_CLOCK_STATE_ERROR              = 0,                        
    SBG_ECOM_CLOCK_STATE_FREE_RUNNING       = 1,                        
    SBG_ECOM_CLOCK_STATE_STEERING           = 2,                        
    SBG_ECOM_CLOCK_STATE_VALID              = 3                         
} SbgEComClockState;
 
typedef enum _SbgEComUtcStatus
{
    SBG_ECOM_UTC_STATUS_INVALID             = 0,                        
    SBG_ECOM_UTC_STATUS_NO_LEAP_SEC         = 1,                        
    SBG_ECOM_UTC_STATUS_INITIALIZED         = 2                         
} SbgEComUtcStatus;
 
//----------------------------------------------------------------------//
//- Log structure definitions                                          -//
//----------------------------------------------------------------------//
 
typedef struct _SbgEComLogUtc
{
    uint32_t    timeStamp;                  
    uint16_t    status;                     
    uint16_t    year;                       
    int8_t      month;                      
    int8_t      day;                        
    int8_t      hour;                       
    int8_t      minute;                     
    int8_t      second;                     
    int32_t     nanoSecond;                 
    uint32_t    gpsTimeOfWeek;              
    float       clkBiasStd;                 
    float       clkSfErrorStd;              
    float       clkResidualError;           
} SbgEComLogUtc;
 
//----------------------------------------------------------------------//
//- Public methods                                                     -//
//----------------------------------------------------------------------//
 
void sbgEComLogUtcZeroInit(SbgEComLogUtc *pLogData);
 
SbgErrorCode sbgEComLogUtcReadFromStream(SbgEComLogUtc *pLogData, SbgStreamBuffer *pStreamBuffer);
 
SbgErrorCode sbgEComLogUtcWriteToStream(const SbgEComLogUtc *pLogData, SbgStreamBuffer *pStreamBuffer);
 
//----------------------------------------------------------------------//
//- Public setters/getters                                             -//
//----------------------------------------------------------------------//
 
void sbgEComLogUtcSetClockState(SbgEComLogUtc *pLogData, SbgEComClockState state);
 
SbgEComClockState sbgEComLogUtcGetClockState(const SbgEComLogUtc *pLogData);
 
const char *sbgEComLogUtcGetClockStateAsString(const SbgEComLogUtc *pLogData);
 
void sbgEComLogUtcSetUtcStatus(SbgEComLogUtc *pLogData, SbgEComUtcStatus status);
 
SbgEComUtcStatus sbgEComLogUtcGetUtcStatus(const SbgEComLogUtc *pLogData);
 
const char *sbgEComLogUtcGetUtcStatusAsString(const SbgEComLogUtc *pLogData);
 
void sbgEComLogUtcSetHasClockInput(SbgEComLogUtc *pLogData, bool hasClockInput);
 
bool sbgEComLogUtcHasClockInput(const SbgEComLogUtc *pLogData);
 
void sbgEComLogUtcTimeSetIsAccurate(SbgEComLogUtc *pLogData, bool utcIsAccurate);
 
bool sbgEComLogUtcTimeIsAccurate(const SbgEComLogUtc *pLogData);
 
bool sbgEComLogUtcTimeClkBiasStdIsValid(const SbgEComLogUtc *pLogData);
 
bool sbgEComLogUtcTimeClkSfErrorStdIsValid(const SbgEComLogUtc *pLogData);
 
bool sbgEComLogUtcTimeClkResidualErrorIsValid(const SbgEComLogUtc *pLogData);
 
//----------------------------------------------------------------------//
//- DEPRECATED - Used for backward compatibility                       -//
//----------------------------------------------------------------------//
 
#ifdef SBG_ECOM_USE_DEPRECATED_MACROS
    #define SBG_ECOM_CLOCK_STABLE_INPUT         (0x0001u << 0)
    #define SBG_ECOM_CLOCK_UTC_SYNC             (0x0001u << 5)
    
    #define SBG_ECOM_CLOCK_ERROR                (SBG_ECOM_CLOCK_STATE_ERROR)
    #define SBG_ECOM_CLOCK_FREE_RUNNING         (SBG_ECOM_CLOCK_STATE_FREE_RUNNING)
    #define SBG_ECOM_CLOCK_STEERING             (SBG_ECOM_CLOCK_STATE_STEERING)
    #define SBG_ECOM_CLOCK_VALID                (SBG_ECOM_CLOCK_STATE_VALID)
 
    #define SBG_ECOM_UTC_INVALID                (SBG_ECOM_UTC_STATUS_INVALID)
    #define SBG_ECOM_UTC_NO_LEAP_SEC            (SBG_ECOM_UTC_STATUS_NO_LEAP_SEC)
    #define SBG_ECOM_UTC_VALID                  (SBG_ECOM_UTC_STATUS_INITIALIZED)
#endif
 
SBG_DEPRECATED_TYPEDEF(typedef enum _SbgEComClockState  SbgEComClockStatus);
SBG_DEPRECATED_TYPEDEF(typedef enum _SbgEComUtcStatus   SbgEComClockUtcStatus);
SBG_DEPRECATED_TYPEDEF(typedef struct _SbgEComLogUtc    SbgLogUtcData);
 
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogParseUtcData(SbgStreamBuffer *pStreamBuffer, SbgEComLogUtc *pLogData));
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogWriteUtcData(SbgStreamBuffer *pStreamBuffer, const SbgEComLogUtc *pLogData));
 
SBG_DEPRECATED(SbgEComClockState sbgEComLogUtcGetClockStatus(uint16_t status));
SBG_DEPRECATED(const char *sbgEcomLogUtcGetClockStatusAsString(const SbgEComLogUtc *pLogUtc));
 
SBG_DEPRECATED(SbgEComUtcStatus sbgEComLogUtcGetClockUtcStatus(uint16_t status));
SBG_DEPRECATED(const char *sbgEcomLogUtcGetUtcStatusAsString(const SbgEComLogUtc *pLogUtc));
 
SBG_DEPRECATED(uint16_t sbgEComLogUtcBuildClockStatus(SbgEComClockState clockState, SbgEComUtcStatus utcStatus, uint16_t masks));
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_LOG_UTC_H