sbgECom  1.11.920-stable
Data Structures | Typedefs | Enumerations | Functions
sbgEComCmdDvl.h File Reference

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

#include <sbgCommon.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 }
 

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

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.

Typedef Documentation

§ SbgEComDvlModelsIds

This enum defines the different DVL model IDs available in standard

§ SbgEComDvlInstallation

DVL mechanical installation parameters such as lever arm and alignment

§ SbgEComDvlRejectionConf

Holds all necessary information for DVL module data rejection.

Enumeration Type Documentation

§ _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.

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]pHandleA valid sbgECom handle.
[in]modelIdDVL 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]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.

§ 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.

§ 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.

§ 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.

§ 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.