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

This file is used to parse received ship motion binary logs. More...

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

Go to the source code of this file.

Data Structures

struct  _SbgLogShipMotionData
 

Macros

#define SBG_ECOM_HEAVE_VALID   (0x0001u << 0)
 
#define SBG_ECOM_HEAVE_VEL_AIDED   (0x0001u << 1)
 
#define SBG_ECOM_HEAVE_SURGE_SWAY_INCLUDED   (0x0001u << 2)
 
#define SBG_ECOM_HEAVE_PERIOD_INCLUDED   (0x0001u << 3)
 
#define SBG_ECOM_HEAVE_PERIOD_VALID   (0x0001u << 4)
 
#define SBG_ECOM_HEAVE_SWELL_MODE   (0x0001u << 5)
 

Typedefs

typedef struct _SbgLogShipMotionData SbgLogShipMotionData
 

Functions

SbgErrorCode sbgEComBinaryLogParseShipMotionData (SbgStreamBuffer *pInputStream, SbgLogShipMotionData *pOutputData)
 
SbgErrorCode sbgEComBinaryLogWriteShipMotionData (SbgStreamBuffer *pOutputStream, const SbgLogShipMotionData *pInputData)
 

Detailed Description

This file is used to parse received ship motion binary logs.

Author
SBG Systems (Raphael Siryani)
Date
30 March 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_HEAVE_VALID

#define SBG_ECOM_HEAVE_VALID   (0x0001u << 0)

Set to 1 after heave convergence time.

§ SBG_ECOM_HEAVE_VEL_AIDED

#define SBG_ECOM_HEAVE_VEL_AIDED   (0x0001u << 1)

Set to 1 if heave output is compensated for transient accelerations.

§ SBG_ECOM_HEAVE_SURGE_SWAY_INCLUDED

#define SBG_ECOM_HEAVE_SURGE_SWAY_INCLUDED   (0x0001u << 2)

Set to 1 if surge and sway channels are provided in this output.

§ SBG_ECOM_HEAVE_PERIOD_INCLUDED

#define SBG_ECOM_HEAVE_PERIOD_INCLUDED   (0x0001u << 3)

Set to 1 if the heave period is provided in this output.

§ SBG_ECOM_HEAVE_PERIOD_VALID

#define SBG_ECOM_HEAVE_PERIOD_VALID   (0x0001u << 4)

Set to 1 if the returned heave period is assumed to be valid.

§ SBG_ECOM_HEAVE_SWELL_MODE

#define SBG_ECOM_HEAVE_SWELL_MODE   (0x0001u << 5)

Set to 1 if the real time heave filter is using the swell mode computations.

Typedef Documentation

§ SbgLogShipMotionData

Structure that stores data for the SBG_ECOM_LOG_SHIP_MOTION or SBG_ECOM_LOG_SHIP_MOTION_HP message.
The data are expressed in the standard NED Ekinox coordiante frame. Surge is positive forward, sway is positive right and heave is positive down.
Note that status flag should be read before using the different parameters because it will provide validity information about all included outputs. Some frames may not provide the heave period or surge/sway axes for example

Function Documentation

§ sbgEComBinaryLogParseShipMotionData()

SbgErrorCode sbgEComBinaryLogParseShipMotionData ( SbgStreamBuffer *  pInputStream,
SbgLogShipMotionData pOutputData 
)

Parse data for the SBG_ECOM_LOG_SHIP_MOTION or SBG_ECOM_LOG_SHIP_MOTION_HP 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.

§ sbgEComBinaryLogWriteShipMotionData()

SbgErrorCode sbgEComBinaryLogWriteShipMotionData ( SbgStreamBuffer *  pOutputStream,
const SbgLogShipMotionData pInputData 
)

Write data for the SBG_ECOM_LOG_SHIP_MOTION or SBG_ECOM_LOG_SHIP_MOTION_HP 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.