Source code
Revision control
Copy as Markdown
// Copyright (C) 2016 Canonical 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 <qhumiditysensor.h>
#include "qhumiditysensor_p.h"
QT_BEGIN_NAMESPACE
IMPLEMENT_READING(QHumidityReading)
/*!
\class QHumidityReading
\ingroup sensors_reading
\inmodule QtSensors
\since 5.9
\brief The QHumidityReading class holds readings from the humidity sensor.
\section1 QHumidityReading Units
The humidity sensor returns the relative humidity as a percentage, and absolute humidity in
grams per cubic meter (g/m3).
Note that some sensors may not support absolute humidity, 0 will be returned in this case.
*/
/*!
\property QHumidityReading::relativeHumidity
\brief Relative humidity
Returned as a percentage.
\sa {QHumidityReading Units}
*/
qreal QHumidityReading::relativeHumidity() const
{
return d->relativeHumidity;
}
/*!
Sets relativeHumidity to \a humidity.
*/
void QHumidityReading::setRelativeHumidity(qreal humidity)
{
d->relativeHumidity = humidity;
}
/*!
\property QHumidityReading::absoluteHumidity
\brief Absolute humidity
Measured in grams per cubic meter.
Note that some sensors may not support absolute humidity.
\sa {QHumidityReading Units}
*/
qreal QHumidityReading::absoluteHumidity() const
{
return d->absoluteHumidity;
}
/*!
Sets absoluteHumidity to \a value.
*/
void QHumidityReading::setAbsoluteHumidity(qreal value)
{
d->absoluteHumidity = value;
}
// =====================================================================
/*!
\class QHumidityFilter
\ingroup sensors_filter
\inmodule QtSensors
\since 5.9
\brief The QHumidityFilter class is a convenience wrapper around QSensorFilter.
The only difference is that the filter() method features a pointer to QHumidityReading
instead of QSensorReading.
*/
/*!
\fn QHumidityFilter::filter(QHumidityReading *reading)
Called when \a reading changes. Returns false to prevent the reading from propagating.
\sa QSensorFilter::filter()
*/
bool QHumidityFilter::filter(QSensorReading *reading)
{
return filter(static_cast<QHumidityReading*>(reading));
}
char const * const QHumiditySensor::sensorType("QHumiditySensor");
/*!
\class QHumiditySensor
\ingroup sensors_type
\inmodule QtSensors
\since 5.9
\brief The QHumiditySensor 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 QHumidityReading instead of a QSensorReading.
For details about how the sensor works, see \l QHumidityReading.
\sa QHumidityReading
*/
/*!
Construct the sensor as a child of \a parent.
*/
QHumiditySensor::QHumiditySensor(QObject *parent)
: QSensor(QHumiditySensor::sensorType, parent)
{
}
/*!
Destroy the sensor. Stops the sensor if it has not already been stopped.
*/
QHumiditySensor::~QHumiditySensor()
{
}
/*!
\fn QHumiditySensor::reading() const
Returns the reading class for this sensor.
\sa QSensor::reading()
*/
QHumidityReading *QHumiditySensor::reading() const
{
return static_cast<QHumidityReading*>(QSensor::reading());
}
QT_END_NAMESPACE
#include "moc_qhumiditysensor.cpp"