Functions
sbgEComCmdDvl.c File Reference
#include <streamBuffer/sbgStreamBuffer.h>
#include "transfer/sbgEComTransfer.h"
#include "sbgEComCmdDvl.h"
Include dependency graph for sbgEComCmdDvl.c:

Go to the source code of this file.

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)
 

Function Documentation

◆ sbgEComCmdDvlGetModelId()

SbgErrorCode sbgEComCmdDvlGetModelId ( SbgEComHandle pHandle,
SbgEComDvlModelsIds pModelId 
)

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

Parameters
[in]pHandleA valid sbgECom handle.
[out]pModelIdReturns 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]pHandleA valid sbgECom handle.
[out]pRejectConfReturn 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]pHandleA valid sbgECom handle.
[out]pDvlInstallationReturns 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]pHandleA valid sbgECom handle.
[in]pDvlInstallationThe 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]pHandleA valid sbgECom handle.
[in]modelIdDVL 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]pHandleA valid sbgECom handle.
[out]pRejectConfThe 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.



sbg_driver
Author(s): SBG Systems
autogenerated on Sat Sep 3 2022 02:53:36