sbgECom
1.11.920-stable
|
This file implements sbgECom commands related to DVL module. More...
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 } |
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) |
This file implements sbgECom commands related to DVL module.
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.
typedef enum _SbgEComDvlModelsIds SbgEComDvlModelsIds |
This enum defines the different DVL model IDs available in standard
typedef struct _SbgEComDvlInstallation SbgEComDvlInstallation |
DVL mechanical installation parameters such as lever arm and alignment
typedef struct _SbgEComDvlRejectionConf SbgEComDvlRejectionConf |
Holds all necessary information for DVL module data rejection.
enum _SbgEComDvlModelsIds |
SbgErrorCode sbgEComCmdDvlSetModelId | ( | SbgEComHandle * | pHandle, |
SbgEComDvlModelsIds | modelId | ||
) |
Set the DVL model to use that both defines the protocol as well as the associated error model.
[in] | pHandle | A valid sbgECom handle. |
[in] | modelId | DVL model ID to set |
SbgErrorCode sbgEComCmdDvlGetModelId | ( | SbgEComHandle * | pHandle, |
SbgEComDvlModelsIds * | pModelId | ||
) |
Retrieve the DVL model id currently in use by the device.
[in] | pHandle | A valid sbgECom handle. |
[out] | pModelId | Returns the DVL model ID currently in use by the device. |
SbgErrorCode sbgEComCmdDvlInstallationSet | ( | SbgEComHandle * | pHandle, |
const SbgEComDvlInstallation * | pDvlInstallation | ||
) |
Set the lever arm and alignment configuration of the DVL module.
[in] | pHandle | A valid sbgECom handle. |
[in] | pDvlInstallation | The DVL lever arm and alignment configuration to apply. |
SbgErrorCode sbgEComCmdDvlInstallationGet | ( | SbgEComHandle * | pHandle, |
SbgEComDvlInstallation * | pDvlInstallation | ||
) |
Retrieve the lever arm and alignment configuration of the DVL module.
[in] | pHandle | A valid sbgECom handle. |
[out] | pDvlInstallation | Returns the DVL lever arm and alignment configuration currently in use. |
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)
[in] | pHandle | A valid sbgECom handle. |
[out] | pRejectConf | The new DVL rejection configuration to set. |
SbgErrorCode sbgEComCmdDvlGetRejection | ( | SbgEComHandle * | pHandle, |
SbgEComDvlRejectionConf * | pRejectConf | ||
) |
Retrieve the current rejection configuration of the DVL module.
[in] | pHandle | A valid sbgECom handle. |
[out] | pRejectConf | Return the DVL rejection configuration currently in use. |