| 1 | /**************************************************************************** |
| 2 | ** |
| 3 | ** Copyright (C) 2016 Research In Motion |
| 4 | ** Contact: https://www.qt.io/licensing/ |
| 5 | ** |
| 6 | ** This file is part of the QtSensors module of the Qt Toolkit. |
| 7 | ** |
| 8 | ** $QT_BEGIN_LICENSE:LGPL$ |
| 9 | ** Commercial License Usage |
| 10 | ** Licensees holding valid commercial Qt licenses may use this file in |
| 11 | ** accordance with the commercial license agreement provided with the |
| 12 | ** Software or, alternatively, in accordance with the terms contained in |
| 13 | ** a written agreement between you and The Qt Company. For licensing terms |
| 14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
| 15 | ** information use the contact form at https://www.qt.io/contact-us. |
| 16 | ** |
| 17 | ** GNU Lesser General Public License Usage |
| 18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
| 19 | ** General Public License version 3 as published by the Free Software |
| 20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| 21 | ** packaging of this file. Please review the following information to |
| 22 | ** ensure the GNU Lesser General Public License version 3 requirements |
| 23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| 24 | ** |
| 25 | ** GNU General Public License Usage |
| 26 | ** Alternatively, this file may be used under the terms of the GNU |
| 27 | ** General Public License version 2.0 or (at your option) the GNU General |
| 28 | ** Public license version 3 or any later version approved by the KDE Free |
| 29 | ** Qt Foundation. The licenses are as published by the Free Software |
| 30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| 31 | ** included in the packaging of this file. Please review the following |
| 32 | ** information to ensure the GNU General Public License requirements will |
| 33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| 34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
| 35 | ** |
| 36 | ** $QT_END_LICENSE$ |
| 37 | ** |
| 38 | ****************************************************************************/ |
| 39 | #include <qambienttemperaturesensor.h> |
| 40 | #include "qambienttemperaturesensor_p.h" |
| 41 | |
| 42 | QT_BEGIN_NAMESPACE |
| 43 | |
| 44 | IMPLEMENT_READING(QAmbientTemperatureReading) |
| 45 | |
| 46 | /*! |
| 47 | \class QAmbientTemperatureReading |
| 48 | \ingroup sensors_reading |
| 49 | \inmodule QtSensors |
| 50 | \since 5.1 |
| 51 | |
| 52 | \brief The QAmbientTemperatureReading class holds readings of the ambient temperature. |
| 53 | |
| 54 | The ambient (room) temperature is the temperature in degree Celsius. |
| 55 | */ |
| 56 | |
| 57 | /*! |
| 58 | \property QAmbientTemperatureReading::temperature |
| 59 | \brief The ambient temperature |
| 60 | |
| 61 | Measured in degree Celsius. |
| 62 | */ |
| 63 | |
| 64 | qreal QAmbientTemperatureReading::temperature() const |
| 65 | { |
| 66 | return d->temperature; |
| 67 | } |
| 68 | |
| 69 | /*! |
| 70 | Sets ambient temperature to \a temperature. |
| 71 | */ |
| 72 | void QAmbientTemperatureReading::setTemperature(qreal temperature) |
| 73 | { |
| 74 | d->temperature = temperature; |
| 75 | } |
| 76 | |
| 77 | // ===================================================================== |
| 78 | |
| 79 | /*! |
| 80 | \class QAmbientTemperatureFilter |
| 81 | \ingroup sensors_filter |
| 82 | \inmodule QtSensors |
| 83 | \since 5.1 |
| 84 | |
| 85 | \brief The QAmbientTemperatureFilter class is a convenience wrapper around QSensorFilter. |
| 86 | |
| 87 | The only difference is that the filter() method features a pointer to QAmbientTemperatureReading |
| 88 | instead of QSensorReading. |
| 89 | */ |
| 90 | |
| 91 | /*! |
| 92 | \fn QAmbientTemperatureFilter::filter(QAmbientTemperatureReading *reading) |
| 93 | |
| 94 | Called when \a reading changes. Returns false to prevent the reading from propagating. |
| 95 | |
| 96 | \sa QSensorFilter::filter() |
| 97 | */ |
| 98 | |
| 99 | bool QAmbientTemperatureFilter::filter(QSensorReading *reading) |
| 100 | { |
| 101 | return filter(reading: static_cast<QAmbientTemperatureReading*>(reading)); |
| 102 | } |
| 103 | |
| 104 | char const * const QAmbientTemperatureSensor::type("QAmbientTemperatureSensor" ); |
| 105 | |
| 106 | /*! |
| 107 | \class QAmbientTemperatureSensor |
| 108 | \ingroup sensors_type |
| 109 | \inmodule QtSensors |
| 110 | \since 5.1 |
| 111 | |
| 112 | \brief The QAmbientTemperatureSensor class is a convenience wrapper around QSensor. |
| 113 | |
| 114 | The only behavioural difference is that this class sets the type properly. |
| 115 | |
| 116 | This class also features a reading() function that returns a QAmbientTemperatureReading instead of a QSensorReading. |
| 117 | |
| 118 | For details about how the sensor works, see \l QAmbientTemperatureReading. |
| 119 | |
| 120 | \sa QAmbientTemperatureReading |
| 121 | */ |
| 122 | |
| 123 | /*! |
| 124 | Construct the sensor as a child of \a parent. |
| 125 | */ |
| 126 | QAmbientTemperatureSensor::QAmbientTemperatureSensor(QObject *parent) |
| 127 | : QSensor(QAmbientTemperatureSensor::type, parent) |
| 128 | { |
| 129 | } |
| 130 | |
| 131 | /*! |
| 132 | Destroy the sensor. Stops the sensor if it has not already been stopped. |
| 133 | */ |
| 134 | QAmbientTemperatureSensor::~QAmbientTemperatureSensor() |
| 135 | { |
| 136 | } |
| 137 | |
| 138 | /*! |
| 139 | \fn QAmbientTemperatureSensor::reading() const |
| 140 | |
| 141 | Returns the reading class for this sensor. |
| 142 | |
| 143 | \sa QSensor::reading() |
| 144 | */ |
| 145 | |
| 146 | QAmbientTemperatureReading *QAmbientTemperatureSensor::reading() const |
| 147 | { |
| 148 | return static_cast<QAmbientTemperatureReading*>(QSensor::reading()); |
| 149 | } |
| 150 | |
| 151 | QT_END_NAMESPACE |
| 152 | |
| 153 | #include "moc_qambienttemperaturesensor.cpp" |
| 154 | |