sbgEComCmdOdo.h File Reference

This file implements SbgECom commands related to Odometer module. More...

#include "sbgEComCmdCommon.h"

Include dependency graph for sbgEComCmdOdo.h:

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

Go to the source code of this file.

Classes
struct	_SbgEComOdoConf
struct	_SbgEComOdoRejectionConf

Typedefs
typedef struct _SbgEComOdoConf	SbgEComOdoConf
typedef struct _SbgEComOdoRejectionConf	SbgEComOdoRejectionConf

Functions
SbgErrorCode	sbgEComCmdOdoGetConf (SbgEComHandle *pHandle, SbgEComOdoConf *pOdometerConf)
SbgErrorCode	sbgEComCmdOdoGetLeverArm (SbgEComHandle *pHandle, float leverArm[3])
SbgErrorCode	sbgEComCmdOdoGetRejection (SbgEComHandle *pHandle, SbgEComOdoRejectionConf *pRejectConf)
SbgErrorCode	sbgEComCmdOdoSetConf (SbgEComHandle *pHandle, const SbgEComOdoConf *pOdometerConf)
SbgErrorCode	sbgEComCmdOdoSetLeverArm (SbgEComHandle *pHandle, const float leverArm[3])
SbgErrorCode	sbgEComCmdOdoSetRejection (SbgEComHandle *pHandle, const SbgEComOdoRejectionConf *pRejectConf)

Detailed Description

This file implements SbgECom commands related to Odometer module.

Author

SBG Systems (Maxime Renaudet)

Date

11 June 2014

Copyright Notice

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

Typedef Documentation

typedef struct _SbgEComOdoConf SbgEComOdoConf

Holds all necessary information for Odometer module parameter configuration.

typedef struct _SbgEComOdoRejectionConf SbgEComOdoRejectionConf

Holds all necessary information for Odometer module data rejection.

Function Documentation

SbgErrorCode sbgEComCmdOdoGetConf	(	SbgEComHandle *	pHandle,
		SbgEComOdoConf *	pOdometerConf
	)

Retrieve the odometer module configuration.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pOdometerConf	Pointer to a SbgEComOdoConf struct to hold configuration of the odometer module.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 14 of file sbgEComCmdOdo.c.

SbgErrorCode sbgEComCmdOdoGetLeverArm	(	SbgEComHandle *	pHandle,
		float	leverArm[3]
	)

Retrieve the odometer lever arms.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	leverArm	Array of three values, one for each axis.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 177 of file sbgEComCmdOdo.c.

SbgErrorCode sbgEComCmdOdoGetRejection	(	SbgEComHandle *	pHandle,
		SbgEComOdoRejectionConf *	pRejectConf
	)

Retrieve the rejection configuration of the odometer module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pRejectConf	Pointer to a SbgEComOdoRejectionConf struct to hold rejection configuration of the odometer module.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 340 of file sbgEComCmdOdo.c.

SbgErrorCode sbgEComCmdOdoSetConf	(	SbgEComHandle *	pHandle,
		const SbgEComOdoConf *	pOdometerConf
	)

Set the odometer module configuration.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	pOdometerConf	Pointer to a SbgEComOdoConf struct holding configuration for the odometer module.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 96 of file sbgEComCmdOdo.c.

SbgErrorCode sbgEComCmdOdoSetLeverArm	(	SbgEComHandle *	pHandle,
		const float	leverArm[3]
	)

Set the odometer lever arms.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	leverArm	Array of three values, one for each axis.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 259 of file sbgEComCmdOdo.c.

SbgErrorCode sbgEComCmdOdoSetRejection	(	SbgEComHandle *	pHandle,
		const SbgEComOdoRejectionConf *	pRejectConf
	)

Set the rejection configuration of the odometer module.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	pRejectConf	Pointer to a SbgEComOdoRejectionConf struct holding rejection configuration for the odometer module.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 420 of file sbgEComCmdOdo.c.