sbgEComBinaryLogShipMotion.h File Reference

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

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

Include dependency graph for sbgEComBinaryLogShipMotion.h:

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

Go to the source code of this file.

Classes
struct	_SbgLogShipMotionData

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

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.

Definition in file sbgEComBinaryLogShipMotion.h.

Macro Definition Documentation

#define SBG_ECOM_HEAVE_PERIOD_INCLUDED   (0x0001u << 3)

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

Definition at line 33 of file sbgEComBinaryLogShipMotion.h.

#define SBG_ECOM_HEAVE_PERIOD_VALID   (0x0001u << 4)

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

Definition at line 34 of file sbgEComBinaryLogShipMotion.h.

#define SBG_ECOM_HEAVE_SURGE_SWAY_INCLUDED   (0x0001u << 2)

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

Definition at line 32 of file sbgEComBinaryLogShipMotion.h.

#define SBG_ECOM_HEAVE_VALID   (0x0001u << 0)

Set to 1 after heave convergence time.

Definition at line 30 of file sbgEComBinaryLogShipMotion.h.

#define SBG_ECOM_HEAVE_VEL_AIDED   (0x0001u << 1)

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

Definition at line 31 of file sbgEComBinaryLogShipMotion.h.

Typedef Documentation

typedef struct _SbgLogShipMotionData 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

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

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]	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 83 of file sbgEComBinaryLogShipMotion.c.