QKnxPriority Class

The QKnxPriority class is a datapoint type for storing priority. More...

Header: #include <QKnxPriority>
qmake: QT += knx
Inherits: QKnx1Byte

Public Types

enum class Priority { High, Medium, Low, Void, Invalid }

Public Functions

QKnxPriority(QKnxPriority::Priority priority)
QKnxPriority()
QKnxPriority::Priority priority() const
bool setPriority(QKnxPriority::Priority priority)

Detailed Description

This datapoint type is used for parameters, not for runtime interworking. For example, it can be used to store the alarm priority of a configurable digital alarm input in a device.

The range for the value is from High, 0 to Void, 3.

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 QKnxPriority::Priority

This enum holds the priority stored in the datapoint type.

ConstantValueDescription
QKnxPriority::Priority::High0x00High
QKnxPriority::Priority::Medium0x01Medium
QKnxPriority::Priority::Low0x02Low
QKnxPriority::Priority::Void0x03Void
QKnxPriority::Priority::Invalid0xffThe value is invalid.

Member Function Documentation

QKnxPriority::QKnxPriority(QKnxPriority::Priority priority)

Creates a fixed size datapoint type with the priority set to priority.

QKnxPriority::QKnxPriority()

Creates a fixed size datapoint type with the priority set to High.

QKnxPriority::Priority QKnxPriority::priority() const

Returns the priority stored in the datapoint type.

See also setPriority().

bool QKnxPriority::setPriority(QKnxPriority::Priority priority)

Sets the priority stored in the datapoint type to priority.

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

See also priority().