PropertyWriteBuilder Class

Member Function Documentation

QKnxDeviceManagementFrame PropertyWriteBuilder::createConfirmation(const QKnxDeviceManagementFrame &request = {}) const

Creates a and returns a device management property write 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 request is:

void MyCemiServer::slotFrameReceived(const QKnxDeviceManagementFrame &request)
{
    if (request.messageCode() != QKnxDeviceManagementFrame::MessageCode::PropertyWriteRequest)
        return;

    // execute the write operation

    auto confirmation = QKnxDeviceManagementFrame::propertyWriteBuilder()
        .createConfirmation(request);
    deviceManagement.sendFrame(confirmation);
}

See also QKnxDeviceManagementFrame and QKnxDeviceManagementFrame::isValid().

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

Creates and returns a negative device management property write 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)
{
    if (request.messageCode() != QKnxDeviceManagementFrame::MessageCode::PropertyWriteRequest)
        return;

    bool readOnly = ... // check if the property is read only
    if (readOnly) {
        auto confirmation = QKnxDeviceManagementFrame::propertyWriteBuilder()
            .createNegativeConfirmation(QKnxNetIpCemiServer::Error::ReadOnly, request);
        deviceManagement.sendFrame(confirmation);
    }
}

See also QKnxDeviceManagementFrame and QKnxDeviceManagementFrame::isValid().

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

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

The common way to create such a request is:

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

See also QKnxDeviceManagementFrame and QKnxDeviceManagementFrame::isValid().

PropertyWriteBuilder &PropertyWriteBuilder::setNumberOfElements(quint8 noe)

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

PropertyWriteBuilder &PropertyWriteBuilder::setObjectInstance(quint8 instance)

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

PropertyWriteBuilder &PropertyWriteBuilder::setObjectType(QKnxInterfaceObjectType type)

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

PropertyWriteBuilder &PropertyWriteBuilder::setProperty(QKnxInterfaceObjectProperty pid)

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

PropertyWriteBuilder &PropertyWriteBuilder::setStartIndex(quint16 startIndex)

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