Parse received sub-sea depth measurement logs. More...

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

Data Structures
struct	_SbgEComLogDepth

Macros
#define	SBG_ECOM_DEPTH_TIME_IS_DELAY (0x0001u << 0)

#define	SBG_ECOM_DEPTH_PRESSURE_ABS_VALID (0x0001u << 1)

#define	SBG_ECOM_DEPTH_ALTITUDE_VALID (0x0001u << 2)

Typedefs
typedef struct _SbgEComLogDepth	SbgEComLogDepth

Functions
SbgErrorCode	sbgEComLogDepthReadFromStream (SbgEComLogDepth pLogData, SbgStreamBuffer pStreamBuffer)

SbgErrorCode	sbgEComLogDepthWriteToStream (const SbgEComLogDepth pLogData, SbgStreamBuffer pStreamBuffer)

Detailed Description

Parse received sub-sea depth measurement logs.

Author: SBG Systems

Date: 20 February 2019

Depth sensor are used for sub-sea navigation to improve height.

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_DEPTH_TIME_IS_DELAY

#define SBG_ECOM_DEPTH_TIME_IS_DELAY (0x0001u << 0)

Air Data sensor status mask definitions Set to 1 if the time stamp field represents a delay instead of an absolute time stamp.

◆ SBG_ECOM_DEPTH_PRESSURE_ABS_VALID

#define SBG_ECOM_DEPTH_PRESSURE_ABS_VALID (0x0001u << 1)

Set to 1 if the pressure field is filled and valid.

◆ SBG_ECOM_DEPTH_ALTITUDE_VALID

#define SBG_ECOM_DEPTH_ALTITUDE_VALID (0x0001u << 2)

Set to 1 if the depth altitude field is filled and valid.

Typedef Documentation

◆ SbgEComLogDepth

typedef struct _SbgEComLogDepth SbgEComLogDepth

Log structure for Depth sensor measurement (sub-sea).

Function Documentation

◆ sbgEComLogDepthReadFromStream()

SbgErrorCode sbgEComLogDepthReadFromStream	(	SbgEComLogDepth *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

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

◆ sbgEComLogDepthWriteToStream()

SbgErrorCode sbgEComLogDepthWriteToStream	(	const SbgEComLogDepth *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

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