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 Mode { Occupied, Standby, NotOccupied, Invalid }

Public Functions

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

Additional Inherited Members

Detailed Description

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

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

This enum holds the mode stored in the datapoint type.

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

Member Function Documentation

QKnxOccupyMode::QKnxOccupyMode()

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

QKnxOccupyMode::QKnxOccupyMode(QKnxOccupyMode::Mode mode)

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

QKnxOccupyMode::Mode QKnxOccupyMode::mode() const

Returns the mode stored in the datapoint type.

See also setMode().

bool QKnxOccupyMode::setMode(QKnxOccupyMode::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().

© 2018 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.