PropertyInfoBuilder Class

(QKnxDeviceManagementFrame::PropertyInfoBuilder)

The QKnxDeviceManagementFrame::PropertyInfoBuilder class provides the means to create a valid device management property info indication frame. More...

Header: #include <QKnxDeviceManagementFrameBuilder>
qmake: QT += knx

Public Functions

PropertyInfoBuilder()
QKnxDeviceManagementFrame createIndication(const QKnxByteArray &data) const
PropertyInfoBuilder &setNumberOfElements(quint8 noe)
PropertyInfoBuilder &setObjectInstance(quint8 instance)
PropertyInfoBuilder &setObjectType(QKnxInterfaceObjectType type)
PropertyInfoBuilder &setProperty(QKnxInterfaceObjectProperty pid)
PropertyInfoBuilder &setStartIndex(quint16 startIndex)

Detailed Description

The QKnxDeviceManagementFrame::PropertyInfoBuilder class provides the means to create a valid device management property info indication frame.

The property info service is used for local device management. It is an unconfirmed service, that is used by a common external message interface (cEMI) cEMI server to send notifications upon events, for example.

See also QKnxDeviceManagementFrame::MessageCode, QKnxDeviceManagementFrame, and Qt KNX Device Management Classes.

Member Function Documentation

PropertyInfoBuilder::PropertyInfoBuilder()

Creates a device management property info builder object.

QKnxDeviceManagementFrame PropertyInfoBuilder::createIndication(const QKnxByteArray &data) const

Creates and returns a device management property info indication frame with the data field set to data.

The common way to create such an indication is:

auto indication = QKnxDeviceManagementFrame::propertyInfoBuilder()
    .setObjectType(...)
    .setObjectInstance(...)
    .setProperty(...)
    .setNumberOfElements(...)
    .setStartIndex(...)
    .createIndication(...)
deviceManagement.sendFrame(indication);

Note: The returned frame may be invalid depending on the values used during setup.

See also QKnxDeviceManagementFrame and QKnxDeviceManagementFrame::isValid().

PropertyInfoBuilder &PropertyInfoBuilder::setNumberOfElements(quint8 noe)

Sets the number of elements of this builder to noe and returns a reference to the builder.

PropertyInfoBuilder &PropertyInfoBuilder::setObjectInstance(quint8 instance)

Sets the object instance of this builder to instance and returns a reference to the builder.

PropertyInfoBuilder &PropertyInfoBuilder::setObjectType(QKnxInterfaceObjectType type)

Sets the interface object type of this builder to type and returns a reference to the builder.

PropertyInfoBuilder &PropertyInfoBuilder::setProperty(QKnxInterfaceObjectProperty pid)

Sets the interface object property of this builder to pid and returns a reference to the builder.

PropertyInfoBuilder &PropertyInfoBuilder::setStartIndex(quint16 startIndex)

Sets the start index of this builder to startIndex and returns a reference to the builder.

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