QSensor Class Reference
The QSensor class represents a single hardware sensor. More...
#include <QSensor>
Inherited by QAccelerometer, QAmbientLightSensor, QCompass, QMagnetometer, QOrientationSensor, QProximitySensor, QRotationSensor, and QTapSensor.
Properties
Public Functions
Public Slots
Signals
Static Public Members
Related Non-Members
Detailed Description
The QSensor class represents a single hardware sensor.
The life cycle of a sensor is typically:
- Create a sub-class of QSensor on the stack or heap.
- Setup as required by the application.
- Start receiving values.
- Sensor data is used by the application.
- Stop receiving values.
The sensor data is delivered via QSensorData and its sub-classes.
Property Documentation
active : bool
This property holds a value to indicate if the sensor is active.
This is true if the sensor is active (returning values). This is false otherwise.
Access functions:
bool | isActive () const |
void | setActive ( bool active ) |
Notifier signal:
availableDataRates : const QtMobility::qrangelist
This property holds the data rates that the sensor supports.
This is a list of the data rates that the sensor supports. Measured in Hertz.
Entries in the list can represent discrete rates or a continuous range of rates. A discrete rate is noted by having both values the same.
See the sensor_explorer example for an example of how to interpret and use this information.
Access functions:
qrangelist | availableDataRates () const |
See also QSensor::dataRate.
busy : const bool
This property holds a value to indicate if the sensor is busy.
Some sensors may be on the system but unavailable for use. This function will return true if the sensor is busy. You will not be able to start() the sensor.
Note that this function does not return true if you are using the sensor, only if another process is using the sensor.
Access functions:
See also busyChanged().
connectedToBackend : const bool
This property holds a value indicating if the sensor has connected to a backend.
A sensor that has not been connected to a backend cannot do anything useful.
Call the connectToBackend() method to force the sensor to connect to a backend immediately. This is automatically called if you call start() so you only need to do this if you need access to sensor properties (ie. to poll the sensor's meta-data before you use it).
Access functions:
bool | isConnectedToBackend () const |
dataRate : int
This property holds the data rate that the sensor should be run at.
Measured in Hertz.
The data rate is the maximum frequency at which the sensor can detect changes.
Setting this property is not portable and can cause conflicts with other applications. Check with the sensor backend and platform documentation for any policy regarding multiple applications requesting a data rate.
The default value (0) means that the app does not care what the data rate is. Applications should consider using a timer-based poll of the current value or ensure that the code that processes values can run very quickly as the platform may provide updates hundreds of times each second.
This should be set before calling start() because the sensor may not notice changes to this value while it is running.
Note that there is no mechanism to determine the current data rate in use by the platform.
Access functions:
int | dataRate () const |
void | setDataRate ( int rate ) |
See also QSensor::availableDataRates.
description : const QString
This property holds a descriptive string for the sensor.
Access functions:
QString | description () const |
error : const int
This property holds the last error code set on the sensor.
Note that error codes are sensor-specific.
Access functions:
Notifier signal:
outputRange : int
This property holds the output range in use by the sensor.
This value represents the index in the QSensor::outputRanges list to use.
Setting this property is not portable and can cause conflicts with other applications. Check with the sensor backend and platform documentation for any policy regarding multiple applications requesting an output range.
The default value (-1) means that the app does not care what the output range is.
Note that there is no mechanism to determine the current output range in use by the platform.
Access functions:
int | outputRange () const |
void | setOutputRange ( int index ) |
See also QSensor::outputRanges.
outputRanges : const QtMobility::qoutputrangelist
This property holds a list of output ranges the sensor supports.
A sensor may have more than one output range. Typically this is done to give a greater measurement range at the cost of lowering accuracy.
Access functions:
qoutputrangelist | outputRanges () const |
See also QSensor::outputRange.
This property holds the reading class.
The reading class provides access to sensor readings.
Note that this will return 0 until a sensor backend is connected to a backend.
Access functions:
QSensorReading * | reading () const |
Notifier signal:
See also isConnectedToBackend().
sensorid : QByteArray
This property holds the backend identifier for the sensor.
Note that the identifier is filled out automatically when the sensor is connected to a backend. If you want to connect a specific backend, you should call setIdentifier() before connectToBackend().
Access functions:
QByteArray | identifier () const |
void | setIdentifier ( const QByteArray & identifier ) |
type : const QByteArray
This property holds the type of the sensor.
Access functions:
Destroy the sensor. Stops the sensor if it has not already been stopped.
This signal is emitted when the busy state changes. This can be used to grab a sensor when it becomes available.
This signal is emitted when the reading has changed.
Returns a list of all sensor types.
Start retrieving values from the sensor. Returns true if the sensor was started, false otherwise.
Note that the sensor may fail to start for several reasons.
Stop retrieving values from the sensor.
This releases the sensor so that other processes can use it.