sbgEComCmdDvl.h File Reference

DVL (Doppler Velocity Logger) aiding module configuration commands. More...

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

Go to the source code of this file.

Data Structures
struct	_SbgEComDvlInstallation
struct	_SbgEComDvlRejectionConf

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

Enumerations
enum	_SbgEComDvlModelsIds {   SBG_ECOM_DVL_MODEL_GENERIC_PD6 = 202 ,   SBG_ECOM_DVL_MODEL_WAYFINDER = 203 }

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

Detailed Description

DVL (Doppler Velocity Logger) aiding module configuration commands.

Author

SBG Systems

Date

13 December 2018

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

SbgEComDvlModelsIds

typedef enum _SbgEComDvlModelsIds SbgEComDvlModelsIds

This enum defines the different DVL model IDs available in standard

SbgEComDvlInstallation

typedef struct _SbgEComDvlInstallation SbgEComDvlInstallation

DVL mechanical installation parameters such as lever arm and alignment

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.
SBG_ECOM_DVL_MODEL_WAYFINDER	Teledyne Wayfinder DVL using proprietary protocol.

Function Documentation

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.

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.

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.

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.

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.

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.