diff options
| -rw-r--r-- | src/sensors/qirproximitysensor.cpp | 150 | ||||
| -rw-r--r-- | src/sensors/qirproximitysensor.h | 78 | ||||
| -rw-r--r-- | src/sensors/qirproximitysensor_p.h | 74 | ||||
| -rw-r--r-- | src/sensors/sensors.pro | 1 |
4 files changed, 303 insertions, 0 deletions
diff --git a/src/sensors/qirproximitysensor.cpp b/src/sensors/qirproximitysensor.cpp new file mode 100644 index 00000000..23182548 --- /dev/null +++ b/src/sensors/qirproximitysensor.cpp @@ -0,0 +1,150 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtSensors middleware. +** +** $QT_BEGIN_LICENSE:LGPL$ +** GNU Lesser General Public License Usage +** This file may be used under the terms of the GNU Lesser General Public +** License version 2.1 as published by the Free Software Foundation and +** appearing in the file LICENSE.LGPL included in the packaging of this +** file. Please review the following information to ensure the GNU Lesser +** General Public License version 2.1 requirements will be met: +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include <qirproximitysensor.h> +#include "qirproximitysensor_p.h" + +IMPLEMENT_READING(QIRProximityReading) + +/* + \class QIRProximityReading + \ingroup sensors_reading + \inmodule QtSensors + + \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 percentage. That is, 0 indicates nothing was detected + within the range of the sensor and 100 indicates the infra-red signal returned at the full + power level that it was sent at. +*/ + +/* + \property QIRProximityReading::reflectance + \brief Holds the reflectance value. + + The reflectance is a percentage (from 0 to 100) 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 + + \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() +*/ + +char const * const QIRProximitySensor::type("QIRProximitySensor"); + +/* + \class QIRProximitySensor + \ingroup sensors_type + \inmodule QtSensors + + \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 +*/ + +/* + \fn QIRProximitySensor::QIRProximitySensor(QObject *parent) + + Construct the sensor as a child of \a parent. +*/ + +/* + \fn QIRProximitySensor::~QIRProximitySensor() + + Destroy the sensor. Stops the sensor if it has not already been stopped. +*/ + +/* + \fn QIRProximitySensor::reading() const + + Returns the reading class for this sensor. + + \sa QSensor::reading() +*/ + + +#include "moc_qirproximitysensor.cpp" diff --git a/src/sensors/qirproximitysensor.h b/src/sensors/qirproximitysensor.h new file mode 100644 index 00000000..9b81c7e3 --- /dev/null +++ b/src/sensors/qirproximitysensor.h @@ -0,0 +1,78 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtSensors middleware. +** +** $QT_BEGIN_LICENSE:LGPL$ +** GNU Lesser General Public License Usage +** This file may be used under the terms of the GNU Lesser General Public +** License version 2.1 as published by the Free Software Foundation and +** appearing in the file LICENSE.LGPL included in the packaging of this +** file. Please review the following information to ensure the GNU Lesser +** General Public License version 2.1 requirements will be met: +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef QIRPROXIMITYSENSOR_H +#define QIRPROXIMITYSENSOR_H + +#include "qsensor.h" + +class QIRProximityReadingPrivate; + +class Q_SENSORS_EXPORT QIRProximityReading : public QSensorReading +{ + Q_OBJECT + Q_PROPERTY(qreal reflectance READ reflectance) + DECLARE_READING(QIRProximityReading) +public: + qreal reflectance() const; + void setReflectance(qreal reflectance); +}; + +class Q_SENSORS_EXPORT QIRProximityFilter : public QSensorFilter +{ +public: + virtual bool filter(QIRProximityReading *reading) = 0; +private: + bool filter(QSensorReading *reading) { return filter(static_cast<QIRProximityReading*>(reading)); } +}; + +class Q_SENSORS_EXPORT QIRProximitySensor : public QSensor +{ + Q_OBJECT +public: + explicit QIRProximitySensor(QObject *parent = 0) : QSensor(QIRProximitySensor::type, parent) {} + virtual ~QIRProximitySensor() {} + QIRProximityReading *reading() const { return static_cast<QIRProximityReading*>(QSensor::reading()); } + static char const * const type; +}; + +#endif + diff --git a/src/sensors/qirproximitysensor_p.h b/src/sensors/qirproximitysensor_p.h new file mode 100644 index 00000000..23823cdf --- /dev/null +++ b/src/sensors/qirproximitysensor_p.h @@ -0,0 +1,74 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtSensors middleware. +** +** $QT_BEGIN_LICENSE:LGPL$ +** GNU Lesser General Public License Usage +** This file may be used under the terms of the GNU Lesser General Public +** License version 2.1 as published by the Free Software Foundation and +** appearing in the file LICENSE.LGPL included in the packaging of this +** file. Please review the following information to ensure the GNU Lesser +** General Public License version 2.1 requirements will be met: +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef QIRPROXIMITYSENSOR_P_H +#define QIRPROXIMITYSENSOR_P_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +class QIRProximityReadingPrivate +{ +public: + QIRProximityReadingPrivate() + : reflectance(0) + { + } + + + + /* + * Note that this class is copied so you may need to implement + * a copy constructor if you have complex types or pointers + * as values. + */ + qreal reflectance; +}; + +#endif diff --git a/src/sensors/sensors.pro b/src/sensors/sensors.pro index c04354d3..4646a380 100644 --- a/src/sensors/sensors.pro +++ b/src/sensors/sensors.pro @@ -62,6 +62,7 @@ SENSORS=\ qmagnetometer\ qorientationsensor\ qproximitysensor\ + qirproximitysensor\ qrotationsensor\ qtapsensor\ qgyroscope\ |