QIRProximityReading Class

The QIRProximityReading class holds readings from the IR proximity sensor. More...

Header: #include <QIRProximityReading>
qmake: QT += sensors
Since: Qt 5.1
Inherits: QSensorReading


Public Functions

QIRProximityReading(QObject *parent = DECLARE_READING(QIRProximityReading))
virtual ~QIRProximityReading()
qreal reflectance() const
void setReflectance(qreal reflectance)

Reimplemented Public Functions

virtual void copyValuesFrom(QSensorReading *other) override

Static Public Members

const QMetaObject staticMetaObject
  • 9 static public members inherited from QObject

Additional Inherited Members

  • 1 public slot inherited from QObject
  • 2 signals inherited from QObject
  • 9 protected functions inherited from QObject

Detailed Description

The QIRProximityReading class holds readings from the IR proximity sensor.

The IR (infra-red) proximity sensor detects proximity by beaming out infra-red light and detecting how much of the light returns.

The biggest limitation of this technology is that there is no reliable way to turn the reflectance values into distances unless both the item being detected and the ambient conditions are known.

QIRProximityReading Units

The sensor reports reflectance as a decimal fraction in the range of 0 - 1. That is, 0 indicates nothing was detected within the range of the sensor and 1 indicates the infra-red signal returned at the full power level that it was sent at.

With some IR sensors, it is quite uncommon to reach the top and the bottom of the value range, and some parts of the range ends might not be obtainable at all. This is due to the behavior of the sensor hardware. With these sensors, the absolute value of reflectance should never be used directly. Instead, applications should react to the relative change of the reading values. Use QProximitySensor if it is only necessary to check if something is close to the device or not.

Property Documentation

reflectance : const qreal

Holds the reflectance value.

The reflectance is a decimal fraction (from 0 to 1) indicating how much of the transmitted infra-red light was returned.

Access functions:

qreal reflectance() const

See also QIRProximityReading Units.

Member Function Documentation

QIRProximityReading::QIRProximityReading(QObject *parent = DECLARE_READING(QIRProximityReading))

Default constructs an instance of QIRProximityReading.

[virtual] QIRProximityReading::~QIRProximityReading()

Destroys the instance of QIRProximityReading. The destructor is virtual.

[override virtual] void QIRProximityReading::copyValuesFrom(QSensorReading *other)

void QIRProximityReading::setReflectance(qreal reflectance)

Sets the reflectance value to reflectance.

See also reflectance().