Backport QAltimeter from QSensors to qt-mobility.

Change-Id: I59da45e1cf15c706e9cedf0d5273f15f7fd3c920
Reviewed-by: Thomas McGuire <thomas.mcguire@kdab.com>
Reviewed-by: Lorn Potter <lorn.potter@jollamobile.com>

10 files changed, 360 insertions, 38 deletions

diff --git a/plugins/declarative/sensors/sensors.cpp b/plugins/declarative/sensors/sensors.cpp
index 2bc6284c9b..c6146136fb 100644
--- a/plugins/declarative/sensors/sensors.cpp
+++ b/plugins/declarative/sensors/sensors.cpp
@@ -43,6 +43,7 @@
 #include <QtDeclarative/qdeclarative.h>
 
 #include <qaccelerometer.h>
+#include <qaltimeter.h>
 #include <qambientlightsensor.h>
 #include <qcompass.h>
 #include <qmagnetometer.h>
@@ -124,6 +125,8 @@ public:
         qmlRegisterUncreatableType<QSensorReading       >(package, major, minor, "SensorReading",        QLatin1String("Cannot create SensorReading"));
         qmlRegisterType           <QAccelerometer       >(package, major, minor, "Accelerometer");
         qmlRegisterUncreatableType<QAccelerometerReading>(package, major, minor, "AccelerometerReading", QLatin1String("Cannot create AccelerometerReading"));
+        qmlRegisterType           <QAltimeter           >(package, major, minor, "Altimeter");
+        qmlRegisterUncreatableType<QAltimeterReading    >(package, major, minor, "AltimeterReading",     QLatin1String("Cannot create AltimeterReading"));
         qmlRegisterType           <QAmbientLightSensor  >(package, major, minor, "AmbientLightSensor");
         qmlRegisterUncreatableType<QAmbientLightReading >(package, major, minor, "AmbientLightReading",  QLatin1String("Cannot create AmbientLightReading"));
         qmlRegisterType           <QCompass             >(package, major, minor, "Compass");
@@ -321,6 +324,45 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara
 */
 
 /*!
+    \qmlclass Altimeter QAltimeter
+    \ingroup qml-sensors_type
+    \since Mobility 1.3
+    \inherits Sensor
+    \brief The Altimeter element reports on altitude.
+
+    The Altimeter element reports on altitude.
+
+    This element wraps the QAltimeter class. Please see the documentation for
+    QAltimeter for details.
+
+    \sa AltimeterReading
+*/
+
+/*!
+    \qmlclass AltimeterReading QAltimeterReading
+    \ingroup qml-sensors_reading
+    \since Mobility 1.3
+    \inherits SensorReading
+    \brief The AltimeterReading element holds the most recent Altimeter reading.
+
+    The AltimeterReading element holds the most recent Altimeter reading.
+
+    This element wraps the QAltimeterReading class. Please see the documentation for
+    QAltimeterReading for details.
+
+    This element cannot be directly created.
+*/
+
+/*!
+    \qmlproperty qreal AltimeterReading::altitude
+    This property holds the altitude of the device.
+
+    Please see QAltimeterReading::altitude for information about this property.
+
+    \since Mobility 1.3
+*/
+
+/*!
     \qmlclass AmbientLightSensor QAmbientLightSensor
     \ingroup qml-sensors_type
     \since Mobility 1.1
diff --git a/plugins/sensors/blackberry/bbaltimeter.cpp b/plugins/sensors/blackberry/bbaltimeter.cpp
index 3193cc4cdb..f3c3f2be80 100644
--- a/plugins/sensors/blackberry/bbaltimeter.cpp
+++ b/plugins/sensors/blackberry/bbaltimeter.cpp
@@ -40,36 +40,15 @@
 ****************************************************************************/
 #include "bbaltimeter.h"
 
-class BbAltimeterReadingPrivate
-{
-public:
-    BbAltimeterReadingPrivate()
-        : altitude(0)
-    {
-    }
-
-    qreal altitude;
-};
-
-IMPLEMENT_READING(BbAltimeterReading)
-
-qreal BbAltimeterReading::altitude() const
-{
-    return d->altitude;
-}
-
-void BbAltimeterReading::setAltitude(qreal altitude)
-{
-    d->altitude = altitude;
-}
+#include "qaltimeter.h"
 
 BbAltimeter::BbAltimeter(QSensor *sensor)
-    : BbSensorBackend<BbAltimeterReading>(devicePath(), SENSOR_TYPE_ALTIMETER, sensor)
+    : BbSensorBackend<QAltimeterReading>(devicePath(), SENSOR_TYPE_ALTIMETER, sensor)
 {
     setDescription(QLatin1String("Altitude in meters relative to mean sea level"));
 }
 
-bool BbAltimeter::updateReadingFromEvent(const sensor_event_t &event, BbAltimeterReading *reading)
+bool BbAltimeter::updateReadingFromEvent(const sensor_event_t &event, QAltimeterReading *reading)
 {
     reading->setAltitude(event.altitude_s.altitude);
     return true;
diff --git a/plugins/sensors/blackberry/bbaltimeter.h b/plugins/sensors/blackberry/bbaltimeter.h
index c18543941b..7c901ae8b7 100644
--- a/plugins/sensors/blackberry/bbaltimeter.h
+++ b/plugins/sensors/blackberry/bbaltimeter.h
@@ -42,22 +42,12 @@
 #define BBALTIMETER_H
 
 #include "bbsensorbackend.h"
+#include "qaltimeter.h"
 
 QTM_USE_NAMESPACE
 
-class BbAltimeterReadingPrivate;
 
-class BbAltimeterReading : public QSensorReading
-{
-    Q_OBJECT
-    Q_PROPERTY(qreal altitude READ altitude)
-    DECLARE_READING(BbAltimeterReading)
-public:
-    qreal altitude() const;
-    void setAltitude(qreal altitude);
-};
-
-class BbAltimeter : public BbSensorBackend<BbAltimeterReading>
+class BbAltimeter : public BbSensorBackend<QAltimeterReading>
 {
     Q_OBJECT
 
@@ -67,7 +57,7 @@ public:
     static QString devicePath();
 
 protected:
-    bool updateReadingFromEvent(const sensor_event_t &event, BbAltimeterReading *reading);
+    bool updateReadingFromEvent(const sensor_event_t &event, QAltimeterReading *reading);
 };
 
 #endif
diff --git a/plugins/sensors/blackberry/main.cpp b/plugins/sensors/blackberry/main.cpp
index 8ae622d95c..b309d1b415 100644
--- a/plugins/sensors/blackberry/main.cpp
+++ b/plugins/sensors/blackberry/main.cpp
@@ -88,7 +88,7 @@ public:
         if (sensorSupported(BbAccelerometer::devicePath()))
             QSensorManager::registerBackend(QAccelerometer::type, bbAccelerometerId, this);
         if (sensorSupported(BbAltimeter::devicePath()))
-            QSensorManager::registerBackend("BbAltimeter", bbAltitmeterId, this);
+            QSensorManager::registerBackend(QAltimeter::type, bbAltitmeterId, this);
         if (sensorSupported(BbAmbientLightSensor::devicePath()))
             QSensorManager::registerBackend(QAmbientLightSensor::type, bbAmbientLightSensorId, this);
         if (sensorSupported(BbCompass::devicePath()))
diff --git a/src/sensors/qaltimeter.cpp b/src/sensors/qaltimeter.cpp
new file mode 100644
index 0000000000..302b145c92
--- /dev/null
+++ b/src/sensors/qaltimeter.cpp
@@ -0,0 +1,148 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Research In Motion
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Mobility Components.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, 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, Digia gives you certain additional
+** rights.  These rights are described in the Digia 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.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+#include <qaltimeter.h>
+#include "qaltimeter_p.h"
+
+QTM_BEGIN_NAMESPACE
+
+IMPLEMENT_READING(QAltimeterReading)
+
+/*!
+    \class QAltimeterReading
+    \ingroup sensors_reading
+    \inmodule QtSensors
+    \since 1.3
+
+    \brief The QAltimeterReading class holds readings from the altimeter sensor.
+
+    The altitude is reported in meters relative to mean sea level.
+
+    On BlackBerry, the altimeter uses a combination of pressure and location to determine
+    the altitude, as using pressure alone would yield to inaccurate results due to changes
+    in air pressure caused by the weather. The location information is used to compensate for
+    the weather. This requires that the user has enabled location services in the global
+    settings.
+*/
+
+/*!
+    \property QAltimeterReading::altitude
+    \brief The altitude in meters relative to mean sea level.
+*/
+
+qreal QAltimeterReading::altitude() const
+{
+    return d->altitude;
+}
+
+/*!
+    Sets the altitude to \a altitude.
+*/
+void QAltimeterReading::setAltitude(qreal altitude)
+{
+    d->altitude = altitude;
+}
+
+// =====================================================================
+
+/*!
+    \class QAltimeterFilter
+    \ingroup sensors_filter
+    \inmodule QtSensors
+    \since 1.3
+
+    \brief The QAltimeterFilter class is a convenience wrapper around QSensorFilter.
+
+    The only difference is that the filter() method features a pointer to QAltimeterReading
+    instead of QSensorReading.
+*/
+
+/*!
+    \fn QAltimeterFilter::filter(QAltimeterReading *reading)
+
+    Called when \a reading changes. Returns false to prevent the reading from propagating.
+
+    \sa QSensorFilter::filter()
+*/
+
+char const * const QAltimeter::type("QAltimeter");
+
+/*!
+    \class QAltimeter
+    \ingroup sensors_type
+    \inmodule QtSensors
+    \since 1.3
+
+    \brief The QAltimeter 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 QAltimeterReading instead of a QSensorReading.
+
+    For details about how the sensor works, see \l QAltimeterReading.
+
+    \sa QAltimeterReading
+*/
+
+/*!
+    Construct the sensor as a child of \a parent.
+*/
+QAltimeter::QAltimeter(QObject *parent)
+    : QSensor(QAltimeter::type, parent)
+{
+}
+
+/*!
+    Destroy the sensor. Stops the sensor if it has not already been stopped.
+*/
+QAltimeter::~QAltimeter()
+{
+}
+
+/*!
+    \fn QAltimeter::reading() const
+
+    Returns the reading class for this sensor.
+
+    \sa QSensor::reading()
+*/
+
+#include "moc_qaltimeter.cpp"
+QTM_END_NAMESPACE
diff --git a/src/sensors/qaltimeter.h b/src/sensors/qaltimeter.h
new file mode 100644
index 0000000000..aeddc9e83a
--- /dev/null
+++ b/src/sensors/qaltimeter.h
@@ -0,0 +1,84 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Research In Motion
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Mobility Components.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, 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, Digia gives you certain additional
+** rights.  These rights are described in the Digia 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.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+#ifndef QALTIMETER_H
+#define QALTIMETER_H
+
+#include "qsensor.h"
+
+QTM_BEGIN_NAMESPACE
+
+class QAltimeterReadingPrivate;
+
+class Q_SENSORS_EXPORT QAltimeterReading : public QSensorReading
+{
+    Q_OBJECT
+    Q_PROPERTY(qreal altitude READ altitude)
+    DECLARE_READING(QAltimeterReading)
+public:
+    qreal altitude() const;
+    void setAltitude(qreal altitude);
+};
+
+class Q_SENSORS_EXPORT QAltimeterFilter : public QSensorFilter
+{
+public:
+    virtual bool filter(QAltimeterReading *reading) = 0;
+private:
+    bool filter(QSensorReading *reading)
+        { return filter(static_cast<QAltimeterReading*>(reading)); }
+};
+
+class Q_SENSORS_EXPORT QAltimeter : public QSensor
+{
+    Q_OBJECT
+public:
+    explicit QAltimeter(QObject *parent = 0);
+    ~QAltimeter();
+    QAltimeterReading *reading() const { return static_cast<QAltimeterReading*>(QSensor::reading()); }
+    static char const * const type;
+
+private:
+    Q_DISABLE_COPY(QAltimeter)
+};
+
+QTM_END_NAMESPACE
+
+#endif
diff --git a/src/sensors/qaltimeter_p.h b/src/sensors/qaltimeter_p.h
new file mode 100644
index 0000000000..8442cfa5ac
--- /dev/null
+++ b/src/sensors/qaltimeter_p.h
@@ -0,0 +1,70 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Research In Motion
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Mobility Components.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, 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, Digia gives you certain additional
+** rights.  These rights are described in the Digia 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.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+#ifndef QALTIMETER_P_H
+#define QALTIMETER_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.
+//
+
+QTM_BEGIN_NAMESPACE
+
+class QAltimeterReadingPrivate
+{
+public:
+    QAltimeterReadingPrivate()
+        : altitude(0)
+    {
+    }
+
+    qreal altitude;
+};
+
+QTM_END_NAMESPACE
+
+#endif
diff --git a/src/sensors/sensors.pro b/src/sensors/sensors.pro
index 971e160229..8909969ad6 100644
--- a/src/sensors/sensors.pro
+++ b/src/sensors/sensors.pro
@@ -56,6 +56,7 @@ blackberry {
 SENSORS=\
     qsensor\
     qaccelerometer\
+    qaltimeter\
     qambientlightsensor\
     qcompass\
     qholstersensor\
diff --git a/tests/auto/qsensor/test_backends.h b/tests/auto/qsensor/test_backends.h
index ce5e00b0e8..49223f807d 100644
--- a/tests/auto/qsensor/test_backends.h
+++ b/tests/auto/qsensor/test_backends.h
@@ -50,6 +50,7 @@ void register_test_backends();
 void unregister_test_backends();
 
 #include <qaccelerometer.h>
+#include <qaltimeter.h>
 #include <qambientlightsensor.h>
 #include <qcompass.h>
 #include <qgyroscope.h>
@@ -93,6 +94,9 @@ QTM_USE_NAMESPACE
         PREPARE_SENSORINTERFACE_DECLS(SensorClass, ReadingClass, FilterClass, readingcode)
 #endif
 
+PREPARE_SENSORINTERFACE(QAltimeter, QAltimeterReading, QAltimeterFilter, {
+    reading->setAltitude(8848);
+})
 PREPARE_SENSORINTERFACE(QAccelerometer, QAccelerometerReading, QAccelerometerFilter, {
     reading->setX(1.0);
     reading->setY(1.0);
diff --git a/tests/auto/qsensor/tst_qsensor.cpp b/tests/auto/qsensor/tst_qsensor.cpp
index c70135bfb7..8b25c32cf3 100644
--- a/tests/auto/qsensor/tst_qsensor.cpp
+++ b/tests/auto/qsensor/tst_qsensor.cpp
@@ -833,6 +833,10 @@ private slots:
             QCOMPARE(reading->z(), 1.0);
         })
 
+        TEST_SENSORINTERFACE(QAltimeter, QAltimeterReading, {
+            QCOMPARE(reading->altitude(), 8848.0);
+        })
+
         TEST_SENSORINTERFACE(QAmbientLightSensor, QAmbientLightReading, {
             QCOMPARE(reading->lightLevel(), QAmbientLightReading::Twilight);
         })