sbgEComDefsGnss.h File Reference

Common enumeration and definitions for RAW GNSS data. More...

#include <sbgCommon.h>

Go to the source code of this file.

Typedefs
typedef enum _SbgEComSignalId	SbgEComSignalId
typedef enum _SbgEComConstellationId	SbgEComConstellationId

Enumerations
enum	_SbgEComSignalId
enum	_SbgEComConstellationId

Functions
SbgEComConstellationId	sbgEComGetConstellationFromSignalId (SbgEComSignalId signalId)
bool	sbgEComSignalIdIsValid (uint8_t signalId)
const char *	sbgEComSignalToStr (SbgEComSignalId signalId)
bool	sbgEComConstellationIdIsValid (uint8_t constellationId)
const char *	sbgEComConstellationToStr (SbgEComConstellationId constellationId)

Detailed Description

Common enumeration and definitions for RAW GNSS data.

Author

SBG Systems

Date

20 September 2022

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

SbgEComSignalId

typedef enum _SbgEComSignalId SbgEComSignalId

Signal IDs.

These are on-the-wire values.

SbgEComConstellationId

typedef enum _SbgEComConstellationId SbgEComConstellationId

Constellation IDs.

All values must be strictly lower than 16.

These are on-the-wire values.

Enumeration Type Documentation

_SbgEComSignalId

enum _SbgEComSignalId

Signal IDs.

These are on-the-wire values.

_SbgEComConstellationId

enum _SbgEComConstellationId

Constellation IDs.

All values must be strictly lower than 16.

These are on-the-wire values.

Function Documentation

sbgEComGetConstellationFromSignalId()

SbgEComConstellationId sbgEComGetConstellationFromSignalId

(

SbgEComSignalId

signalId

)

Returns a constellation given a signal ID

Parameters

[in]

signalId

Signal ID value.

Returns

Constellation this signal belongs to.

sbgEComSignalIdIsValid()

bool sbgEComSignalIdIsValid

(

uint8_t

signalId

)

Check if a value belongs to SbgEComSignalId enum.

WARNING: SBG_ECOM_SIGNAL_ID_UNKNOWN is considered to be a valid enum value.

Parameters

[in]

signalId

Signal ID value.

Returns

true if the value is valid

sbgEComSignalToStr()

const char* sbgEComSignalToStr

(

SbgEComSignalId

signalId

)

Get a signal ID as a read only C string.

Parameters

[in]

signalId

Signal ID value.

Returns

Signal ID as a read only C string.

sbgEComConstellationIdIsValid()

bool sbgEComConstellationIdIsValid

(

uint8_t

constellationId

)

Check if a value belongs to SbgEComConstellationId enum.

Parameters

[in]

constellationId

constellation ID value.

Returns

true if the value is valid

sbgEComConstellationToStr()

const char* sbgEComConstellationToStr

(

SbgEComConstellationId

constellationId

)

Get a constellation ID as a read only C string.

Parameters

[in]

constellationId

Constellation ID value.

Returns

Constellation ID as a read only C string.