sbgEComCmdDvl.h File Reference

This file implements sbgECom commands related to DVL module. More...

#include <sbgCommon.h>
#include "sbgEComCmdCommon.h"

Include dependency graph for sbgEComCmdDvl.h:

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

Go to the source code of this file.

Classes
struct	_SbgEComDvlInstallation
struct	_SbgEComDvlRejectionConf

Typedefs
typedef struct _SbgEComDvlInstallation	SbgEComDvlInstallation
typedef enum _SbgEComDvlModelsIds	SbgEComDvlModelsIds
typedef struct _SbgEComDvlRejectionConf	SbgEComDvlRejectionConf

Enumerations
enum	_SbgEComDvlModelsIds { SBG_ECOM_DVL_MODEL_GENERIC_PD6 = 202 }

Functions
SbgErrorCode	sbgEComCmdDvlGetModelId (SbgEComHandle *pHandle, SbgEComDvlModelsIds *pModelId)
SbgErrorCode	sbgEComCmdDvlGetRejection (SbgEComHandle *pHandle, SbgEComDvlRejectionConf *pRejectConf)
SbgErrorCode	sbgEComCmdDvlInstallationGet (SbgEComHandle *pHandle, SbgEComDvlInstallation *pDvlInstallation)
SbgErrorCode	sbgEComCmdDvlInstallationSet (SbgEComHandle *pHandle, const SbgEComDvlInstallation *pDvlInstallation)
SbgErrorCode	sbgEComCmdDvlSetModelId (SbgEComHandle *pHandle, SbgEComDvlModelsIds modelId)
SbgErrorCode	sbgEComCmdDvlSetRejection (SbgEComHandle *pHandle, const SbgEComDvlRejectionConf *pRejectConf)

Detailed Description

This file implements sbgECom commands related to DVL module.

Author

SBG Systems

Date

13 December 2018

Copyright Notice

Copyright (C) 2007-2018, 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 sbgEComCmdDvl.h.

Typedef Documentation

SbgEComDvlInstallation

typedef struct _SbgEComDvlInstallation SbgEComDvlInstallation

DVL mechanical installation parameters such as lever arm and alignment

SbgEComDvlModelsIds

typedef enum _SbgEComDvlModelsIds SbgEComDvlModelsIds

This enum defines the different DVL model IDs available in standard

SbgEComDvlRejectionConf

typedef struct _SbgEComDvlRejectionConf SbgEComDvlRejectionConf

Holds all necessary information for DVL module data rejection.

Enumeration Type Documentation

_SbgEComDvlModelsIds

enum _SbgEComDvlModelsIds

This enum defines the different DVL model IDs available in standard

Enumerator
SBG_ECOM_DVL_MODEL_GENERIC_PD6	Generic DVL using PD6 protocol format.

Definition at line 36 of file sbgEComCmdDvl.h.

Function Documentation

sbgEComCmdDvlGetModelId()

SbgErrorCode sbgEComCmdDvlGetModelId	(	SbgEComHandle *	pHandle,
		SbgEComDvlModelsIds *	pModelId
	)

Retrieve the DVL model id currently in use by the device.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pModelId	Returns the DVL model ID currently in use by the device.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 21 of file sbgEComCmdDvl.c.

sbgEComCmdDvlGetRejection()

SbgErrorCode sbgEComCmdDvlGetRejection	(	SbgEComHandle *	pHandle,
		SbgEComDvlRejectionConf *	pRejectConf
	)

Retrieve the current rejection configuration of the DVL module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pRejectConf	Return the DVL rejection configuration currently in use.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 266 of file sbgEComCmdDvl.c.

sbgEComCmdDvlInstallationGet()

SbgErrorCode sbgEComCmdDvlInstallationGet	(	SbgEComHandle *	pHandle,
		SbgEComDvlInstallation *	pDvlInstallation
	)

Retrieve the lever arm and alignment configuration of the DVL module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pDvlInstallation	Returns the DVL lever arm and alignment configuration currently in use.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 124 of file sbgEComCmdDvl.c.

sbgEComCmdDvlInstallationSet()

SbgErrorCode sbgEComCmdDvlInstallationSet	(	SbgEComHandle *	pHandle,
		const SbgEComDvlInstallation *	pDvlInstallation
	)

Set the lever arm and alignment configuration of the DVL module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	pDvlInstallation	The DVL lever arm and alignment configuration to apply.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 46 of file sbgEComCmdDvl.c.

sbgEComCmdDvlSetModelId()

SbgErrorCode sbgEComCmdDvlSetModelId	(	SbgEComHandle *	pHandle,
		SbgEComDvlModelsIds	modelId
	)

Set the DVL model to use that both defines the protocol as well as the associated error model.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	modelId	DVL model ID to set

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 14 of file sbgEComCmdDvl.c.

sbgEComCmdDvlSetRejection()

SbgErrorCode sbgEComCmdDvlSetRejection	(	SbgEComHandle *	pHandle,
		const SbgEComDvlRejectionConf *	pRejectConf
	)

Set the rejection configuration of the DVL module (this command doesn't need a reboot to be applied)

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pRejectConf	The new DVL rejection configuration to set.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 194 of file sbgEComCmdDvl.c.