QtMobility Reference Documentation

Contents

QMagnetometer Class Reference

The QMagnetometer class is a convenience wrapper around QSensor. More...

 #include <QMagnetometer>

Inherits: QSensor and QOrientableSensorBase.

This class was introduced in Qt Mobility 1.0.

Properties

Public Functions

QMagnetometer ( QObject * parent = 0 )
virtual ~QMagnetometer ()
QMagnetometerReading * reading () const
bool returnGeoValues () const
void setReturnGeoValues ( bool returnGeoValues )

Signals

void returnGeoValuesChanged ( bool returnGeoValues )

Additional Inherited Members

Detailed Description

The QMagnetometer class is a convenience wrapper around QSensor.

The only behavioural difference is that this class sets the type properly.

This class also features a reading() function that returns a QMagnetometerReading instead of a QSensorReading.

For details about how the sensor works, see QMagnetometerReading.

See also QMagnetometerReading.

Property Documentation

returnGeoValues : bool

This property holds a value indicating if geomagnetic values should be returned.

Set to true to return geomagnetic flux density. Set to false (the default) to return raw magnetic flux density.

The property must be set before calling start().

This property was introduced in Qt Mobility 1.0.

Access functions:

bool returnGeoValues () const
void setReturnGeoValues ( bool returnGeoValues )

Notifier signal:

void returnGeoValuesChanged ( bool returnGeoValues )

Member Function Documentation

QMagnetometer::QMagnetometer ( QObject * parent = 0 )

Construct the sensor as a child of parent.

This function was introduced in Qt Mobility 1.0.

QMagnetometer::~QMagnetometer () [virtual]

Destroy the sensor. Stops the sensor if it has not already been stopped.

This function was introduced in Qt Mobility 1.0.

QMagnetometerReading * QMagnetometer::reading () const

Returns the reading class for this sensor.

This function was introduced in Qt Mobility 1.0.

See also QSensor::reading().

void QMagnetometer::returnGeoValuesChanged ( bool returnGeoValues ) [signal]