Parse received odometer/DMI velocity measurement logs. More...

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

Data Structures
struct	_SbgEComLogOdometer

Macros
#define	SBG_ECOM_ODO_REAL_MEAS (0x0001 << 0)

#define	SBG_ECOM_ODO_TIME_SYNC (0x0001 << 1)

Typedefs
typedef struct _SbgEComLogOdometer	SbgEComLogOdometer

Functions
SbgErrorCode	sbgEComLogOdometerReadFromStream (SbgEComLogOdometer pLogData, SbgStreamBuffer pStreamBuffer)

SbgErrorCode	sbgEComLogOdometerWriteToStream (const SbgEComLogOdometer pLogData, SbgStreamBuffer pStreamBuffer)

Detailed Description

Parse received odometer/DMI velocity measurement logs.

Author: SBG Systems

Date: 25 February 2013

Copyright: Copyright (C) 2022, SBG Systems SAS. All rights reserved.

License

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.

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

◆ SbgEComLogOdometer

typedef struct _SbgEComLogOdometer SbgEComLogOdometer

Log structure for odometer/DMI velocity measurements.

Function Documentation

◆ sbgEComLogOdometerReadFromStream()

SbgErrorCode sbgEComLogOdometerReadFromStream	(	SbgEComLogOdometer *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

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

Parameters

[out]	pLogData	Log structure instance to fill.
[in]	pStreamBuffer	Input stream buffer to read the log from.

Returns: SBG_NO_ERROR if a valid log has been read from the stream buffer.

◆ sbgEComLogOdometerWriteToStream()

SbgErrorCode sbgEComLogOdometerWriteToStream	(	const SbgEComLogOdometer *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

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