QKnxDeviceManagementFrame Class

Member Function Documentation

QKnxDeviceManagementFrame::QKnxDeviceManagementFrame(QKnxDeviceManagementFrame &&other)

Move-constructs an object instance, making it point to the same object that other was pointing to.

QKnxDeviceManagementFrame::QKnxDeviceManagementFrame(const QKnxDeviceManagementFrame &other)

Constructs a copy of other.

QKnxDeviceManagementFrame::QKnxDeviceManagementFrame(QKnxDeviceManagementFrame::MessageCode code, const QKnxByteArray &serviceInfo)

Constructs a local device management frame with the message code set to code and service information set to serviceInfo.

QKnxDeviceManagementFrame::QKnxDeviceManagementFrame(QKnxDeviceManagementFrame::MessageCode code)

Constructs an empty local device management frame with the message code set to code.

QKnxDeviceManagementFrame::QKnxDeviceManagementFrame()

Constructs an empty invalid local device management frame.

QKnxDeviceManagementFrame &QKnxDeviceManagementFrame::operator=(QKnxDeviceManagementFrame &&other)

Move-assigns other to this object instance.

QKnxDeviceManagementFrame &QKnxDeviceManagementFrame::operator=(const QKnxDeviceManagementFrame &other)

Assigns the specified other to this object.

QKnxDeviceManagementFrame::~QKnxDeviceManagementFrame()

Destroys the local device management frame and frees all allocated resources.

[static] QKnxDeviceManagementFrame::Builder QKnxDeviceManagementFrame::builder()

Returns an instance of a generic device management frame builder.

QKnxByteArray QKnxDeviceManagementFrame::bytes() const

Returns an array of bytes that represent the local device management frame.

QKnxByteArray QKnxDeviceManagementFrame::data() const

Returns the data field of the local device management frame as an array of bytes.

The length of the data depends on the property datatype of the property and in case of an array-structured property value also on the number of array elements that are accessed.

In case of an error, the data field stores the error code as a single byte.

See also setData().

QKnxNetIpCemiServer::Error QKnxDeviceManagementFrame::error() const

Returns the error code stored in the local device management frame if the frame is a PropertyReadConfirmation or PropertyWriteConfirmation frame and the number of elements is set to 0. Otherwise returns None.

See also setError(), data(), and isNegativeConfirmation().

[static] QKnxDeviceManagementFrame QKnxDeviceManagementFrame::fromBytes(const QKnxByteArray &data, quint16 index, quint16 size)

Constructs the local device management frame from the byte array data starting at the position index inside the array with the size size.

[static] QKnxDeviceManagementFrame::FunctionPropertyCommandBuilder QKnxDeviceManagementFrame::functionPropertyCommandBuilder()

Returns an instance of a device management function property command frame builder.

[static] QKnxDeviceManagementFrame::FunctionPropertyStateReadBuilder QKnxDeviceManagementFrame::functionPropertyStateReadBuilder()

Returns an instance of a device management function property state read frame builder.

bool QKnxDeviceManagementFrame::isNegativeConfirmation() const

Returns true if this local device management frame is a negative confirmation; otherwise returns false.

For property read or write confirmation frames, the data field of a negative confirmation contains the error information.

For function property command or function property state read confirmation frames, neither a return code nor data are transmitted with the frame.

See also data(), error(), and returnCode().

bool QKnxDeviceManagementFrame::isNull() const

Returns true if this is a default constructed device management frame, otherwise returns false. A frame is considered null if it contains no initialized values.

bool QKnxDeviceManagementFrame::isValid() const

Returns true if the local device management frame is valid, returns false otherwise.

QKnxDeviceManagementFrame::MessageCode QKnxDeviceManagementFrame::messageCode() const

Returns the message code of this local device management frame.

See also setMessageCode().

quint8 QKnxDeviceManagementFrame::numberOfElements() const

Returns the number of elements for an array-structured property. A return value of 0 indicates a negative response.

See also setNumberOfElements() and isNegativeConfirmation().

quint8 QKnxDeviceManagementFrame::objectInstance() const

Returns the object instance if available; otherwise returns 0.

See also setObjectInstance().

QKnxInterfaceObjectType QKnxDeviceManagementFrame::objectType() const

Returns the object type carried by the frame if available; otherwise returns QKnxInterfaceObjectType::Invalid.

See also setObjectType().

