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(Alarm alarm)
QKnxAlarmReaction()
Alarm alarm() const
bool setAlarm(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.

ConstantValueDescription
QKnxAlarmReaction::Alarm::NoAlarm0x00No alarm is used.
QKnxAlarmReaction::Alarm::AlarmUp0x01Alarm position is up.
QKnxAlarmReaction::Alarm::AlarmDown0x02Alarm position is down.

Member Function Documentation

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.

Alarm QKnxAlarmReaction::alarm() const

Returns the alarm reaction stored in the datapoint type.

See also setAlarm().

bool QKnxAlarmReaction::setAlarm(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().