FunctionPropertyStateReadBuilder Class

(QKnxDeviceManagementFrame::FunctionPropertyStateReadBuilder)

The QKnxDeviceManagementFrame::FunctionPropertyStateReadBuilder class provides the means to create valid device management function property state read service. More...

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

Public Functions

QKnxDeviceManagementFrame createConfirmation(QKnxNetIpCemiServer::ReturnCode code, const QKnxByteArray &data, const QKnxDeviceManagementFrame &request = {}) const
QKnxDeviceManagementFrame createNegativeConfirmation(const QKnxDeviceManagementFrame &request = {}) const
QKnxDeviceManagementFrame createRequest(const QKnxByteArray &data) const
FunctionPropertyStateReadBuilder &setObjectInstance(quint8 instance)
FunctionPropertyStateReadBuilder &setObjectType(QKnxInterfaceObjectType type)
FunctionPropertyStateReadBuilder &setProperty(QKnxInterfaceObjectProperty pid)

Detailed Description

The QKnxDeviceManagementFrame::FunctionPropertyStateReadBuilder class provides the means to create valid device management function property state read service.

The function property state read service is used by a common external message interface (cEMI) client to send a function property state read request frame, M_FuncPropStateRead.req.

It must be followed by a function property state read confirmation frame, M_FuncPropStateRead.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 FunctionPropertyStateReadBuilder::createConfirmation(QKnxNetIpCemiServer::ReturnCode code, const QKnxByteArray &data, const QKnxDeviceManagementFrame &request = {}) const

Creates and returns a device management function property state confirmation frame with the return code set to code and the data field 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 confirmation is:

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

    auto confirmation = QKnxDeviceManagementFrame::functionPropertyStateReadBuilder()
        .createConfirmation(QKnxNetIpCemiServer::ReturnCode::NoError, 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 FunctionPropertyStateReadBuilder::createNegativeConfirmation(const QKnxDeviceManagementFrame &request = {}) const

Creates and returns a negative device management function property state 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 common way to create such a confirmation is:

void MyCemiServer::slotFrameReceived(const QKnxDeviceManagementFrame &request)
{
    // do some work
    bool error = ...
    if (error) {
        auto confirmation = QKnxDeviceManagementFrame::functionPropertyStateReadBuilder()
            .createNegativeConfirmation(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 FunctionPropertyStateReadBuilder::createRequest(const QKnxByteArray &data) const

Creates and returns a device management function property state request frame with the data field set to data.

The common way to create such a request is:

auto request = QKnxDeviceManagementFrame::functionPropertyStateReadBuilder()
    .setObjectType(...)
    .setObjectInstance(...)
    .setProperty(...)
    .createRequest(...);
deviceManagement.sendFrame(request);

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

See also QKnxDeviceManagementFrame and QKnxDeviceManagementFrame::isValid().

FunctionPropertyStateReadBuilder &FunctionPropertyStateReadBuilder::setObjectInstance(quint8 instance)

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

FunctionPropertyStateReadBuilder &FunctionPropertyStateReadBuilder::setObjectType(QKnxInterfaceObjectType type)

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

FunctionPropertyStateReadBuilder &FunctionPropertyStateReadBuilder::setProperty(QKnxInterfaceObjectProperty pid)

Sets the interface object property of this builder to pid 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.