QKnxSceneControl Class
The QKnxSceneControl class is a datapoint type for a scene control. More...
| Header: | #include <QKnxSceneControl> |
| qmake: | QT += knx |
| Inherits: | QKnxFixedSizeDatapointType |
Public Types
| enum | Control { Activate, Learn } |
Public Functions
| QKnxSceneControl(quint8 sceneNumber, QKnxSceneControl::Control control) | |
| QKnxSceneControl() | |
| QKnxSceneControl::Control | control() const |
| quint8 | sceneNumber() const |
| bool | setControl(QKnxSceneControl::Control control) |
| bool | setSceneNumber(quint8 number) |
| bool | setValue(quint8 sceneNumber, QKnxSceneControl::Control control) |
Reimplemented Public Functions
| virtual bool | isValid() const override |
Detailed Description
This is a fixed size datapoint type with the length of 1 byte.
A scene control can be used to activate or learn the corresponding scene number. The range for scene numbers is from 0 to 63.
See also Control, QKnxDatapointType, QKnxSceneNumber, QKnxSceneInfo, and Qt KNX Datapoint Type Classes.
Member Type Documentation
enum QKnxSceneControl::Control
This enum holds the action for the scene control.
| Constant | Value | Description |
|---|---|---|
QKnxSceneControl::Activate | 0x00 | Activate the scene corresponding to the scene number. |
QKnxSceneControl::Learn | 0x01 | Learn the scene corresponding to the scene number. |
Member Function Documentation
QKnxSceneControl::QKnxSceneControl(quint8 sceneNumber, QKnxSceneControl::Control control)
Creates a fixed size datapoint type with the scene number set to sceneNumber and the scene control action set to control.
See also Control.
QKnxSceneControl::QKnxSceneControl()
Creates a fixed size datapoint type with the scene number set to 0 and the scene control action set to Activate.
See also Control.
QKnxSceneControl::Control QKnxSceneControl::control() const
Returns the scene control action stored in the datapoint type.
See also setControl().
[override virtual] bool QKnxSceneControl::isValid() const
Reimplements: QKnxDatapointType::isValid() const.
quint8 QKnxSceneControl::sceneNumber() const
Returns the scene number stored in the datapoint type.
See also setSceneNumber().
bool QKnxSceneControl::setControl(QKnxSceneControl::Control control)
Sets the scene control action stored in the datapoint type to control.
Returns true if the value was set successfully.
See also control().
bool QKnxSceneControl::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 QKnxSceneControl::setValue(quint8 sceneNumber, QKnxSceneControl::Control control)
Sets the scene number stored in the datapoint type to sceneNumber and the scene control action to control.
Returns true if the value was set; otherwise returns false.
© 2024 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.
