QKnxOccupyMode Class

The QKnxOccupyMode class is a datapoint type for storing the occupy mode. More...

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

Public Types

enum class Mode { Occupied, Standby, NotOccupied, Invalid }

Public Functions

QKnxOccupyMode(Mode mode)
QKnxOccupyMode()
Mode mode() const
bool setMode(Mode mode)

Detailed Description

This datapoint type stores information about room occupancy.

The range for the value is from Occupied, 0 to Not occupied, 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 QKnxOccupyMode::Mode

This enum holds the mode stored in the datapoint type.

ConstantValueDescription
QKnxOccupyMode::Mode::Occupied0x00The room is occupied.
QKnxOccupyMode::Mode::Standby0x01Stand-by
QKnxOccupyMode::Mode::NotOccupied0x02The room is not occupied.
QKnxOccupyMode::Mode::Invalid0xffThe value is invalid.

Member Function Documentation

QKnxOccupyMode::QKnxOccupyMode(Mode mode)

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

QKnxOccupyMode::QKnxOccupyMode()

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

Mode QKnxOccupyMode::mode() const

Returns the mode stored in the datapoint type.

See also setMode().

bool QKnxOccupyMode::setMode(Mode mode)

Sets the mode stored in the datapoint type to mode.

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

See also mode().