sbgECom  1.11.920-stable
Data Structures | Macros | Typedefs | Functions
sbgEComBinaryLogOdometer.h File Reference

This file is used to parse received odometer binary logs. More...

#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>

Go to the source code of this file.

Data Structures

struct  _SbgLogOdometerData
 

Macros

#define SBG_ECOM_ODO_REAL_MEAS   (0x0001 << 0)
 
#define SBG_ECOM_ODO_TIME_SYNC   (0x0001 << 1)
 

Typedefs

typedef struct _SbgLogOdometerData SbgLogOdometerData
 

Functions

SbgErrorCode sbgEComBinaryLogParseOdometerData (SbgStreamBuffer *pInputStream, SbgLogOdometerData *pOutputData)
 
SbgErrorCode sbgEComBinaryLogWriteOdometerData (SbgStreamBuffer *pOutputStream, const SbgLogOdometerData *pInputData)
 

Detailed Description

This file is used to parse received odometer binary logs.

Author
SBG Systems (Raphael Siryani)
Date
25 February 2013

Copyright Notice

Copyright (C) 2007-2013, SBG Systems SAS. All rights reserved.

This source code is intended for use only by SBG Systems SAS and those that have explicit written permission to use it from SBG Systems SAS.

THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.

Macro Definition Documentation

§ SBG_ECOM_ODO_REAL_MEAS

#define SBG_ECOM_ODO_REAL_MEAS   (0x0001 << 0)

Odometer / velocity status mask definitions.Set to 1 if this log comes from a real pulse measurement or from a timeout.

§ SBG_ECOM_ODO_TIME_SYNC

#define SBG_ECOM_ODO_TIME_SYNC   (0x0001 << 1)

Set to 1 if the velocity information is correctly time synchronized.

Typedef Documentation

§ SbgLogOdometerData

Log structure for odometer data.

Function Documentation

§ sbgEComBinaryLogParseOdometerData()

SbgErrorCode sbgEComBinaryLogParseOdometerData ( SbgStreamBuffer *  pInputStream,
SbgLogOdometerData pOutputData 
)

Parse data for the SBG_ECOM_LOG_ODO_VEL message and fill the corresponding structure.

Parameters
[in]pInputStreamInput stream buffer to read the payload from.
[out]pOutputDataPointer on the output structure that stores parsed data.
Returns
SBG_NO_ERROR if the payload has been parsed.

§ sbgEComBinaryLogWriteOdometerData()

SbgErrorCode sbgEComBinaryLogWriteOdometerData ( SbgStreamBuffer *  pOutputStream,
const SbgLogOdometerData pInputData 
)

Write data for the SBG_ECOM_LOG_ODO_VEL message to the output stream buffer from the provided structure.

Parameters
[out]pOutputStreamOutput stream buffer to write the payload to.
[in]pInputDataPointer on the input structure that stores data to write.
Returns
SBG_NO_ERROR if the message has been generated in the provided buffer.