Parse event markers logs used to timestamp external signals. More...

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

Data Structures
struct	_SbgEComLogEvent

Macros
#define	SBG_ECOM_EVENT_OVERFLOW (0x00000001u << 0)

#define	SBG_ECOM_EVENT_OFFSET_0_VALID (0x00000001u << 1)

#define	SBG_ECOM_EVENT_OFFSET_1_VALID (0x00000001u << 2)

#define	SBG_ECOM_EVENT_OFFSET_2_VALID (0x00000001u << 3)

#define	SBG_ECOM_EVENT_OFFSET_3_VALID (0x00000001u << 4)

Typedefs
typedef struct _SbgEComLogEvent	SbgEComLogEvent

Functions
SbgErrorCode	sbgEComLogEventReadFromStream (SbgEComLogEvent pLogData, SbgStreamBuffer pStreamBuffer)

SbgErrorCode	sbgEComLogEventWriteToStream (const SbgEComLogEvent pLogData, SbgStreamBuffer pStreamBuffer)

Detailed Description

Parse event markers logs used to timestamp external signals.

Author: SBG Systems

Date: 28 October 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_EVENT_OVERFLOW

#define SBG_ECOM_EVENT_OVERFLOW (0x00000001u << 0)

Log market events status mask definitions Set to 1 if we have received events at a higher rate than 1 kHz.

◆ SBG_ECOM_EVENT_OFFSET_0_VALID

#define SBG_ECOM_EVENT_OFFSET_0_VALID (0x00000001u << 1)

Set to 1 if at least two events have been received.

◆ SBG_ECOM_EVENT_OFFSET_1_VALID

#define SBG_ECOM_EVENT_OFFSET_1_VALID (0x00000001u << 2)

Set to 1 if at least three events have been received.

◆ SBG_ECOM_EVENT_OFFSET_2_VALID

#define SBG_ECOM_EVENT_OFFSET_2_VALID (0x00000001u << 3)

Set to 1 if at least four events have been received.

◆ SBG_ECOM_EVENT_OFFSET_3_VALID

#define SBG_ECOM_EVENT_OFFSET_3_VALID (0x00000001u << 4)

Set to 1 if at least five events have been received.

Typedef Documentation

◆ SbgEComLogEvent

typedef struct _SbgEComLogEvent SbgEComLogEvent

Structure that stores data for the SBG_ECOM_LOG_EVENT_# message.

Function Documentation

◆ sbgEComLogEventReadFromStream()

SbgErrorCode sbgEComLogEventReadFromStream	(	SbgEComLogEvent *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

Parse data for the SBG_ECOM_LOG_EVENT_# 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.

◆ sbgEComLogEventWriteToStream()

SbgErrorCode sbgEComLogEventWriteToStream	(	const SbgEComLogEvent *	pLogData,
		SbgStreamBuffer *	pStreamBuffer
	)

Write data for the SBG_ECOM_LOG_EVENT_# message to the output stream buffer from the provided structure.