Parse incoming sbgECom logs and store result in an union. More...

#include <sbgCommon.h>
#include <sbgEComIds.h>
#include "sbgEComLogAirData.h"
#include "sbgEComLogDepth.h"
#include "sbgEComLogDiag.h"
#include "sbgEComLogDvl.h"
#include "sbgEComLogEkf.h"
#include "sbgEComLogEkfRotAccel.h"
#include "sbgEComLogEvent.h"
#include "sbgEComLogGnssHdt.h"
#include "sbgEComLogGnssPos.h"
#include "sbgEComLogGnssVel.h"
#include "sbgEComLogImu.h"
#include "sbgEComLogMag.h"
#include "sbgEComLogOdometer.h"
#include "sbgEComLogRawData.h"
#include "sbgEComLogSat.h"
#include "sbgEComLogShipMotion.h"
#include "sbgEComLogStatus.h"
#include "sbgEComLogUsbl.h"
#include "sbgEComLogUtc.h"

Data Structures
union	_SbgEComLogUnion

Typedefs
typedef union _SbgEComLogUnion	SbgEComLogUnion

Functions
SbgErrorCode	sbgEComLogParse (SbgEComClass msgClass, SbgEComMsgId msgId, const void pPayload, size_t payloadSize, SbgEComLogUnion pLogData)

void	sbgEComLogCleanup (SbgEComLogUnion *pLogData, SbgEComClass msgClass, SbgEComMsgId msgId)

Detailed Description

Parse incoming sbgECom logs and store result in an union.

Author: SBG Systems

Date: 06 February 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.

Typedef Documentation

◆ SbgEComLogUnion

typedef union _SbgEComLogUnion SbgEComLogUnion

Union used to store received logs data.

Function Documentation

◆ sbgEComLogParse()

SbgErrorCode sbgEComLogParse	(	SbgEComClass	msgClass,
		SbgEComMsgId	msgId,
		const void *	pPayload,
		size_t	payloadSize,
		SbgEComLogUnion *	pLogData
	)

Parse an incoming log and fill the output union.

Parameters

[in]	msgClass	Received message class
[in]	msgId	Received message ID
[in]	pPayload	Read only pointer on the payload buffer.
[in]	payloadSize	Payload size in bytes.
[out]	pLogData	Pointer on the output union that stores parsed data.

◆ sbgEComLogCleanup()

void sbgEComLogCleanup	(	SbgEComLogUnion *	pLogData,
		SbgEComClass	msgClass,
		SbgEComMsgId	msgId
	)

Clean up resources allocated during parsing, if any.