QKnxGeneralStatus Class

The QKnxGeneralStatus class is a datapoint type for general status. More...

Header: #include <QKnxGeneralStatus>
qmake: QT += knx
Inherits: QKnx8BitSet

Public Types

enum Attribute { OutOfService, Fault, Overridden, InAlarm, AlarmUnacknowledged }
flags Attributes

Public Functions

QKnxGeneralStatus(Attributes attributes)
QKnxGeneralStatus()
bool isSet(Attribute attribute) const
bool removeAttribute(Attribute attribute)
bool setAttribute(Attribute attribute)
bool setValue(Attributes attributes)
Attributes value() const

Detailed Description

This is a fixed size datapoint type with the length of 1 byte.

The possible values are combinations of the attributes specified by QKnxGeneralStatus::Attribute.

See also QKnx8BitSet, QKnxDatapointType, and Qt KNX Datapoint Type Classes.

Member Type Documentation

enum QKnxGeneralStatus::Attribute
flags QKnxGeneralStatus::Attributes

This enum type holds the status attributes.

ConstantValue
QKnxGeneralStatus::OutOfService0x01
QKnxGeneralStatus::Fault0x02
QKnxGeneralStatus::Overridden0x04
QKnxGeneralStatus::InAlarm0x08
QKnxGeneralStatus::AlarmUnacknowledged0x10

The Attributes type is a typedef for QFlags<Attribute>. It stores an OR combination of Attribute values.

Member Function Documentation

QKnxGeneralStatus::QKnxGeneralStatus(Attributes attributes)

Creates a fixed size datapoint type with the attributes attributes.

QKnxGeneralStatus::QKnxGeneralStatus()

Creates a fixed size datapoint type with an empty list of attributes.

bool QKnxGeneralStatus::isSet(Attribute attribute) const

Returns whether the attribute attribute is set in the datapoint type.

bool QKnxGeneralStatus::removeAttribute(Attribute attribute)

Removes the attribute attribute from the value of the datapoint type.

Returns true if the value was removed; otherwise returns false.

bool QKnxGeneralStatus::setAttribute(Attribute attribute)

Sets the attribute attribute within the value of the datapoint type.

Returns true if the value was set; otherwise returns false.

bool QKnxGeneralStatus::setValue(Attributes attributes)

Sets the value of the datapoint type to the list of attributes specified by attributes.

Returns true if the value was set; otherwise returns false.

See also value().

Attributes QKnxGeneralStatus::value() const

Returns the value stored in the datapoint type as a list of attributes.

See also setValue().