QKnxCombinedInfoOnOff Class
The QKnxCombinedInfoOnOff class is a datapoint type for storing combined information about the on and off states of a multiple-channel binary actuator. More...
| Header: | #include <QKnxCombinedInfoOnOff> |
| qmake: | QT += knx |
| Inherits: | QKnx32BitSet |
Public Types
| enum class | Output { First, Second, Third, Fourth, Fifth, …, Sixteenth } |
| enum class | OutputState { Off, On } |
| enum class | OutputValidity { Invalid, Valid } |
Public Functions
| QKnxCombinedInfoOnOff(QKnxCombinedInfoOnOff::Output output, QKnxCombinedInfoOnOff::OutputState state, QKnxCombinedInfoOnOff::OutputValidity validity) | |
| QKnxCombinedInfoOnOff(const QVector<QKnxCombinedInfoOnOff::OutputInfo> &infos) | |
| QKnxCombinedInfoOnOff() | |
| bool | setState(QKnxCombinedInfoOnOff::Output output, QKnxCombinedInfoOnOff::OutputState state) |
| bool | setValidity(QKnxCombinedInfoOnOff::Output output, QKnxCombinedInfoOnOff::OutputValidity validity) |
| bool | setValue(const QVector<QKnxCombinedInfoOnOff::OutputInfo> &infos) |
| bool | setValue(QKnxCombinedInfoOnOff::Output output, QKnxCombinedInfoOnOff::OutputState state, QKnxCombinedInfoOnOff::OutputValidity validity) |
| QKnxCombinedInfoOnOff::OutputState | state(QKnxCombinedInfoOnOff::Output output) const |
| QKnxCombinedInfoOnOff::OutputValidity | validity(QKnxCombinedInfoOnOff::Output output) const |
Detailed Description
This datapoint type may only be used for encoding the combined binary output information of a multiple-channel binary actuator. It avoids the bus load that is caused by individual single bit state outputs, especially in case of simultaneous changes, such as all off.
If one or more output bits are not used or the output states are not valid, the assigned mask bits of the output shall be set to the value 0.
This is a fixed size datapoint type with the length of 4 bytes.
See also QKnx32BitSet, QKnxDatapointType, and Qt KNX Datapoint Type Classes.
Member Type Documentation
enum class QKnxCombinedInfoOnOff::Output
This enum type holds the output bit stored in the datapoint type.
| Constant | Value |
|---|---|
QKnxCombinedInfoOnOff::Output::First | 0 |
QKnxCombinedInfoOnOff::Output::Second | 1 |
QKnxCombinedInfoOnOff::Output::Third | 2 |
QKnxCombinedInfoOnOff::Output::Fourth | 3 |
QKnxCombinedInfoOnOff::Output::Fifth | 4 |
QKnxCombinedInfoOnOff::Output::Sixth | 5 |
QKnxCombinedInfoOnOff::Output::Seventh | 6 |
QKnxCombinedInfoOnOff::Output::Eighth | 7 |
QKnxCombinedInfoOnOff::Output::Ninth | 8 |
QKnxCombinedInfoOnOff::Output::Tenth | 9 |
QKnxCombinedInfoOnOff::Output::Eleventh | 10 |
QKnxCombinedInfoOnOff::Output::Twelfth | 11 |
QKnxCombinedInfoOnOff::Output::Thirteenth | 12 |
QKnxCombinedInfoOnOff::Output::Fourteenth | 13 |
QKnxCombinedInfoOnOff::Output::Fifteenth | 14 |
QKnxCombinedInfoOnOff::Output::Sixteenth | 15 |
enum class QKnxCombinedInfoOnOff::OutputState
This enum type holds the state of the output stored in the datapoint type.
| Constant | Value | Description |
|---|---|---|
QKnxCombinedInfoOnOff::OutputState::Off | 0x00 | The output state is Off. |
QKnxCombinedInfoOnOff::OutputState::On | 0x01 | The output state is On. |
enum class QKnxCombinedInfoOnOff::OutputValidity
This enum type holds the validity of the output stored in the datapoint type.
| Constant | Value | Description |
|---|---|---|
QKnxCombinedInfoOnOff::OutputValidity::Invalid | 0x00 | The output state is invalid. |
QKnxCombinedInfoOnOff::OutputValidity::Valid | 0x01 | The output state is valid. |
Member Function Documentation
QKnxCombinedInfoOnOff::QKnxCombinedInfoOnOff(QKnxCombinedInfoOnOff::Output output, QKnxCombinedInfoOnOff::OutputState state, QKnxCombinedInfoOnOff::OutputValidity validity)
Creates a fixed size datapoint type with the output bit output, state state, and validity validity.
QKnxCombinedInfoOnOff::QKnxCombinedInfoOnOff(const QVector<QKnxCombinedInfoOnOff::OutputInfo> &infos)
Creates a fixed size datapoint type with the output information infos.
QKnxCombinedInfoOnOff::QKnxCombinedInfoOnOff()
Creates a fixed size datapoint type with the output bit set to QKnxCombinedInfoOnOff::First, output state to QKnxCombinedInfoOnOff::Off, and output validity to QKnxCombinedInfoOnOff::Invalid.
bool QKnxCombinedInfoOnOff::setState(QKnxCombinedInfoOnOff::Output output, QKnxCombinedInfoOnOff::OutputState state)
Sets the output bit stored in the datapoint type to output and the state to state.
If the value is outside the allowed range, returns false and does not set the value.
See also state().
bool QKnxCombinedInfoOnOff::setValidity(QKnxCombinedInfoOnOff::Output output, QKnxCombinedInfoOnOff::OutputValidity validity)
Sets the output bit stored in the datapoint type to output and the validity to validity.
If the value is outside the allowed range, returns false and does not set the value.
See also validity().
bool QKnxCombinedInfoOnOff::setValue(const QVector<QKnxCombinedInfoOnOff::OutputInfo> &infos)
Sets the value stored in the datapoint type to infos.
Returns true if the value was set successfully; otherwise returns false.
bool QKnxCombinedInfoOnOff::setValue(QKnxCombinedInfoOnOff::Output output, QKnxCombinedInfoOnOff::OutputState state, QKnxCombinedInfoOnOff::OutputValidity validity)
Sets the output bit stored in the datapoint type to output, the output state to state, and output validity to validity.
Returns true if the value was set; otherwise returns false.
QKnxCombinedInfoOnOff::OutputState QKnxCombinedInfoOnOff::state(QKnxCombinedInfoOnOff::Output output) const
Returns the state of the output bit output.
See also setState().
QKnxCombinedInfoOnOff::OutputValidity QKnxCombinedInfoOnOff::validity(QKnxCombinedInfoOnOff::Output output) const
Returns the validity of the output bit output.
See also setValidity().
© 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.
