sbgECom  1.11.920-stable
Data Structures | Macros | Typedefs | Functions
sbgEComBinaryLogDvl.h File Reference

This file is used to parse received DVL binary logs. More...

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

Go to the source code of this file.

Data Structures

struct  _SbgLogDvlData
 

Macros

#define SBG_ECOM_DVL_VELOCITY_VALID   (0x0001u << 0)
 
#define SBG_ECOM_DVL_TIME_SYNC   (0x0001u << 1)
 

Typedefs

typedef struct _SbgLogDvlData SbgLogDvlData
 

Functions

SbgErrorCode sbgEComBinaryLogParseDvlData (SbgStreamBuffer *pInputStream, SbgLogDvlData *pOutputData)
 
SbgErrorCode sbgEComBinaryLogWriteDvlData (SbgStreamBuffer *pOutputStream, const SbgLogDvlData *pInputData)
 

Detailed Description

This file is used to parse received DVL binary logs.

Author
SBG Systems
Date
05 June 2013

Copyright Notice

Copyright (C) 2007-2013, SBG Systems SAS. All rights reserved.

This source code is intended for use only by SBG Systems SAS and those that have explicit written permission to use it from SBG Systems SAS.

THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.

Macro Definition Documentation

§ SBG_ECOM_DVL_VELOCITY_VALID

#define SBG_ECOM_DVL_VELOCITY_VALID   (0x0001u << 0)

DVL status mask definitionsSet 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

§ SbgLogDvlData

typedef struct _SbgLogDvlData SbgLogDvlData

Log structure for DVL data.

Function Documentation

§ sbgEComBinaryLogParseDvlData()

SbgErrorCode sbgEComBinaryLogParseDvlData ( SbgStreamBuffer *  pInputStream,
SbgLogDvlData pOutputData 
)

Parse data for the SBG_ECOM_LOG_DVL_BOTTOM_TRACK / SBG_ECOM_LOG_DVL_WATER_TRACK message and fill the corresponding structure.

Parameters
[in]pInputStreamInput stream buffer to read the payload from.
[out]pOutputDataPointer on the output structure that stores parsed data.
Returns
SBG_NO_ERROR if the payload has been parsed.

§ sbgEComBinaryLogWriteDvlData()

SbgErrorCode sbgEComBinaryLogWriteDvlData ( SbgStreamBuffer *  pOutputStream,
const SbgLogDvlData pInputData 
)

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

Parameters
[out]pOutputStreamOutput stream buffer to write the payload to.
[in]pInputDataPointer on the input structure that stores data to write.
Returns
SBG_NO_ERROR if the message has been generated in the provided buffer.