sbgECom Library  4.0.1987-stable
C library to interface SBG Systems IMU/AHRS/INS
sbgEComLogRawData.h File Reference

Parse logs used to store a binary stream such as RAW GNSS or RTCM stream. More...

Go to the source code of this file.

Data Structures

struct  _SbgEComLogRawData
 

Macros

#define SBG_ECOM_RAW_DATA_MAX_BUFFER_SIZE   (4086u)
 

Typedefs

typedef struct _SbgEComLogRawData SbgEComLogRawData
 

Functions

SbgErrorCode sbgEComLogRawDataReadFromStream (SbgEComLogRawData *pLogData, SbgStreamBuffer *pStreamBuffer)
 
SbgErrorCode sbgEComLogRawDataWriteToStream (const SbgEComLogRawData *pLogData, SbgStreamBuffer *pStreamBuffer)
 

Detailed Description

Parse logs used to store a binary stream such as RAW GNSS or RTCM stream.

Author
SBG Systems
Date
16 November 2020
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_RAW_DATA_MAX_BUFFER_SIZE

#define SBG_ECOM_RAW_DATA_MAX_BUFFER_SIZE   (4086u)

Maximum buffer size in bytes that can be stored in the raw data log.

Typedef Documentation

◆ SbgEComLogRawData

Structure that stores raw data message.

Function Documentation

◆ sbgEComLogRawDataReadFromStream()

SbgErrorCode sbgEComLogRawDataReadFromStream ( SbgEComLogRawData pLogData,
SbgStreamBuffer pStreamBuffer 
)

Parse raw data message and fill the corresponding structure.

Parameters
[out]pLogDataLog structure instance to fill.
[in]pStreamBufferInput stream buffer to read the log from.
Returns
SBG_NO_ERROR if a valid log has been read from the stream buffer.

◆ sbgEComLogRawDataWriteToStream()

SbgErrorCode sbgEComLogRawDataWriteToStream ( const SbgEComLogRawData pLogData,
SbgStreamBuffer pStreamBuffer 
)

Write raw data message to the output stream buffer from the provided structure.

Parameters
[in]pLogDataLog structure instance to write.
[out]pStreamBufferOutput stream buffer to write the log to.
Returns
SBG_NO_ERROR if the log has been written to the stream buffer.