Parse logs that returns ship motion values such as heave. More...

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

Data Structures
struct	_SbgEComLogShipMotion

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 _SbgEComLogShipMotion	SbgEComLogShipMotion

Functions
SbgErrorCode	sbgEComLogShipMotionReadFromStream (SbgEComLogShipMotion pLogData, SbgStreamBuffer pStreamBuffer)

SbgErrorCode	sbgEComLogShipMotionWriteToStream (const SbgEComLogShipMotion pLogData, SbgStreamBuffer pStreamBuffer)

Detailed Description

Parse logs that returns ship motion values such as heave.

Author: SBG Systems

Date: 30 March 2013

Copyright: Copyright (C) 2022, SBG Systems SAS. All rights reserved.

License

The MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

◆ SbgEComLogShipMotion

typedef struct _SbgEComLogShipMotion SbgEComLogShipMotion

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 Inertial Navigation System coordinate 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

◆ sbgEComLogShipMotionReadFromStream()

SbgErrorCode sbgEComLogShipMotionReadFromStream	(	SbgEComLogShipMotion *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

Parse data for the SBG_ECOM_LOG_SHIP_MOTION or SBG_ECOM_LOG_SHIP_MOTION_HP message and fill the corresponding structure.

Parameters

[out]	pLogData	Log structure instance to fill.
[in]	pStreamBuffer	Input stream buffer to read the log from.

Returns: SBG_NO_ERROR if a valid log has been read from the stream buffer.

◆ sbgEComLogShipMotionWriteToStream()

SbgErrorCode sbgEComLogShipMotionWriteToStream	(	const SbgEComLogShipMotion *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

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.