GNSS True Heading related logs. More...

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

Data Structures
struct	_SbgEComLogGnssHdt

Typedefs
typedef enum _SbgEComGnssHdtStatus	SbgEComGnssHdtStatus

typedef struct _SbgEComLogGnssHdt	SbgEComLogGnssHdt

Enumerations
enum	_SbgEComGnssHdtStatus { SBG_ECOM_GNSS_HDT_STATUS_SOL_COMPUTED = 0 , SBG_ECOM_GNSS_HDT_STATUS_INSUFFICIENT_OBS = 1 , SBG_ECOM_GNSS_HDT_STATUS_INTERNAL_ERROR = 2 , SBG_ECOM_GNSS_HDT_STATUS_HEIGHT_LIMIT = 3 }

Functions
void	sbgEComLogGnssHdtZeroInit (SbgEComLogGnssHdt *pLogData)

SbgErrorCode	sbgEComLogGnssHdtReadFromStream (SbgEComLogGnssHdt pLogData, SbgStreamBuffer pStreamBuffer)

SbgErrorCode	sbgEComLogGnssHdtWriteToStream (const SbgEComLogGnssHdt pLogData, SbgStreamBuffer pStreamBuffer)

void	sbgEComLogGnssHdtSetStatus (SbgEComLogGnssHdt *pLogData, SbgEComGnssHdtStatus status)

SbgEComGnssHdtStatus	sbgEComLogGnssHdtGetStatus (const SbgEComLogGnssHdt *pLogData)

bool	sbgEComLogGnssHdtHeadingIsValid (const SbgEComLogGnssHdt *pLogData)

bool	sbgEComLogGnssHdtPitchIsValid (const SbgEComLogGnssHdt *pLogData)

void	sbgEComLogGnssHdtSetBaseLineValid (SbgEComLogGnssHdt *pLogData, bool isValid)

bool	sbgEComLogGnssHdtBaseLineIsValid (const SbgEComLogGnssHdt *pLogData)

bool	sbgEComLogGnssHdtNumSvTrackedIsValid (const SbgEComLogGnssHdt *pLogData)

bool	sbgEComLogGnssHdtNumSvUsedIsValid (const SbgEComLogGnssHdt *pLogData)

Detailed Description

GNSS True Heading related logs.

Author: SBG Systems

Date: 05 May 2023

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.

Typedef Documentation

◆ SbgEComGnssHdtStatus

typedef enum _SbgEComGnssHdtStatus SbgEComGnssHdtStatus

GNSS HDT status definitions.

◆ SbgEComLogGnssHdt

typedef struct _SbgEComLogGnssHdt SbgEComLogGnssHdt

Structure that stores data for the SBG_ECOM_LOG_GPS::_HDT message.

Enumeration Type Documentation

◆ _SbgEComGnssHdtStatus

enum _SbgEComGnssHdtStatus

GNSS HDT status definitions.

Enumerator
SBG_ECOM_GNSS_HDT_STATUS_SOL_COMPUTED	A valid solution has been computed.
SBG_ECOM_GNSS_HDT_STATUS_INSUFFICIENT_OBS	Not enough valid SV to compute a solution.
SBG_ECOM_GNSS_HDT_STATUS_INTERNAL_ERROR	An internal error has occurred.
SBG_ECOM_GNSS_HDT_STATUS_HEIGHT_LIMIT	The height limit has been exceeded.

Function Documentation

◆ sbgEComLogGnssHdtZeroInit()

void sbgEComLogGnssHdtZeroInit ( SbgEComLogGnssHdt * pLogData )

Zero initialize the message struct.

Parameters

[out] pLogData Structure instance to zero init.

◆ sbgEComLogGnssHdtReadFromStream()

