sbgEComLogVelocity.h File Reference

Parse received generic velocity measurement logs. More...

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

Go to the source code of this file.

Data Structures
struct	_SbgEComLogVelocity

Macros
#define	SBG_ECOM_VELOCITY_0_VALID   (0x0001 << 3)
#define	SBG_ECOM_VELOCITY_1_VALID   (0x0001 << 4)
#define	SBG_ECOM_VELOCITY_2_VALID   (0x0001 << 5)
#define	SBG_ECOM_VELOCITY_STD_VALID   (0x0001 << 6)

Typedefs
typedef enum _SbgEComVelocityTimeType	SbgEComVelocityTimeType
typedef struct _SbgEComLogVelocity	SbgEComLogVelocity

Enumerations
enum	_SbgEComVelocityTimeType {   SBG_ECOM_VELOCITY_TIME_TYPE_TIMESTAMP = 0 ,   SBG_ECOM_VELOCITY_TIME_TYPE_DELAY = 1 ,   SBG_ECOM_VELOCITY_TIME_TYPE_TIME_OF_WEEK = 2 }

Functions
SbgErrorCode	sbgEComLogVelocityReadFromStream (SbgEComLogVelocity *pLogData, SbgStreamBuffer *pStreamBuffer)
SbgErrorCode	sbgEComLogVelocityWriteToStream (const SbgEComLogVelocity *pLogData, SbgStreamBuffer *pStreamBuffer)
void	sbgEComLogVelocitySetTimeType (SbgEComLogVelocity *pLogData, SbgEComVelocityTimeType timeType)
SbgEComVelocityTimeType	sbgEComLogVelocityGetTimeType (const SbgEComLogVelocity *pLogData)

Detailed Description

Parse received generic velocity measurement logs.

Author

SBG Systems

Date

March 12, 2025

Copyright

Copyright (C) 2007-2025, 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_VELOCITY_0_VALID

#define SBG_ECOM_VELOCITY_0_VALID   (0x0001 << 3)

Velocity status mask definitions. Set to 1 if the X or North velocity information is valid.

SBG_ECOM_VELOCITY_1_VALID

#define SBG_ECOM_VELOCITY_1_VALID   (0x0001 << 4)

Set to 1 if the Y or East velocity information is valid.

SBG_ECOM_VELOCITY_2_VALID

#define SBG_ECOM_VELOCITY_2_VALID   (0x0001 << 5)

Set to 1 if the Z or Down velocity information is valid.

SBG_ECOM_VELOCITY_STD_VALID

#define SBG_ECOM_VELOCITY_STD_VALID   (0x0001 << 6)

Set to 1 if the velocity standard deviation information is valid.

Typedef Documentation

SbgEComVelocityTimeType

typedef enum _SbgEComVelocityTimeType SbgEComVelocityTimeType

Time types definitions.

SbgEComLogVelocity

typedef struct _SbgEComLogVelocity SbgEComLogVelocity

Log structure for velocity measurements.

Enumeration Type Documentation

_SbgEComVelocityTimeType

enum _SbgEComVelocityTimeType

Time types definitions.

Enumerator
SBG_ECOM_VELOCITY_TIME_TYPE_TIMESTAMP	The timeStamp field represents the time since the INS power up, in us.
SBG_ECOM_VELOCITY_TIME_TYPE_DELAY	The timeStamp field represents a delay, in us.
SBG_ECOM_VELOCITY_TIME_TYPE_TIME_OF_WEEK	The timeStamp field represents a GPS time of the week, in ms.

Function Documentation

sbgEComLogVelocityReadFromStream()

SbgErrorCode sbgEComLogVelocityReadFromStream	(	SbgEComLogVelocity *	pLogData,
		SbgStreamBuffer *	pStreamBuffer )

Parse data for the SBG_ECOM_LOG_VELOCITY_# 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.

sbgEComLogVelocityWriteToStream()

SbgErrorCode sbgEComLogVelocityWriteToStream	(	const SbgEComLogVelocity *	pLogData,
		SbgStreamBuffer *	pStreamBuffer )

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

Parameters

[in]	pLogData	Log structure instance to write.
[out]	pStreamBuffer	Output stream buffer to write the log to.

Returns

SBG_NO_ERROR if the log has been written to the stream buffer.

sbgEComLogVelocitySetTimeType()

void sbgEComLogVelocitySetTimeType	(	SbgEComLogVelocity *	pLogData,
		SbgEComVelocityTimeType	timeType )

Set the velocity time type.

Parameters

[in]	pLogData	Log instance.
[in]	timeType	The time type to set.

sbgEComLogVelocityGetTimeType()

SbgEComVelocityTimeType sbgEComLogVelocityGetTimeType

(

const SbgEComLogVelocity *

pLogData

)

Returns the velocity time type.

Parameters

[in]

pLogData

Log instance.

Returns

The time type.