sbgEComLogPosition.h File Reference

Parse received generic position measurement logs. More...

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

Go to the source code of this file.

Data Structures
struct	_SbgEComLogPosition

Typedefs
typedef enum _SbgEComPositionType	SbgEComPositionType
typedef struct _SbgEComLogPosition	SbgEComLogPosition

Enumerations
enum	_SbgEComPositionType {   SBG_ECOM_POSITION_TYPE_INVALID = 0 ,   SBG_ECOM_POSITION_TYPE_VALID = 1 }

Functions
SbgErrorCode	sbgEComLogPositionReadFromStream (SbgEComLogPosition *pLogData, SbgStreamBuffer *pStreamBuffer)
SbgErrorCode	sbgEComLogPositionWriteToStream (const SbgEComLogPosition *pLogData, SbgStreamBuffer *pStreamBuffer)
void	sbgEComLogPositionSetPositionType (SbgEComLogPosition *pLogData, SbgEComPositionType posType)
SbgEComPositionType	sbgEComLogPositionGetPositionType (const SbgEComLogPosition *pLogData)
void	sbgEComLogPositionSetTimeType (SbgEComLogPosition *pLogData, SbgEComAidingTimeType timeType)
SbgEComAidingTimeType	sbgEComLogPositionGetTimeType (const SbgEComLogPosition *pLogData)

Detailed Description

Parse received generic position measurement logs.

Author

SBG Systems

Date

October 7, 2025

Copyright

Copyright (C) 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.

Typedef Documentation

SbgEComPositionType

typedef enum _SbgEComPositionType SbgEComPositionType

Position types definitions.

SbgEComLogPosition

typedef struct _SbgEComLogPosition SbgEComLogPosition

Log structure for position measurements.

Enumeration Type Documentation

_SbgEComPositionType

enum _SbgEComPositionType

Position types definitions.

Enumerator
SBG_ECOM_POSITION_TYPE_INVALID	Position is invalid.
SBG_ECOM_POSITION_TYPE_VALID	Position is valid.

Function Documentation

sbgEComLogPositionReadFromStream()

SbgErrorCode sbgEComLogPositionReadFromStream	(	SbgEComLogPosition *	pLogData,
		SbgStreamBuffer *	pStreamBuffer )

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

sbgEComLogPositionWriteToStream()

SbgErrorCode sbgEComLogPositionWriteToStream	(	const SbgEComLogPosition *	pLogData,
		SbgStreamBuffer *	pStreamBuffer )

Write data for the SBG_ECOM_LOG_POSITION_# 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.

sbgEComLogPositionSetPositionType()

void sbgEComLogPositionSetPositionType	(	SbgEComLogPosition *	pLogData,
		SbgEComPositionType	posType )

Set the position type.

Parameters

[in]	pLogData	Log instance.
[in]	posType	The position type to set.

sbgEComLogPositionGetPositionType()

SbgEComPositionType sbgEComLogPositionGetPositionType

(

const SbgEComLogPosition *

pLogData

)

Returns the position type.

Parameters

[in]

pLogData

Log instance.

Returns

The position type.

sbgEComLogPositionSetTimeType()

void sbgEComLogPositionSetTimeType	(	SbgEComLogPosition *	pLogData,
		SbgEComAidingTimeType	timeType )

Set the position time type.

Parameters

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

sbgEComLogPositionGetTimeType()

SbgEComAidingTimeType sbgEComLogPositionGetTimeType

(

const SbgEComLogPosition *

pLogData

)

Returns the position time type.

Parameters

[in]

pLogData

Log instance.

Returns

The time type.