QKnxBeaufortWindForceScale Class
The QKnxBeaufortWindForceScale class is a datapoint type for storing the Beaufort wind force scale. More...
Header: | #include <QKnxBeaufortWindForceScale> |
qmake: | QT += knx |
Inherits: | QKnx1Byte |
Public Types
enum class | Force { CalmNoWind, LightAir, LightBreeze, GentleBreeze, ModerateBreeze, …, Invalid } |
Public Functions
QKnxBeaufortWindForceScale(QKnxBeaufortWindForceScale::Force force) | |
QKnxBeaufortWindForceScale() | |
QKnxBeaufortWindForceScale::Force | force() const |
bool | setForce(QKnxBeaufortWindForceScale::Force force) |
Detailed Description
The range for the Force value is from Calm (no wind), 0
to Hurricane, 12
.
This is a fixed size datapoint type with the length of 1 byte.
See also QKnxDatapointType, QKnx1Byte, and Qt KNX Datapoint Type Classes.
Member Type Documentation
enum class QKnxBeaufortWindForceScale::Force
This enum holds the Beaufort wind force scale stored in the datapoint type.
Constant | Value | Description |
---|---|---|
QKnxBeaufortWindForceScale::Force::CalmNoWind | 0x00 | |
QKnxBeaufortWindForceScale::Force::LightAir | 0x01 | |
QKnxBeaufortWindForceScale::Force::LightBreeze | 0x02 | |
QKnxBeaufortWindForceScale::Force::GentleBreeze | 0x03 | |
QKnxBeaufortWindForceScale::Force::ModerateBreeze | 0x04 | |
QKnxBeaufortWindForceScale::Force::FreshBreeze | 0x05 | |
QKnxBeaufortWindForceScale::Force::StrongBreeze | 0x06 | |
QKnxBeaufortWindForceScale::Force::NearModerateGale | 0x07 | |
QKnxBeaufortWindForceScale::Force::FreshGale | 0x08 | |
QKnxBeaufortWindForceScale::Force::StrongGale | 0x09 | |
QKnxBeaufortWindForceScale::Force::WholeGaleStorm | 0x0a | |
QKnxBeaufortWindForceScale::Force::ViolentStorm | 0x0b | |
QKnxBeaufortWindForceScale::Force::Hurricane | 0x0c | |
QKnxBeaufortWindForceScale::Force::Invalid | 0xff | The value is invalid. |
Member Function Documentation
QKnxBeaufortWindForceScale::QKnxBeaufortWindForceScale(QKnxBeaufortWindForceScale::Force force)
Creates a fixed size datapoint type with the Beaufort wind force scale set to force.
QKnxBeaufortWindForceScale::QKnxBeaufortWindForceScale()
Creates a fixed size datapoint type with the Beaufort wind force scale set to CalmNoWind
.
QKnxBeaufortWindForceScale::Force QKnxBeaufortWindForceScale::force() const
Returns the Beaufort wind force scale stored in the datapoint type.
See also setForce().
bool QKnxBeaufortWindForceScale::setForce(QKnxBeaufortWindForceScale::Force force)
Sets the Beaufort wind force scale stored in the datapoint type to force.
Returns true
if the byte was set; otherwise returns false
.
See also force().