Gazebo Sim

API Reference

8.7.0
Magnetometer Class Reference

A class that handles magnetometer changes. More...

#include <Magnetometer.hh>

Public Member Functions

 Magnetometer (ComponentInspectorEditor *_inspector)
 Constructor. More...
 
Q_INVOKABLE void OnMagnetometerXNoise (double _mean, double _meanBias, double _stdDev, double _stdDevBias, double _dynamicBiasStdDev, double _dynamicBiasCorrelationTime)
 This function is called when a user changes values in the x noise elements. More...
 
Q_INVOKABLE void OnMagnetometerYNoise (double _mean, double _meanBias, double _stdDev, double _stdDevBias, double _dynamicBiasStdDev, double _dynamicBiasCorrelationTime)
 This function is called when a user changes values in the y noise elements. More...
 
Q_INVOKABLE void OnMagnetometerZNoise (double _mean, double _meanBias, double _stdDev, double _stdDevBias, double _dynamicBiasStdDev, double _dynamicBiasCorrelationTime)
 This function is called when a user changes values in the z noise elements. More...
 

Detailed Description

A class that handles magnetometer changes.

Constructor & Destructor Documentation

◆ Magnetometer()

Magnetometer ( ComponentInspectorEditor *  _inspector)
explicit

Constructor.

Parameters
[in]_inspectorThe component inspector.

Member Function Documentation

◆ OnMagnetometerXNoise()

Q_INVOKABLE void OnMagnetometerXNoise ( double  _mean,
double  _meanBias,
double  _stdDev,
double  _stdDevBias,
double  _dynamicBiasStdDev,
double  _dynamicBiasCorrelationTime 
)

This function is called when a user changes values in the x noise elements.

Parameters
[in]_meanMean value
[in]_meanBiasBias mean value
[in]_stdDevStandard deviation value
[in]_stdDevBiasBias standard deviation value
[in]_dynamicBiasStdDevDynamic bias standard deviation value
[in]_dynamicBiasCorrelationTimeDynamic bias correlation time value

◆ OnMagnetometerYNoise()

Q_INVOKABLE void OnMagnetometerYNoise ( double  _mean,
double  _meanBias,
double  _stdDev,
double  _stdDevBias,
double  _dynamicBiasStdDev,
double  _dynamicBiasCorrelationTime 
)

This function is called when a user changes values in the y noise elements.

Parameters
[in]_meanMean value
[in]_meanBiasBias mean value
[in]_stdDevStandard deviation value
[in]_stdDevBiasBias standard deviation value
[in]_dynamicBiasStdDevDynamic bias standard deviation value
[in]_dynamicBiasCorrelationTimeDynamic bias correlation time value

◆ OnMagnetometerZNoise()

Q_INVOKABLE void OnMagnetometerZNoise ( double  _mean,
double  _meanBias,
double  _stdDev,
double  _stdDevBias,
double  _dynamicBiasStdDev,
double  _dynamicBiasCorrelationTime 
)

This function is called when a user changes values in the z noise elements.

Parameters
[in]_meanMean value
[in]_meanBiasBias mean value
[in]_stdDevStandard deviation value
[in]_stdDevBiasBias standard deviation value
[in]_dynamicBiasStdDevDynamic bias standard deviation value
[in]_dynamicBiasCorrelationTimeDynamic bias correlation time value

The documentation for this class was generated from the following file: