Home · All Classes · All Functions ·

QMagnetometerReading Class Reference

The QMagnetometerReading class represents one reading from the magnetometer. More...

    #include <QMagnetometerReading>

This class is under development and is subject to change.

Inherits QSensorReading.


Public Types

enum CalibrationLevel { Undefined, Low, Middle, High }

Properties

  • x : const qreal
  • y : const qreal
  • z : const qreal


Public Functions

qreal calibrated_x () const
qreal calibrated_y () const
qreal calibrated_z () const
CalibrationLevel calibrationLevel () const
void setCalibrated_x ( qreal calibrated_x )
void setCalibrated_y ( qreal calibrated_y )
void setCalibrated_z ( qreal calibrated_z )
void setCalibrationLevel ( CalibrationLevel calibrationLevel )
void setX ( qreal x )
void setY ( qreal y )
void setZ ( qreal z )
qreal x () const
qreal y () const
qreal z () const

Additional Inherited Members


Detailed Description

The QMagnetometerReading class represents one reading from the magnetometer.

The magnetometer returns magnetic flux density values along 3 axes. The scale of the values is teslas. The axes are arranged as follows.

             +z
              |
              |      +y
              |     /
              |----/----
             /| NOKIA  /|
            //|--/--- / |
           // | /   //  /
          //  |/   //  /
         //   '--------------- +x
        //       //  /
       //       //  /
      /---------/  /
     /    O    /  /
    /         /  /
    ----------  /
    |_________!/

Member Type Documentation

enum QMagnetometerReading::CalibrationLevel

ConstantValueDescription
QMagnetometerReading::Undefined0The calibration level is not defined or is too low.
QMagnetometerReading::Low1The calibrated values may be inaccurate by up to 3 micro Teslas.
QMagnetometerReading::Middle2The calibrated values may be inaccurate by up to 2 micro Teslas.
QMagnetometerReading::High3The calibrated values may be inaccurate by up to 1 micro Tesla.


Property Documentation

calibrated_x : const qreal

This property holds the calibrated flux density on the X axis.

Access functions:

qreal calibrated_x () const

calibrated_y : const qreal

This property holds the calibrated flux density on the Y axis.

Access functions:

qreal calibrated_y () const

calibrated_z : const qreal

This property holds the calibrated flux density on the Z axis.

Access functions:

qreal calibrated_z () const

calibrationLevel : const CalibrationLevel

This property holds the calibration level of the reading.

The higher the calibration, the more accurate the measurement is.

Access functions:

CalibrationLevel calibrationLevel () const

x : const qreal

This property holds the raw flux density on the X axis.

Access functions:

qreal x () const

y : const qreal

This property holds the raw flux density on the Y axis.

Access functions:

qreal y () const

z : const qreal

This property holds the raw flux density on the Z axis.

Access functions:

qreal z () const

Member Function Documentation

void QMagnetometerReading::setCalibrated_x ( qreal calibrated_x )

Sets the calibrated flux density on the X axis to calibrated_x.

See also calibrated_x().

void QMagnetometerReading::setCalibrated_y ( qreal calibrated_y )

Sets the calibrated flux density on the Y axis to calibrated_y.

See also calibrated_y().

void QMagnetometerReading::setCalibrated_z ( qreal calibrated_z )

Sets the calibrated flux density on the Z axis to calibrated_z.

See also calibrated_z().

void QMagnetometerReading::setCalibrationLevel ( CalibrationLevel calibrationLevel )

Sets the calibration level of the reading to calibrationLevel.

See also calibrationLevel().

void QMagnetometerReading::setX ( qreal x )

Sets the raw flux density on the X axis to x.

See also x().

void QMagnetometerReading::setY ( qreal y )

Sets the raw flux density on the Y axis to y.

See also y().

void QMagnetometerReading::setZ ( qreal z )

Sets the raw flux density on the Z axis to z.

See also z().


Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.0.0