QKnxLinkLayerFrame Class

Member Function Documentation

QKnxLinkLayerFrame::QKnxLinkLayerFrame(QKnxLinkLayerFrame &&other)

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

QKnxLinkLayerFrame::QKnxLinkLayerFrame(const QKnxLinkLayerFrame &other)

Constructs a copy of other.

QKnxLinkLayerFrame::QKnxLinkLayerFrame(QKnxLinkLayerFrame::MessageCode messageCode, const QKnxByteArray &serviceInfo)

Constructs a link layer frame starting with messageCode and sets the service information to serviceInfo.

The medium type is set to QKnx::MediumType NetIP.

See also setMediumType().

QKnxLinkLayerFrame::QKnxLinkLayerFrame(QKnxLinkLayerFrame::MessageCode messageCode)

Constructs a link layer frame starting with messageCode. The medium type is set to QKnx::MediumType NetIP.

See also setMediumType().

QKnxLinkLayerFrame::QKnxLinkLayerFrame()

Constructs an empty link layer frame with the medium type set to QKnx::MediumType NetIP.

See also setMediumType().

QKnxLinkLayerFrame &QKnxLinkLayerFrame::operator=(QKnxLinkLayerFrame &&other)

Move-assigns other to this object instance.

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

Assigns the specified other to this object.

QKnxLinkLayerFrame::~QKnxLinkLayerFrame()

Destroys the link layer management frame and frees all allocated resources.

void QKnxLinkLayerFrame::addAdditionalInfo(const QKnxAdditionalInfo &info)

Adds the KNX additional info parameter info to the additional information field. The information is sorted in ascending order based on its type.

See also QKnxAdditionalInfo and QKnxAdditionalInfo::type().

QVector<QKnxAdditionalInfo> QKnxLinkLayerFrame::additionalInfos() const

Returns a vector of additional information contained in the frame.

See also QKnxAdditionalInfo.

quint8 QKnxLinkLayerFrame::additionalInfosSize() const

Returns the size in bytes of the whole additional information field.

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

Returns an instance of a generic link layer frame builder.

QKnxByteArray QKnxLinkLayerFrame::bytes() const

Returns an array of bytes that represent the link layer frame if it is valid; otherwise returns a default-constructed frame.

void QKnxLinkLayerFrame::clearAdditionalInfos()

Removes all additional information from the frame.

QKnxControlField QKnxLinkLayerFrame::controlField() const

Returns the control field of the frame.

See also setControlField().

const QKnxAddress QKnxLinkLayerFrame::destinationAddress() const

Returns the destination address.

See also setDestinationAddress().

QKnxExtendedControlField QKnxLinkLayerFrame::extendedControlField() const

Returns the extended control field of the frame.

See also setExtendedControlField().

[static] QKnxLinkLayerFrame QKnxLinkLayerFrame::fromBytes(const QKnxByteArray &data, quint16 index, quint16 size, QKnx::MediumType mediumType = QKnx::MediumType::NetIP)

Constructs a link layer frame from the byte array data starting at the position index inside the array using the number of bytes specified by size. Sets the medium type of the frame to mediumType

bool QKnxLinkLayerFrame::isValid() const

Returns true if the link layer frame is valid, returns false otherwise.

QKnx::MediumType QKnxLinkLayerFrame::mediumType() const

Returns the medium type to be used to send the link layer frame.

See also setMediumType().

QKnxLinkLayerFrame::MessageCode QKnxLinkLayerFrame::messageCode() const

Returns the message code of the link layer frame.

See also setMessageCode().

void QKnxLinkLayerFrame::removeAdditionalInfo(QKnxAdditionalInfo::Type type)

Removes all additional information of the type type.

See also QKnxAdditionalInfo and QKnxAdditionalInfo::Type.

void QKnxLinkLayerFrame::removeAdditionalInfo(const QKnxAdditionalInfo &info)

Removes the first occurrence of the additional information info from the frame's additional information field.

See also QKnxAdditionalInfo.

QKnxByteArray QKnxLinkLayerFrame::serviceInformation() const

Returns the service information the frame carries. This is the frame without the message code.

See also setServiceInformation().

void QKnxLinkLayerFrame::setControlField(const QKnxControlField &controlField)

Sets the control field of the frame to controlField.

See also controlField().

void QKnxLinkLayerFrame::setDestinationAddress(const QKnxAddress &destination)

Sets the destination address to destination.

See also destinationAddress().

void QKnxLinkLayerFrame::setExtendedControlField(const QKnxExtendedControlField &controlFieldEx)

Sets the extended control field of the frame to controlFieldEx.

See also extendedControlField().

void QKnxLinkLayerFrame::setMediumType(QKnx::MediumType type)

Sets the medium type to be used to send the LinkLayer frame to type.

See also mediumType().

void QKnxLinkLayerFrame::setMessageCode(QKnxLinkLayerFrame::MessageCode code)

Sets the message code of the link layer frame to code.

See also messageCode().

void QKnxLinkLayerFrame::setServiceInformation(const QKnxByteArray &data)

Sets the service information based on a byte array with all the fields encoded into it to data.

See also serviceInformation().

void QKnxLinkLayerFrame::setSourceAddress(const QKnxAddress &source)

Sets the source address to source.

See also sourceAddress().

void QKnxLinkLayerFrame::setTpdu(const QKnxTpdu &tpdu)

Sets the TPDU of the frame to tpdu. The TPDU is read by the network, transport, and application layer services.

See also tpdu().

quint16 QKnxLinkLayerFrame::size() const

Returns the number of bytes of the link layer frame.

const QKnxAddress QKnxLinkLayerFrame::sourceAddress() const

Returns the source address.

See also setSourceAddress().

void QKnxLinkLayerFrame::swap(QKnxLinkLayerFrame &other)

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

QKnxTpdu QKnxLinkLayerFrame::tpdu() const

Returns the TPDU of the frame. The TPDU is read by the network, transport, and application layer services.

See also setTpdu().

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

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

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

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