PropertyReadBuilder Class

(QKnxDeviceManagementFrame::PropertyReadBuilder)

The QKnxDeviceManagementFrame::PropertyReadBuilder class provides the means to create valid device management property read service frames. More...

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

Public Functions

QKnxDeviceManagementFrame createConfirmation(const QKnxByteArray &data, const QKnxDeviceManagementFrame &request = {}) const
QKnxDeviceManagementFrame createNegativeConfirmation(QKnxNetIpCemiServer::Error error, const QKnxDeviceManagementFrame &request = {}) const
QKnxDeviceManagementFrame createRequest() const
PropertyReadBuilder &setNumberOfElements(quint8 noe)
PropertyReadBuilder &setObjectInstance(quint8 instance)
PropertyReadBuilder &setObjectType(QKnxInterfaceObjectType type)
PropertyReadBuilder &setProperty(QKnxInterfaceObjectProperty pid)
PropertyReadBuilder &setStartIndex(quint16 startIndex)

Detailed Description

The QKnxDeviceManagementFrame::PropertyReadBuilder class provides the means to create valid device management property read service frames.

The property read service is used by a common external message interface (cEMI) client to send a property read request frame, M_PropRead.req. It must be followed by a property read confirmation frame, M_PropRead.con, sent by a cEMI server. The confirmation indicates whether the request was successful.

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

Member Function Documentation

QKnxDeviceManagementFrame PropertyReadBuilder::createConfirmation(const QKnxByteArray &data, const QKnxDeviceManagementFrame &request = {}) const

Creates a and returns a device management property read confirmation frame with the data field set to data.

The available default argument request can be used to fill some of the returned frame fields instead of using the setter functions provided.

The common way to create such a request is:

void MyCemiServer::slotFrameReceived(const QKnxDeviceManagementFrame &request)
{
    // do some work
    auto data = ...

    auto confirmation = QKnxDeviceManagementFrame::propertyReadBuilder()
        .createConfirmation(data, request);
    deviceManagement.sendFrame(confirmation);
}

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

See also QKnxDeviceManagementFrame and QKnxDeviceManagementFrame::isValid().

QKnxDeviceManagementFrame PropertyReadBuilder::createNegativeConfirmation(QKnxNetIpCemiServer::Error error, const QKnxDeviceManagementFrame &request = {}) const

Creates and returns a negative device management property read confirmation frame.

The available default argument request can be used to fill some of the returned frame fields instead of using the setter functions provided.

The number of elements of a negative response is set to zero and the start index needs to be set to the value received with the request.

The error field of a negative response contains information about the error as a QKnx::NetIp::CemiServer::Error value.

The common way to create such a confirmation is:

void MyCemiServer::slotFrameReceived(const QKnxDeviceManagementFrame &request)
{
    // do some work
    bool nonExistingProperty = ...
    if (nonExistingProperty) {
        auto confirmation = QKnxDeviceManagementFrame::propertyReadBuilder()
            .createNegativeConfirmation(QKnxNetIpCemiServer::Error::NonExistingProperty,
                                        request);
        deviceManagement.sendFrame(confirmation);
    }
}

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

See also QKnxDeviceManagementFrame and QKnxDeviceManagementFrame::isValid().

QKnxDeviceManagementFrame PropertyReadBuilder::createRequest() const

Creates a and returns a device management property read request frame.

The common way to create such a request is:

auto request = QKnxDeviceManagementFrame::propertyReadBuilder()
    .setObjectType(...)
    .setObjectInstance(...)
    .setProperty(...)
    .setNumberOfElements(...)
    .setStartIndex(...)
    .createRequest()
deviceManagement.sendFrame(request);

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

See also QKnxDeviceManagementFrame and QKnxDeviceManagementFrame::isValid().

PropertyReadBuilder &PropertyReadBuilder::setNumberOfElements(quint8 noe)

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

PropertyReadBuilder &PropertyReadBuilder::setObjectInstance(quint8 instance)

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

PropertyReadBuilder &PropertyReadBuilder::setObjectType(QKnxInterfaceObjectType type)

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

PropertyReadBuilder &PropertyReadBuilder::setProperty(QKnxInterfaceObjectProperty pid)

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

PropertyReadBuilder &PropertyReadBuilder::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.