SbgErrorCode sbgEComLogGnssHdtReadFromStream	(	SbgEComLogGnssHdt *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

Parse data for the SBG_ECOM_LOG_GPS::_HDT 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.

◆ sbgEComLogGnssHdtWriteToStream()

SbgErrorCode sbgEComLogGnssHdtWriteToStream	(	const SbgEComLogGnssHdt *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

Write data for the SBG_ECOM_LOG_GPS::_HDT 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.

◆ sbgEComLogGnssHdtSetStatus()

void sbgEComLogGnssHdtSetStatus	(	SbgEComLogGnssHdt *	pLogData,
		SbgEComGnssHdtStatus	status
	)

Set the true heading solution status.

Parameters

[in]	pLogData	Log instance.
[in]	status	The solution status to set.

◆ sbgEComLogGnssHdtGetStatus()

SbgEComGnssHdtStatus sbgEComLogGnssHdtGetStatus ( const SbgEComLogGnssHdt * pLogData )

Returns the true heading solution status.

Parameters

[in] pLogData Log instance.

Returns: The true heading solution status.

◆ sbgEComLogGnssHdtHeadingIsValid()

bool sbgEComLogGnssHdtHeadingIsValid ( const SbgEComLogGnssHdt * pLogData )

Returns true if the heading information is valid.

Parameters

[in] pLogData Log instance.

Returns: true if the heading information is valid or false otherwise.

◆ sbgEComLogGnssHdtPitchIsValid()

bool sbgEComLogGnssHdtPitchIsValid ( const SbgEComLogGnssHdt * pLogData )

Returns true if the pitch information is valid.

Some GNSS receivers don't provide pitch information between antenna 1 and 2. This methods checks if a valid pitch measurement is available with an associated standard deviation.

Parameters

[in] pLogData Log instance.

Returns: true if the pitch information is valid or false otherwise.

◆ sbgEComLogGnssHdtSetBaseLineValid()

void sbgEComLogGnssHdtSetBaseLineValid	(	SbgEComLogGnssHdt *	pLogData,
		bool	isValid
	)

Set if the baseline field is provided with a valid value.

Some GNSS receivers don't provide the baseline information between antenna 1 and 2. Set this flag to false to report this.

Parameters

[in]	pLogData	Log instance.
[in]	isValid	true if the baseline is valid.

◆ sbgEComLogGnssHdtBaseLineIsValid()

bool sbgEComLogGnssHdtBaseLineIsValid ( const SbgEComLogGnssHdt * pLogData )

Returns true if the baseline field is valid.

Parameters

[in] pLogData Log instance.

Returns: true if the baseline field is valid or false otherwise.

◆ sbgEComLogGnssHdtNumSvTrackedIsValid()

bool sbgEComLogGnssHdtNumSvTrackedIsValid ( const SbgEComLogGnssHdt * pLogData )

Returns true if the numSvTracked field is valid.

Parameters

[in] pLogData Log instance.

Returns: true if the numSvTracked field is valid or false otherwise.

◆ sbgEComLogGnssHdtNumSvUsedIsValid()

bool sbgEComLogGnssHdtNumSvUsedIsValid ( const SbgEComLogGnssHdt * pLogData )

Returns true if the numSvUsed field is valid.

Parameters

[in] pLogData Log instance.

Returns: true if the numSvUsed field is valid or false otherwise.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ SbgEComGnssHdtStatus

◆ SbgEComLogGnssHdt

Enumeration Type Documentation

◆ _SbgEComGnssHdtStatus

Function Documentation

◆ sbgEComLogGnssHdtZeroInit()

◆ sbgEComLogGnssHdtReadFromStream()

◆ sbgEComLogGnssHdtWriteToStream()

◆ sbgEComLogGnssHdtSetStatus()

◆ sbgEComLogGnssHdtGetStatus()

◆ sbgEComLogGnssHdtHeadingIsValid()

◆ sbgEComLogGnssHdtPitchIsValid()

◆ sbgEComLogGnssHdtSetBaseLineValid()

◆ sbgEComLogGnssHdtBaseLineIsValid()

◆ sbgEComLogGnssHdtNumSvTrackedIsValid()

◆ sbgEComLogGnssHdtNumSvUsedIsValid()