QKnxInterfaceObjectProperty QKnxDeviceManagementFrame::property() const

Returns the interface object property if available; otherwise returns QKnxInterfaceObjectProperty::Invalid.

See also setProperty().

[static] QKnxDeviceManagementFrame::PropertyInfoBuilder QKnxDeviceManagementFrame::propertyInfoBuilder()

Returns an instance of a device management property info frame builder.

[static] QKnxDeviceManagementFrame::PropertyReadBuilder QKnxDeviceManagementFrame::propertyReadBuilder()

Returns an instance of a device management property read frame builder.

[static] QKnxDeviceManagementFrame::PropertyWriteBuilder QKnxDeviceManagementFrame::propertyWriteBuilder()

Returns an instance of a device management property write frame builder.

[static] QKnxDeviceManagementFrame::ResetBuilder QKnxDeviceManagementFrame::resetBuilder()

Returns an instance of a device management reset frame builder.

QKnxNetIpCemiServer::ReturnCode QKnxDeviceManagementFrame::returnCode() const

Returns the code set by the cEMI server after a cEMI function property service request if the frame is a FunctionPropertyCommandConfirmation or FunctionPropertyStateReadConfirmation and is also not a negative confirmation. Otherwise returns NoError.

See also setReturnCode(), data(), and isNegativeConfirmation().

QKnxByteArray QKnxDeviceManagementFrame::serviceInformation() const

Returns the service information of the local device management frame as an array of bytes.

See also setServiceInformation().

void QKnxDeviceManagementFrame::setData(const QKnxByteArray &newData)

Sets the data field of the local device management frame to newData. No validation checks are done on the function argument.

See also data() and isValid().

void QKnxDeviceManagementFrame::setError(QKnxNetIpCemiServer::Error error)

Sets the error code stored in the frame to error if the frame is a PropertyReadConfirmation or PropertyWriteConfirmation frame; does nothing otherwise.

See also error().

void QKnxDeviceManagementFrame::setMessageCode(QKnxDeviceManagementFrame::MessageCode code)

Sets the message code of this local device management frame to code.

See also messageCode().

void QKnxDeviceManagementFrame::setNumberOfElements(quint8 numOfElements)

Sets the number of elements for an array-structured property to numOfElements. A value of 0 is used to indicate a negative response.

See also numberOfElements().

void QKnxDeviceManagementFrame::setObjectInstance(quint8 instance)

Sets the object instance to instance if the argument is valid; does nothing otherwise.

See also objectInstance().

void QKnxDeviceManagementFrame::setObjectType(QKnxInterfaceObjectType type)

Sets the interface object type to type if the argument is a valid; otherwise does nothing.

See also objectType().

void QKnxDeviceManagementFrame::setProperty(QKnxInterfaceObjectProperty pid)

Sets the interface object property identifier to pid if the argument is valid; otherwise does nothing.

See also property().

void QKnxDeviceManagementFrame::setReturnCode(QKnxNetIpCemiServer::ReturnCode code)

Sets the return code stored in the frame to code if the frame is a FunctionPropertyCommandConfirmation or FunctionPropertyStateReadConfirmation frame; does nothing otherwise.

See also returnCode().

void QKnxDeviceManagementFrame::setServiceInformation(const QKnxByteArray &serviceInfo)

Sets the service information of the local device management frame to serviceInfo. No validation checks are done on the function argument.

See also serviceInformation() and isValid().

void QKnxDeviceManagementFrame::setStartIndex(quint16 index)

Sets the start index within an array-structured property. The first element is placed at the index 1. The array element 0 contains the current number of valid array elements.

See also startIndex().

quint16 QKnxDeviceManagementFrame::size() const

Returns the number of bytes of the local device management frame.

quint16 QKnxDeviceManagementFrame::startIndex() const

Returns the start index within an array-structured property if available; otherwise returns 0.

See also setStartIndex().

void QKnxDeviceManagementFrame::swap(QKnxDeviceManagementFrame &other)

Swaps other with this object. This operation is very fast and never fails.

bool QKnxDeviceManagementFrame::operator!=(const QKnxDeviceManagementFrame &other) const

Returns true if this object and the given other are not equal; otherwise returns false.

bool QKnxDeviceManagementFrame::operator==(const QKnxDeviceManagementFrame &other) const

Returns true if this object and the given other are equal; otherwise returns false.