sbgEComCmdAdvanced.h File Reference

This file implements SbgECom commands related to advanced settings. More...

#include "sbgEComCmdCommon.h"

Include dependency graph for sbgEComCmdAdvanced.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_SbgEComAdvancedConf
struct	_SbgEComValidityThresholds

Typedefs
typedef struct _SbgEComAdvancedConf	SbgEComAdvancedConf
typedef enum _SbgEComTimeReferenceSrc	SbgEComTimeReferenceSrc
typedef struct _SbgEComValidityThresholds	SbgEComValidityThresholds

Enumerations
enum	_SbgEComTimeReferenceSrc { SBG_ECOM_TIME_REF_DISABLED = 0, SBG_ECOM_TIME_REF_SYNC_IN_A, SBG_ECOM_TIME_REF_UTC_GPS_1 }

Functions
SbgErrorCode	sbgEComCmdAdvancedGetConf (SbgEComHandle *pHandle, SbgEComAdvancedConf *pConf)
SbgErrorCode	sbgEComCmdAdvancedGetThresholds (SbgEComHandle *pHandle, SbgEComValidityThresholds *pConf)
SbgErrorCode	sbgEComCmdAdvancedSetConf (SbgEComHandle *pHandle, const SbgEComAdvancedConf *pConf)
SbgErrorCode	sbgEComCmdAdvancedSetThresholds (SbgEComHandle *pHandle, const SbgEComValidityThresholds *pConf)

Detailed Description

This file implements SbgECom commands related to advanced settings.

Author

SBG Systems (Maxime Renaudet)

Date

11 June 2014

Copyright Notice

Copyright (C) 2007-2013, SBG Systems SAS. All rights reserved.

This source code is intended for use only by SBG Systems SAS and those that have explicit written permission to use it from SBG Systems SAS.

THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.

Definition in file sbgEComCmdAdvanced.h.

Typedef Documentation

SbgEComAdvancedConf

typedef struct _SbgEComAdvancedConf SbgEComAdvancedConf

Structure containing all the info for advanced configuration.

SbgEComTimeReferenceSrc

typedef enum _SbgEComTimeReferenceSrc SbgEComTimeReferenceSrc

List of available time reference source.

SbgEComValidityThresholds

typedef struct _SbgEComValidityThresholds SbgEComValidityThresholds

Structure containing all validity thresholds (status outputs) Setting these thresholds to 0.0 will keep default configuration

Enumeration Type Documentation

_SbgEComTimeReferenceSrc

enum _SbgEComTimeReferenceSrc

List of available time reference source.

Enumerator
SBG_ECOM_TIME_REF_DISABLED	The device is running it's internal clock without any time reference.
SBG_ECOM_TIME_REF_SYNC_IN_A	The main port sync in A is used as a time reference.
SBG_ECOM_TIME_REF_UTC_GPS_1	The GPS 1 module is used to provide both time reference and UTC data.

Definition at line 33 of file sbgEComCmdAdvanced.h.

Function Documentation

sbgEComCmdAdvancedGetConf()

SbgErrorCode sbgEComCmdAdvancedGetConf	(	SbgEComHandle *	pHandle,
		SbgEComAdvancedConf *	pConf
	)

Retrieve the advanced configurations.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pConf	Pointer to a SbgEComAdvancedConf to contain the current configuration.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 14 of file sbgEComCmdAdvanced.c.

sbgEComCmdAdvancedGetThresholds()

SbgErrorCode sbgEComCmdAdvancedGetThresholds	(	SbgEComHandle *	pHandle,
		SbgEComValidityThresholds *	pConf
	)

Retrieve the current validity thresholds

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pConf	Pointer to a SbgEComValidityThresholds to contain the current configuration.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 154 of file sbgEComCmdAdvanced.c.

sbgEComCmdAdvancedSetConf()

SbgErrorCode sbgEComCmdAdvancedSetConf	(	SbgEComHandle *	pHandle,
		const SbgEComAdvancedConf *	pConf
	)

Set the advanced configurations.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	pConf	Pointer to a SbgEComAdvancedConf that contains the new configuration.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 84 of file sbgEComCmdAdvanced.c.

sbgEComCmdAdvancedSetThresholds()

SbgErrorCode sbgEComCmdAdvancedSetThresholds	(	SbgEComHandle *	pHandle,
		const SbgEComValidityThresholds *	pConf
	)

Set the validity thresholds

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	pConf	Pointer to a SbgEComValidityThresholds that contains the new configuration.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 228 of file sbgEComCmdAdvanced.c.