QKnxSceneInfo Class

The QKnxSceneInfo class is a datapoint type for scene information. More...

Header: #include <QKnxSceneInfo>
qmake: QT += knx
Inherits: QKnxFixedSizeDatapointType

Public Types

enum Info { Active, Inactive }

Public Functions

QKnxSceneInfo()
QKnxSceneInfo(quint8 sceneNumber, QKnxSceneInfo::Info info)
QKnxSceneInfo::Info info() const
quint8 sceneNumber() const
bool setInfo(QKnxSceneInfo::Info info)
bool setSceneNumber(quint8 number)
bool setValue(quint8 sceneNumber, QKnxSceneInfo::Info info)

Reimplemented Public Functions

virtual bool isValid() const override

Additional Inherited Members

Detailed Description

The QKnxSceneInfo class is a datapoint type for scene information.

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

The scene information holds the activity state of the corresponding scene number. The range for scene numbers is from 0 to 63.

See also Info, QKnxDatapointType, QKnxSceneNumber, QKnxSceneControl, and Qt KNX Datapoint Type Classes.

Member Type Documentation

enum QKnxSceneInfo::Info

This enum holds holds whether the scene is active.

ConstantValueDescription
QKnxSceneInfo::Active0x00The scene is active.
QKnxSceneInfo::Inactive0x01The scene is inactive.

Member Function Documentation

QKnxSceneInfo::QKnxSceneInfo()

Creates a fixed size datapoint type with the scene information set to Active.

See also Info.

QKnxSceneInfo::QKnxSceneInfo(quint8 sceneNumber, QKnxSceneInfo::Info info)

Creates a fixed size datapoint type with the scene number set to sceneNumber and the scene information set to info.

See also Info.

QKnxSceneInfo::Info QKnxSceneInfo::info() const

Returns the scene information stored in the datapoint type.

See also setInfo().

[override virtual] bool QKnxSceneInfo::isValid() const

Reimplemented from QKnxDatapointType::isValid().

quint8 QKnxSceneInfo::sceneNumber() const

Returns the scene number stored in the datapoint type.

See also setSceneNumber().

bool QKnxSceneInfo::setInfo(QKnxSceneInfo::Info info)

Sets the scene information stored in the datapoint type to info.

Returns true if the value was set successfully.

See also info().

bool QKnxSceneInfo::setSceneNumber(quint8 number)

Sets the scene number stored in the datapoint type to number.

If the value is outside the allowed range, returns false and does not set the value.

See also sceneNumber().

bool QKnxSceneInfo::setValue(quint8 sceneNumber, QKnxSceneInfo::Info info)

Sets the scene number stored in the datapoint type to sceneNumber and the scene information to info.

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

© 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.