Parse received DVL (Doppler Velocity Logger) measurement logs. More...

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

Data Structures
struct	_SbgEComLogDvl

Macros
#define	SBG_ECOM_DVL_VELOCITY_VALID (0x0001u << 0)

#define	SBG_ECOM_DVL_TIME_SYNC (0x0001u << 1)

Typedefs
typedef struct _SbgEComLogDvl	SbgEComLogDvl

Functions
SbgErrorCode	sbgEComLogDvlReadFromStream (SbgEComLogDvl pLogData, SbgStreamBuffer pStreamBuffer)

SbgErrorCode	sbgEComLogDvlWriteToStream (const SbgEComLogDvl pLogData, SbgStreamBuffer pStreamBuffer)

Detailed Description

Parse received DVL (Doppler Velocity Logger) measurement logs.

Author: SBG Systems

Date: 05 June 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_DVL_VELOCITY_VALID

#define SBG_ECOM_DVL_VELOCITY_VALID (0x0001u << 0)

DVL status mask definitions Set to 1 if the DVL equipment was able to measure a valid velocity.

◆ SBG_ECOM_DVL_TIME_SYNC

#define SBG_ECOM_DVL_TIME_SYNC (0x0001u << 1)

Set to 1 if the DVL data is correctly synchronized.

Typedef Documentation

◆ SbgEComLogDvl

typedef struct _SbgEComLogDvl SbgEComLogDvl

Log structure for DVL 3D velocity measurement.

Function Documentation

◆ sbgEComLogDvlReadFromStream()

SbgErrorCode sbgEComLogDvlReadFromStream	(	SbgEComLogDvl *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

Parse data for the SBG_ECOM_LOG_DVL_BOTTOM_TRACK / SBG_ECOM_LOG_DVL_WATER_TRACK messages 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.

◆ sbgEComLogDvlWriteToStream()

SbgErrorCode sbgEComLogDvlWriteToStream	(	const SbgEComLogDvl *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

Write data for the SBG_ECOM_LOG_DVL_BOTTOM_TRACK / SBG_ECOM_LOG_DVL_WATER_TRACK messages to the output stream buffer from the provided structure.