sbgEComBinaryLogPressure.h File Reference

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

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

Include dependency graph for sbgEComBinaryLogPressure.h:

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

Go to the source code of this file.

Classes
struct	_SbgLogPressureData

Macros
#define	SBG_ECOM_PRESSURE_HEIGHT_VALID   (0x0001u << 2)
#define	SBG_ECOM_PRESSURE_PRESSURE_VALID   (0x0001u << 1)
#define	SBG_ECOM_PRESSURE_TIME_SYNC   (0x0001u << 0)

Typedefs
typedef struct _SbgLogPressureData	SbgLogPressureData

Functions
SbgErrorCode	sbgEComBinaryLogParsePressureData (SbgStreamBuffer *pInputStream, SbgLogPressureData *pOutputData)
SbgErrorCode	sbgEComBinaryLogWritePressureData (SbgStreamBuffer *pOutputStream, const SbgLogPressureData *pInputData)

Detailed Description

This file is used to parse received Pressure binary logs.

Author

SBG Systems (Raphael Siryani)

Date

30 April 2014

Pressure binary logs contains both the pressure and altitude/depth for a sensor such as an altimeter or a subsea depth sensor.

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.

Definition in file sbgEComBinaryLogPressure.h.

Macro Definition Documentation

#define SBG_ECOM_PRESSURE_HEIGHT_VALID   (0x0001u << 2)

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

Definition at line 38 of file sbgEComBinaryLogPressure.h.

#define SBG_ECOM_PRESSURE_PRESSURE_VALID   (0x0001u << 1)

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

Definition at line 37 of file sbgEComBinaryLogPressure.h.

#define SBG_ECOM_PRESSURE_TIME_SYNC   (0x0001u << 0)

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

Definition at line 36 of file sbgEComBinaryLogPressure.h.

Typedef Documentation

typedef struct _SbgLogPressureData SbgLogPressureData

Log structure for Pressure data.

Function Documentation

SbgErrorCode sbgEComBinaryLogParsePressureData	(	SbgStreamBuffer *	pInputStream,
		SbgLogPressureData *	pOutputData
	)

Parse data for the SBG_ECOM_LOG_PRESSURE 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 13 of file sbgEComBinaryLogPressure.c.

SbgErrorCode sbgEComBinaryLogWritePressureData	(	SbgStreamBuffer *	pOutputStream,
		const SbgLogPressureData *	pInputData
	)

Write data for the SBG_ECOM_LOG_PRESSURE 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 42 of file sbgEComBinaryLogPressure.c.