1/****************************************************************************
2**
3** Copyright (C) 2016 Canonical Ltd
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
40#include <qhumiditysensor.h>
41#include "qhumiditysensor_p.h"
42
43QT_BEGIN_NAMESPACE
44
45IMPLEMENT_READING(QHumidityReading)
46
47/*!
48 \class QHumidityReading
49 \ingroup sensors_reading
50 \inmodule QtSensors
51 \since 5.9
52
53 \brief The QHumidityReading class holds readings from the humidity sensor.
54
55 \section2 QHumidityReading Units
56
57 The humidity sensor returns the relative humidity as a percentage, and absolute humidity in
58 grams per cubic meter (g/m3).
59 Note that some sensors may not support absolute humidity, 0 will be returned in this case.
60*/
61
62/*!
63 \property QHumidityReading::relativeHumidity
64 \brief Relative humidity
65 Returned as a percentage.
66
67 \sa {QHumidityReading Units}
68*/
69
70qreal QHumidityReading::relativeHumidity() const
71{
72 return d->relativeHumidity;
73}
74
75/*!
76 Sets relativeHumidity to \a humidity.
77*/
78void QHumidityReading::setRelativeHumidity(qreal humidity)
79{
80 d->relativeHumidity = humidity;
81}
82
83/*!
84 \property QHumidityReading::absoluteHumidity
85 \brief Absolute humidity
86 Measured in grams per cubic meter.
87 Note that some sensors may not support absolute humidity.
88
89 \sa {QHumidityReading Units}
90*/
91
92qreal QHumidityReading::absoluteHumidity() const
93{
94 return d->absoluteHumidity;
95}
96
97/*!
98 Sets absoluteHumidity to \a value.
99*/
100void QHumidityReading::setAbsoluteHumidity(qreal value)
101{
102 d->absoluteHumidity = value;
103}
104
105// =====================================================================
106
107/*!
108 \class QHumidityFilter
109 \ingroup sensors_filter
110 \inmodule QtSensors
111 \since 5.9
112
113 \brief The QHumidityFilter class is a convenience wrapper around QSensorFilter.
114
115 The only difference is that the filter() method features a pointer to QHumidityReading
116 instead of QSensorReading.
117*/
118
119/*!
120 \fn QHumidityFilter::filter(QHumidityReading *reading)
121
122 Called when \a reading changes. Returns false to prevent the reading from propagating.
123
124 \sa QSensorFilter::filter()
125*/
126
127bool QHumidityFilter::filter(QSensorReading *reading)
128{
129 return filter(reading: static_cast<QHumidityReading*>(reading));
130}
131
132char const * const QHumiditySensor::type("QHumiditySensor");
133
134
135/*!
136 \class QHumiditySensor
137 \ingroup sensors_type
138 \inmodule QtSensors
139 \since 5.9
140
141 \brief The QHumiditySensor class is a convenience wrapper around QSensor.
142
143 The only behavioural difference is that this class sets the type properly.
144
145 This class also features a reading() function that returns a QHumidityReading instead of a QSensorReading.
146
147 For details about how the sensor works, see \l QHumidityReading.
148
149 \sa QHumidityReading
150*/
151
152/*!
153 Construct the sensor as a child of \a parent.
154*/
155QHumiditySensor::QHumiditySensor(QObject *parent)
156 : QSensor(QHumiditySensor::type, parent)
157{
158}
159
160/*!
161 Destroy the sensor. Stops the sensor if it has not already been stopped.
162*/
163QHumiditySensor::~QHumiditySensor()
164{
165}
166
167/*!
168 \fn QHumiditySensor::reading() const
169
170 Returns the reading class for this sensor.
171
172 \sa QSensor::reading()
173*/
174
175QHumidityReading *QHumiditySensor::reading() const
176{
177 return static_cast<QHumidityReading*>(QSensor::reading());
178}
179
180QT_END_NAMESPACE
181
182#include "moc_qhumiditysensor.cpp"
183

source code of qtsensors/src/sensors/qhumiditysensor.cpp