sbgECom  1.10.3692-stable
Data Structures | Macros | Typedefs | Functions
sbgEComBinaryLogPressure.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  _SbgLogPressureData
 

Macros

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

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.

Macro Definition Documentation

§ SBG_ECOM_PRESSURE_TIME_SYNC

#define SBG_ECOM_PRESSURE_TIME_SYNC   (0x0001u << 0)

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

§ SBG_ECOM_PRESSURE_PRESSURE_VALID

#define SBG_ECOM_PRESSURE_PRESSURE_VALID   (0x0001u << 1)

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

§ SBG_ECOM_PRESSURE_HEIGHT_VALID

#define SBG_ECOM_PRESSURE_HEIGHT_VALID   (0x0001u << 2)

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

Typedef Documentation

§ SbgLogPressureData

Log structure for Pressure data.

Function Documentation

§ sbgEComBinaryLogParsePressureData()

SbgErrorCode sbgEComBinaryLogParsePressureData ( SbgStreamBuffer *  pInputStream,
SbgLogPressureData pOutputData 
)

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

§ sbgEComBinaryLogWritePressureData()

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]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.