QKnxNetIpServiceFamiliesDibProxy Class

The QKnxNetIpServiceFamiliesDibProxy class provides the means to read the supported service families and versions from the generic QKnxNetIpDib class and to create a KNXnet/IP device information block (DIB) structure based on the information. More...

Header: #include <QKnxNetIpServiceFamiliesDibProxy>
qmake: QT += knx

Public Types

class Builder

Public Functions

QKnxNetIpServiceFamiliesDibProxy(const QKnxNetIpDib &dib)
QKnxNetIp::DescriptionType descriptionType() const
bool isValid() const
QVector<QKnxServiceInfo> serviceInfos() const

Static Public Members

QKnxNetIpServiceFamiliesDibProxy::Builder builder()

Detailed Description

The QKnxNetIpServiceFamiliesDibProxy class provides the means to read the supported service families and versions from the generic QKnxNetIpDib class and to create a KNXnet/IP device information block (DIB) structure based on the information.

A KNXnet/IP supported service families DIB structure contains a set of supported services and their corresponding versions. The service family is the high octet of the service type ID and the service family version is an integer representing the service family version. It refers to the version of the corresponding KNXnet/IP document, not to the manufacturer's implemented version.

Note: When using QKnxNetIpServiceFamiliesDibProxy, care must be taken to ensure that the referenced KNXnet/IP DIB structure outlives the proxy on all code paths, lest the proxy ends up referencing deleted data.

Reading the supported service families can be achieved like this:

auto dib = QKnxNetIpDib::fromBytes(...);

QKnxNetIpServiceFamiliesDibProxy proxy(dib);
if (!proxy.isValid())
    return;

auto infos = proxy.serviceInfos();

See also builder() and Qt KNXnet/IP Connection Classes.

Member Function Documentation

QKnxNetIpServiceFamiliesDibProxy::QKnxNetIpServiceFamiliesDibProxy(const QKnxNetIpDib &dib)

Constructs a proxy object with the specified KNXnet/IP DIB structure dib to read the supported service families and versions.

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

Returns a builder object to create a KNXnet/IP service families DIB structure.

QKnxNetIp::DescriptionType QKnxNetIpServiceFamiliesDibProxy::descriptionType() const

Returns the description type of this KNXnet/IP structure if the object that was passed during construction was valid; otherwise returns QKnx::NetIp::Unknown.

bool QKnxNetIpServiceFamiliesDibProxy::isValid() const

Returns true if the KNXnet/IP structure to create the object is a valid KNXnet/IP DIB structure; otherwise returns false.

QVector<QKnxServiceInfo> QKnxNetIpServiceFamiliesDibProxy::serviceInfos() const

Returns a vector of the QKnxServiceInfo carried by this KNXnet/IP DIB structure if the object that was passed during construction was valid; otherwise returns an empty vector.

© 2018 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.