Revision control
++ // Copyright (C) 2016 The Qt Company Ltd.
++ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
++ // Qt-Security score:significant reason:default
++
++ #include <qirproximitysensor.h>
++ #include "qirproximitysensor_p.h"
++
++ QT_BEGIN_NAMESPACE
++
++ IMPLEMENT_READING(QIRProximityReading)
++
++ /*!
++ \class QIRProximityReading
++ \ingroup sensors_reading
++ \inmodule QtSensors
++ \since 5.1
++ \internal
++
++ \brief 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.
++
++ \section2 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 QIRProximityReading::reflectance
++ \brief 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.
++
++ \sa {QIRProximityReading Units}
++ */
++ qreal QIRProximityReading::reflectance() const
++ {
++ return d->reflectance;
++ }
++
++ /*!
++ Sets the reflectance value to \a reflectance.
++ */
++ void QIRProximityReading::setReflectance(qreal reflectance)
++ {
++ d->reflectance = reflectance;
++ }
++
++ // =====================================================================
++
++ /*!
++ \class QIRProximityFilter
++ \ingroup sensors_filter
++ \inmodule QtSensors
++ \since 5.1
++ \internal
++
++ \brief The QIRProximityFilter class is a convenience wrapper around QSensorFilter.
++
++ The only difference is that the filter() method features a pointer to QIRProximityReading
++ instead of QSensorReading.
++ */
++
++ /*!
++ \fn QIRProximityFilter::filter(QIRProximityReading *reading)
++
++ Called when \a reading changes. Returns false to prevent the reading from propagating.
++
++ \sa QSensorFilter::filter()
++ */
++
++ bool QIRProximityFilter::filter(QSensorReading *reading)
++ {
++ return filter(static_cast<QIRProximityReading*>(reading));
++ }
++
++ char const * const QIRProximitySensor::sensorType("QIRProximitySensor");
++
++ /*!
++ \class QIRProximitySensor
++ \ingroup sensors_type
++ \inmodule QtSensors
++ \since 5.1
++ \internal
++
++ \brief The QIRProximitySensor 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 QIRProximityReading instead of a QSensorReading.
++
++ For details about how the sensor works, see \l QIRProximityReading.
++
++ \sa QIRProximityReading
++ */
++
++ /*!
++ Construct the sensor as a child of \a parent.
++ */
++ QIRProximitySensor::QIRProximitySensor(QObject *parent)
++ : QSensor(QIRProximitySensor::sensorType, parent)
++ {
++ }
++
++ /*!
++ Destroy the sensor. Stops the sensor if it has not already been stopped.
++ */
++ QIRProximitySensor::~QIRProximitySensor()
++ {
++ }
++
++ /*!
++ \fn QIRProximitySensor::reading() const
++
++ Returns the reading class for this sensor.
++
++ \sa QSensor::reading()
++ */
++
++ QIRProximityReading *QIRProximitySensor::reading() const
++ {
++ return static_cast<QIRProximityReading*>(QSensor::reading());
++ }
++
++ QT_END_NAMESPACE
++ #include "moc_qirproximitysensor.cpp"