sbgEComLogShipMotion.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_LOG_SHIP_MOTION_H
#define SBG_ECOM_LOG_SHIP_MOTION_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Heave status definitions                                           -//
//----------------------------------------------------------------------//
 
#define SBG_ECOM_SHIP_MOTION_HEAVE_VALID            (0x0001u << 0)      
#define SBG_ECOM_SHIP_MOTION_VEL_AIDED              (0x0001u << 1)      
#define SBG_ECOM_SHIP_MOTION_SURGE_SWAY_VALID       (0x0001u << 2)      
#define SBG_ECOM_SHIP_MOTION_RESERVED               (0x0001u << 3)      
#define SBG_ECOM_SHIP_MOTION_HEAVE_PERIOD_VALID     (0x0001u << 4)      
#define SBG_ECOM_SHIP_MOTION_SWELL_MODE             (0x0001u << 5)      
#define SBG_ECOM_SHIP_MOTION_ACCEL_VALID            (0x0001u << 6)      
 
//----------------------------------------------------------------------//
//- Log structure definitions                                          -//
//----------------------------------------------------------------------//

typedef struct _SbgEComLogShipMotion
{
    uint32_t    timeStamp;                 
    uint16_t    status;                       
    float       mainHeavePeriod;         
    float       shipMotion[3];                
    float       shipAccel[3];              
    float       shipVel[3];                  
} SbgEComLogShipMotion;
 
//----------------------------------------------------------------------//
//- Public methods                                                     -//
//----------------------------------------------------------------------//

SbgErrorCode sbgEComLogShipMotionReadFromStream(SbgEComLogShipMotion *pLogData, SbgStreamBuffer *pStreamBuffer);

SbgErrorCode sbgEComLogShipMotionWriteToStream(const SbgEComLogShipMotion *pLogData, SbgStreamBuffer *pStreamBuffer);
 
//----------------------------------------------------------------------//
//- DEPRECATED - Used for backward compatibility                       -//
//----------------------------------------------------------------------//
 
#ifdef SBG_ECOM_USE_DEPRECATED_MACROS
    #define SBG_ECOM_HEAVE_VALID                    SBG_ECOM_SHIP_MOTION_HEAVE_VALID
    #define SBG_ECOM_HEAVE_VEL_AIDED                SBG_ECOM_SHIP_MOTION_VEL_AIDED
    #define SBG_ECOM_HEAVE_SURGE_SWAY_INCLUDED      SBG_ECOM_SHIP_MOTION_SURGE_SWAY_VALID
    #define SBG_ECOM_HEAVE_PERIOD_INCLUDED          SBG_ECOM_SHIP_MOTION_HEAVE_PERIOD_VALID
    #define SBG_ECOM_HEAVE_PERIOD_VALID             SBG_ECOM_SHIP_MOTION_HEAVE_PERIOD_VALID
    #define SBG_ECOM_HEAVE_SWELL_MODE               SBG_ECOM_SHIP_MOTION_SWELL_MODE
#endif
 
SBG_DEPRECATED_TYPEDEF(typedef struct _SbgEComLogShipMotion SbgLogShipMotionData);
 
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogParseShipMotionData(SbgStreamBuffer *pStreamBuffer, SbgEComLogShipMotion *pLogData));
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogWriteShipMotionData(SbgStreamBuffer *pStreamBuffer, const SbgEComLogShipMotion *pLogData));
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_LOG_SHIP_MOTION_H