FunctionPropertyCommandBuilder Class

Member Function Documentation

QKnxDeviceManagementFrame FunctionPropertyCommandBuilder::createConfirmation(QKnxNetIpCemiServer::ReturnCode code, const QKnxByteArray &data, const QKnxDeviceManagementFrame &request = {}) const

Creates and returns a device management function property command 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::functionPropertyCommandBuilder()
        .createConfirmation(QKnxNetIpCemiServer::ReturnCode::NoError, data, request);
    deviceManagement.sendFrame(confirmation);
}

See also QKnxDeviceManagementFrame and QKnxDeviceManagementFrame::isValid().

QKnxDeviceManagementFrame FunctionPropertyCommandBuilder::createNegativeConfirmation(const QKnxDeviceManagementFrame &request = {}) const

Creates and returns a negative device management function property command 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::functionPropertyCommandBuilder()
            .createNegativeConfirmation(request);
        deviceManagement.sendFrame(confirmation);
    }
}

See also QKnxDeviceManagementFrame and QKnxDeviceManagementFrame::isValid().

QKnxDeviceManagementFrame FunctionPropertyCommandBuilder::createRequest(const QKnxByteArray &data) const

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

The common way to create such a request is:

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

See also QKnxDeviceManagementFrame and QKnxDeviceManagementFrame::isValid().

FunctionPropertyCommandBuilder &FunctionPropertyCommandBuilder::setObjectInstance(quint8 instance)

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

FunctionPropertyCommandBuilder &FunctionPropertyCommandBuilder::setObjectType(QKnxInterfaceObjectType type)

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

FunctionPropertyCommandBuilder &FunctionPropertyCommandBuilder::setProperty(QKnxInterfaceObjectProperty pid)

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