W3cubDocs

/Qt

QMagnetometer Class

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

Header: #include <QMagnetometer>
CMake: find_package(Qt6 COMPONENTS Sensors REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Sensors)
qmake: QT += sensors
Since: Qt 5.1
Inherits: QSensor

Properties

Public Functions

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

Signals

void returnGeoValuesChanged(bool returnGeoValues)

Detailed Description

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().

Access functions:

bool returnGeoValues() const
void setReturnGeoValues(bool returnGeoValues)

Notifier signal:

void returnGeoValuesChanged(bool returnGeoValues)

Member Function Documentation

QMagnetometer::QMagnetometer(QObject *parent = nullptr)

Construct the sensor as a child of parent.

[virtual] QMagnetometer::~QMagnetometer()

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

QMagnetometerReading *QMagnetometer::reading() const

Returns the reading class for this sensor.

See also QSensor::reading().

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qmagnetometer.html