QKnxBuildingMode Class

The QKnxBuildingMode class is a datapoint type for storing the building mode. More...

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

Public Types

enum class Mode { BuildingInUse, BuildingNotUsed, BuildingProtection, Invalid }

Public Functions

QKnxBuildingMode(QKnxBuildingMode::Mode mode)
QKnxBuildingMode()
QKnxBuildingMode::Mode mode() const
bool setMode(QKnxBuildingMode::Mode mode)

Detailed Description

This datapoint type stores whether the building is in use and whether it is protected.

The range for the Mode value is from Building in use, 0 to Building protection, 2.

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 QKnxBuildingMode::Mode

This enum holds the building mode stored in the datapoint type.

ConstantValueDescription
QKnxBuildingMode::Mode::BuildingInUse0x00The building is in use.
QKnxBuildingMode::Mode::BuildingNotUsed0x01The building is not in use.
QKnxBuildingMode::Mode::BuildingProtection0x02The building is protected.
QKnxBuildingMode::Mode::Invalid0xffThe value is invalid.

Member Function Documentation

QKnxBuildingMode::QKnxBuildingMode(QKnxBuildingMode::Mode mode)

Creates a fixed size datapoint type with the building mode set to mode.

QKnxBuildingMode::QKnxBuildingMode()

Creates a fixed size datapoint type with the building mode set to BuildingInUse.

QKnxBuildingMode::Mode QKnxBuildingMode::mode() const

Returns the building mode stored in the datapoint type.

See also setMode().

bool QKnxBuildingMode::setMode(QKnxBuildingMode::Mode mode)

Sets the building mode stored in the datapoint type to mode.

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

See also mode().