Classes | Macros | Typedefs | Functions
sbgEComBinaryLogUsbl.h File Reference

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

#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
Include dependency graph for sbgEComBinaryLogUsbl.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  _SbgLogUsblData
 

Macros

#define SBG_ECOM_USBL_DEPTH_VALID   (0x0001u << 2)
 
#define SBG_ECOM_USBL_POSITION_VALID   (0x0001u << 1)
 
#define SBG_ECOM_USBL_TIME_SYNC   (0x0001u << 0)
 

Typedefs

typedef struct _SbgLogUsblData SbgLogUsblData
 

Functions

SbgErrorCode sbgEComBinaryLogParseUsblData (SbgStreamBuffer *pInputStream, SbgLogUsblData *pOutputData)
 
SbgErrorCode sbgEComBinaryLogWriteUsblData (SbgStreamBuffer *pOutputStream, const SbgLogUsblData *pInputData)
 

Detailed Description

This file is used to parse received USBL binary logs.

Author
SBG Systems (Raphael Siryani)
Date
02 June 2014

USBL binary logs contains underwater positioning data of a USBL beacon.

Copyright Notice

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

Definition in file sbgEComBinaryLogUsbl.h.

Macro Definition Documentation

◆ SBG_ECOM_USBL_DEPTH_VALID

#define SBG_ECOM_USBL_DEPTH_VALID   (0x0001u << 2)

Set to 1 if the USBL data has a valid depth information.

Definition at line 37 of file sbgEComBinaryLogUsbl.h.

◆ SBG_ECOM_USBL_POSITION_VALID

#define SBG_ECOM_USBL_POSITION_VALID   (0x0001u << 1)

Set to 1 if the USBL data represents a valid 2D position.

Definition at line 36 of file sbgEComBinaryLogUsbl.h.

◆ SBG_ECOM_USBL_TIME_SYNC

#define SBG_ECOM_USBL_TIME_SYNC   (0x0001u << 0)

USBL sensor status mask definitionsSet to 1 if the USBL sensor data is correctly time synchronized.

Definition at line 35 of file sbgEComBinaryLogUsbl.h.

Typedef Documentation

◆ SbgLogUsblData

Log structure for USBL data.

Function Documentation

◆ sbgEComBinaryLogParseUsblData()

SbgErrorCode sbgEComBinaryLogParseUsblData ( SbgStreamBuffer pInputStream,
SbgLogUsblData pOutputData 
)

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

Definition at line 13 of file sbgEComBinaryLogUsbl.c.

◆ sbgEComBinaryLogWriteUsblData()

SbgErrorCode sbgEComBinaryLogWriteUsblData ( SbgStreamBuffer pOutputStream,
const SbgLogUsblData pInputData 
)

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

Definition at line 45 of file sbgEComBinaryLogUsbl.c.



sbg_driver
Author(s): SBG Systems
autogenerated on Sat Sep 3 2022 02:53:36