sbgEComBinaryLogDepth.h File Reference

This file is used to store depth measurements. More...

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

Include dependency graph for sbgEComBinaryLogDepth.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_SbgLogDepth

Macros
#define	SBG_ECOM_DEPTH_ALTITUDE_VALID   (0x0001u << 2)
#define	SBG_ECOM_DEPTH_PRESSURE_ABS_VALID   (0x0001u << 1)
#define	SBG_ECOM_DEPTH_TIME_IS_DELAY   (0x0001u << 0)

Typedefs
typedef struct _SbgLogDepth	SbgLogDepth

Functions
SbgErrorCode	sbgEComBinaryLogParseDepth (SbgStreamBuffer *pInputStream, SbgLogDepth *pOutputData)
SbgErrorCode	sbgEComBinaryLogWriteDepth (SbgStreamBuffer *pOutputStream, const SbgLogDepth *pInputData)

Detailed Description

This file is used to store depth measurements.

Author

SBG Systems

Date

20 February 2019

Depth sensor are used for subsea navigation to improve height.

Copyright Notice

Copyright (C) 2007-2019, 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 sbgEComBinaryLogDepth.h.

Macro Definition Documentation

#define SBG_ECOM_DEPTH_ALTITUDE_VALID   (0x0001u << 2)

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

Definition at line 37 of file sbgEComBinaryLogDepth.h.

#define SBG_ECOM_DEPTH_PRESSURE_ABS_VALID   (0x0001u << 1)

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

Definition at line 36 of file sbgEComBinaryLogDepth.h.

#define SBG_ECOM_DEPTH_TIME_IS_DELAY   (0x0001u << 0)

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

Definition at line 35 of file sbgEComBinaryLogDepth.h.

Typedef Documentation

typedef struct _SbgLogDepth SbgLogDepth

Log structure for Depth sensor measurement (subsea).

Function Documentation

SbgErrorCode sbgEComBinaryLogParseDepth	(	SbgStreamBuffer *	pInputStream,
		SbgLogDepth *	pOutputData
	)

Parse data for the SBG_ECOM_LOG_DEPTH message and fill the corresponding structure.

Parameters

[in]	pInputStream	Input stream buffer to read the payload from.
[out]	pOutputData	Pointer on the output structure that stores parsed data.

Returns

SBG_NO_ERROR if the payload has been parsed.

Definition at line 7 of file sbgEComBinaryLogDepth.c.

SbgErrorCode sbgEComBinaryLogWriteDepth	(	SbgStreamBuffer *	pOutputStream,
		const SbgLogDepth *	pInputData
	)

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

Parameters

[out]	pOutputStream	Output stream buffer to write the payload to.
[in]	pInputData	Pointer 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 27 of file sbgEComBinaryLogDepth.c.