QKnxAlarmReaction Class
The QKnxAlarmReaction class is a fixed size datapoint type for storing the alarm reaction. More...
Header: | #include <QKnxAlarmReaction> |
qmake: | QT += knx |
Inherits: | QKnx2BitSet |
Public Types
enum class | Alarm { NoAlarm, AlarmUp, AlarmDown } |
Public Functions
QKnxAlarmReaction(QKnxAlarmReaction::Alarm alarm) | |
QKnxAlarmReaction() | |
QKnxAlarmReaction::Alarm | alarm() const |
bool | setAlarm(QKnxAlarmReaction::Alarm alarm) |
Detailed Description
The range for the alarm value is from No alarm is used, 0
to Alarm position is down, 2
.
This is a fixed size datapoint type with the length of 2 bits.
See also QKnxDatapointType, QKnxOnOffAction, QKnxUpDownAction, and Qt KNX Datapoint Type Classes.
Member Type Documentation
enum class QKnxAlarmReaction::Alarm
This enum holds the alarm reaction stored in the datapoint type.
Constant | Value | Description |
---|---|---|
QKnxAlarmReaction::Alarm::NoAlarm | 0x00 | No alarm is used. |
QKnxAlarmReaction::Alarm::AlarmUp | 0x01 | Alarm position is up. |
QKnxAlarmReaction::Alarm::AlarmDown | 0x02 | Alarm position is down. |
Member Function Documentation
QKnxAlarmReaction::QKnxAlarmReaction(QKnxAlarmReaction::Alarm alarm)
Creates a fixed size datapoint type with the alarm reaction set to alarm.
QKnxAlarmReaction::QKnxAlarmReaction()
Creates a fixed size datapoint type with the alarm reaction set to NoAlarm
.
QKnxAlarmReaction::Alarm QKnxAlarmReaction::alarm() const
Returns the alarm reaction stored in the datapoint type.
See also setAlarm().
bool QKnxAlarmReaction::setAlarm(QKnxAlarmReaction::Alarm alarm)
Sets the alarm reaction stored in the datapoint type to alarm.
Returns true
if the value was set; otherwise returns false
.
See also alarm().
© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.