QCompassReading

Since: 1.0

#include <QtSensors/QCompassReading>

QtSensors

The QCompassReading class represents one reading from a compass.


Overview

Inheritance

QSensorReading
QCompassReading

Properties Index

qrealazimuth [read-only]
qrealcalibrationLevel [read-only]
QtMobility::qtimestamptimestamp [read-only]Inherited

Public Functions Index

qrealazimuth () const
qrealcalibrationLevel () const
voidsetAzimuth (qreal azimuth)
voidsetCalibrationLevel (qreal calibrationLevel)
voidsetTimestamp (qtimestamp timestamp)Inherited
qtimestamptimestamp () const Inherited
QVariantvalue (int index) const Inherited
intvalueCount () const Inherited

Protected Functions Index

Only has inherited protected functions

virtual voidcopyValuesFrom (QSensorReading *other)Inherited
QScopedPointer< QSensorReadingPrivate > *d_ptr ()Inherited
QSensorReading (QObject *parent, QSensorReadingPrivate *d)Inherited

Properties

qreal azimuth[read-only]

the azimuth of the device.

Measured in degrees from magnetic north in a clockwise direction based the top of the UI.

See also:

{QCompassReading Units}

Since:

1.0

qreal calibrationLevel[read-only]

the calibration level of the reading.

Measured as a value from 0 to 1 with higher values being better.
See also:

{QCompassReading Units}, {http://wiki.forum.nokia.com/index.php/CS001671_-_Calibrating_the_magnetometer_sensor}{CS001671 - Calibrating the magnetometer sensor}

Since:

1.0

QtMobility::qtimestamp timestampInherited[read-only]

the timestamp of the reading.

See also:

qtimestamp

Since:

1.0

,

1.0

Public Functions

qreal azimuth ()

qreal calibrationLevel ()

void setAzimuth (
  • qrealazimuth)

Sets the azimuth of the device.

See also:

{QCompassReading Units}

Since:

1.0

void setCalibrationLevel (
  • qrealcalibrationLevel)

Sets the calibration level of the reading to calibrationLevel.

Since:

1.0

void setTimestamp (Inherited

Sets the timestamp of the reading.

Since:

1.0

qtimestamp timestamp ()Inherited

QVariant value (
  • intindex)
Inherited

Returns the value of the property at index.

Note that this function is slower than calling the data function directly.

Here is an example of getting a property via the different mechanisms available.

Accessing directly provides the best performance but requires compile-time knowledge of the data you are accessing.

QAccelerometerReading *reading = ...;
qreal x = reading->x();

You can also access a property by name. To do this you must call QObject::property().

qreal x = reading->property("x").value<qreal>();

Finally, you can access values via numeric index.

qreal x = reading->value(0).value<qreal>();

Note that value() can only access properties declared with Q_PROPERTY() in sub-classes of QSensorReading.

See also:

valueCount(), QObject::property()

Since:

1.0

int valueCount ()Inherited

Returns the number of extra properties that the reading has.

Note that this does not count properties declared in QSensorReading.

As an example, this returns 3 for QAccelerometerReading because there are 3 properties defined in that class.
Since:

1.0

Protected Functions

(Only has inherited protected functions)

virtual void copyValuesFrom (Inherited

QScopedPointer< QSensorReadingPrivate > * d_ptr ()Inherited

QSensorReading (
  • QObject *parent,
  • QSensorReadingPrivate *d )
Inherited

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus