sbgECom Library  5.1.708-stable
Interface SBG Systems IMU/AHRS/INS
sbgEComLogDvl.h
Go to the documentation of this file.
1 
33 #ifndef SBG_ECOM_LOG_DVL_H
34 #define SBG_ECOM_LOG_DVL_H
35 
36 // sbgCommonLib headers
37 #include <sbgCommon.h>
38 #include <streamBuffer/sbgStreamBuffer.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 //----------------------------------------------------------------------//
45 //- Log DVL status definitions -//
46 //----------------------------------------------------------------------//
47 
51 #define SBG_ECOM_DVL_VELOCITY_VALID (0x0001u << 0)
52 #define SBG_ECOM_DVL_TIME_SYNC (0x0001u << 1)
54 //----------------------------------------------------------------------//
55 //- Log structure definitions -//
56 //----------------------------------------------------------------------//
57 
67 typedef struct _SbgEComLogDvl
68 {
69  uint32_t timeStamp;
70  uint16_t status;
71  float velocity[3];
72  float velocityQuality[3];
73 } SbgEComLogDvl;
74 
75 //----------------------------------------------------------------------//
76 //- Public methods -//
77 //----------------------------------------------------------------------//
78 
86 SbgErrorCode sbgEComLogDvlReadFromStream(SbgEComLogDvl *pLogData, SbgStreamBuffer *pStreamBuffer);
87 
95 SbgErrorCode sbgEComLogDvlWriteToStream(const SbgEComLogDvl *pLogData, SbgStreamBuffer *pStreamBuffer);
96 
97 //----------------------------------------------------------------------//
98 //- DEPRECATED - Used for backward compatibility -//
99 //----------------------------------------------------------------------//
100 
101 SBG_DEPRECATED_TYPEDEF(typedef struct _SbgEComLogDvl SbgLogDvlData);
102 
103 SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogParseDvlData(SbgStreamBuffer *pStreamBuffer, SbgEComLogDvl *pLogData));
104 SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogWriteDvlData(SbgStreamBuffer *pStreamBuffer, const SbgEComLogDvl *pLogData));
105 
106 #ifdef __cplusplus
107 }
108 #endif
109 
110 #endif // SBG_ECOM_LOG_DVL_H
sbgCommon.h
Main header for the SBG Systems common C library.
SBG_DEPRECATED_TYPEDEF
#define SBG_DEPRECATED_TYPEDEF(decl)
Definition: sbgDefines.h:349
sbgEComLogDvlWriteToStream
SbgErrorCode sbgEComLogDvlWriteToStream(const SbgEComLogDvl *pLogData, SbgStreamBuffer *pStreamBuffer)
SbgEComLogDvl
struct _SbgEComLogDvl SbgEComLogDvl
Log structure for DVL 3D velocity measurement.
sbgEComLogDvlReadFromStream
SbgErrorCode sbgEComLogDvlReadFromStream(SbgEComLogDvl *pLogData, SbgStreamBuffer *pStreamBuffer)
SbgErrorCode
enum _SbgErrorCode SbgErrorCode
sbgStreamBuffer.h
Used to read/write data from/to a memory buffer stream.
SBG_DEPRECATED
SBG_DEPRECATED(SBG_INLINE uint32_t SBG_VERSION(uint8_t major, uint8_t minor, uint8_t rev, uint8_t build))
_SbgEComLogDvl
Log structure for DVL 3D velocity measurement.
Definition: sbgEComLogDvl.h:68
_SbgEComLogDvl::status
uint16_t status
Definition: sbgEComLogDvl.h:70
_SbgEComLogDvl::timeStamp
uint32_t timeStamp
Definition: sbgEComLogDvl.h:69
_SbgEComLogDvl::velocity
float velocity[3]
Definition: sbgEComLogDvl.h:71
_SbgEComLogDvl::velocityQuality
float velocityQuality[3]
Definition: sbgEComLogDvl.h:72
_SbgStreamBuffer
Definition: sbgStreamBufferCommon.h:201