bma180_calibrate Class Reference

A Class to estimate the sensor biases. More...

#include <bma180_calibrate.h>

List of all members.

Classes

struct  OneCalibDataSet
struct  SensID

Public Member Functions

bool biasverify ()
 bma180_calibrate ()
 Constructor resets calibration status.
bool calibsens_completed ()
 Verifies if calibration has been completed.
bool calibsens_set ()
 Verifies if a calibration sensor ID has been set.
void clearcalibsens ()
 Clears any previously gathered calibration data.
bool get_estbiases (double *, double *, double *)
 Retrieves estimated sensor biases.
bool get_verifiedbiases (double *, double *, double *)
void setcalibsens (struct OneBma180Meas)
 Sets the sensor ID to be calibrated.
bool setdata_bma180 (struct OneBma180Meas)
 Sets data to be used for calibrating the sensor.
bool verification_active ()
 Verifies if the calibration verification has been activated.
bool verification_completed ()
 Verifies if calibration verification has been completed.
 ~bma180_calibrate ()
 Destructor.

Private Attributes

bool bVerification_activated
OneCalibDataSet CalibSensor [2]
short int iActiveDataIndex

Detailed Description

A Class to estimate the sensor biases.

The class handles the calibration of a sensor. It estimates the biases and subsequently performs a verification of the estimated biases

Definition at line 49 of file bma180_calibrate.h.


Constructor & Destructor Documentation

bma180_calibrate::bma180_calibrate (  ) 

Constructor resets calibration status.

Resets sensor calibration ID to undefined and verification mode to inactive

Definition at line 38 of file bma180_calibrate.cpp.

bma180_calibrate::~bma180_calibrate (  ) 

Destructor.

Definition at line 49 of file bma180_calibrate.cpp.


Member Function Documentation

bool bma180_calibrate::biasverify ( void   ) 

Definition at line 184 of file bma180_calibrate.cpp.

bool bma180_calibrate::calibsens_completed (  ) 

Verifies if calibration has been completed.

Returns:
Calibration complete true or false

Definition at line 150 of file bma180_calibrate.cpp.

bool bma180_calibrate::calibsens_set (  ) 

Verifies if a calibration sensor ID has been set.

Returns:
sensor ID set true or false

Definition at line 158 of file bma180_calibrate.cpp.

void bma180_calibrate::clearcalibsens (  ) 

Clears any previously gathered calibration data.

Resets any previously defined calibration data to neutral

Definition at line 140 of file bma180_calibrate.cpp.

bool bma180_calibrate::get_estbiases ( double *  dAccX,
double *  dAccY,
double *  dAccZ 
)

Retrieves estimated sensor biases.

Returns:
sensor ID set true or false

Definition at line 166 of file bma180_calibrate.cpp.

bool bma180_calibrate::get_verifiedbiases ( double *  dAccX,
double *  dAccY,
double *  dAccZ 
)

Definition at line 197 of file bma180_calibrate.cpp.

void bma180_calibrate::setcalibsens ( struct OneBma180Meas  OneMeas  ) 

Sets the sensor ID to be calibrated.

Sets the sensor ID to be calibrated. Whenever calling this method any previously defined sensor will be cleared and the calibration status will be reset

Parameters:
OneMeas contains the ID of the sensor to be calibrated

Definition at line 129 of file bma180_calibrate.cpp.

bool bma180_calibrate::setdata_bma180 ( struct OneBma180Meas  OneMeas  ) 

Sets data to be used for calibrating the sensor.

Verifies if the received data set is from the sensor to be calibrated. If this is given, the data is run through the calibration filter.

Parameters:
OneMeas contains one measurement from a BMA180
Returns:
success when data was used for calibration

Definition at line 52 of file bma180_calibrate.cpp.

bool bma180_calibrate::verification_active (  ) 

Verifies if the calibration verification has been activated.

Verification can only be activated upon successful completion of calibration

Returns:
Verification active true or false

Definition at line 162 of file bma180_calibrate.cpp.

bool bma180_calibrate::verification_completed (  ) 

Verifies if calibration verification has been completed.

Returns:
Verification calibration complete true or false

Definition at line 154 of file bma180_calibrate.cpp.


Member Data Documentation

Definition at line 141 of file bma180_calibrate.h.

Definition at line 139 of file bma180_calibrate.h.

Definition at line 140 of file bma180_calibrate.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator


bma180
Author(s): mil1pal
autogenerated on Fri Jan 11 09:40:58 2013