PropertyWriteBuilder Class

class QKnxDeviceManagementFrame ::PropertyWriteBuilder

The QKnxDeviceManagementFrame::PropertyWriteBuilder class provides the means to create valid device management property write service frames. 更多...

所有成员列表，包括继承成员

公共函数

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

详细描述

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

另请参阅 QKnxDeviceManagementFrame::MessageCode , QKnxDeviceManagementFrame ，和 Qt KNX Device Management Classes .

成员函数文档编制

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);
}

注意： The returned frame may be invalid depending on the values used during setup.

另请参阅 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 值。

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);
    }
}

注意： The returned frame may be invalid depending on the values used during setup.

另请参阅 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);

注意： The returned frame may be invalid depending on the values used during setup.

另请参阅 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 实例 )

Sets the object instance of this builder to 实例 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.