QKnxNetIpTunnelingSlotInfo Class

The QKnxNetIpTunnelingSlotInfo class contains information about the individual address that is currently assigned to the tunneling slot as well as the current state of the tunneling slot. More...

Header: #include <QKnxNetIpTunnelingSlotInfo>
qmake: QT += knx
Since: Qt 5.12

Public Types

enum State { NotAvailable, Free, Authorized, Usable, Available }
flags Status

Public Functions

QKnxNetIpTunnelingSlotInfo()
QKnxNetIpTunnelingSlotInfo(const QKnxAddress &ia)
QKnxNetIpTunnelingSlotInfo(const QKnxAddress &ia, QKnxNetIpTunnelingSlotInfo::Status status)
QKnxNetIpTunnelingSlotInfo(const QKnxNetIpTunnelingSlotInfo &other)
QKnxNetIpTunnelingSlotInfo(QKnxNetIpTunnelingSlotInfo &&other)
~QKnxNetIpTunnelingSlotInfo()
QKnxByteArray bytes() const
QKnxAddress individualAddress() const
bool isValid() const
void setIndividualAddress(const QKnxAddress &ia)
void setStatus(QKnxNetIpTunnelingSlotInfo::Status status)
QKnxNetIpTunnelingSlotInfo::Status status() const
void swap(QKnxNetIpTunnelingSlotInfo &other)
bool operator!=(const QKnxNetIpTunnelingSlotInfo &other) const
QKnxNetIpTunnelingSlotInfo &operator=(const QKnxNetIpTunnelingSlotInfo &other)
QKnxNetIpTunnelingSlotInfo &operator=(QKnxNetIpTunnelingSlotInfo &&other)
bool operator==(const QKnxNetIpTunnelingSlotInfo &other) const

Static Public Members

QKnxNetIpTunnelingSlotInfo fromBytes(const QKnxByteArray &data, quint16 index)

Detailed Description

The QKnxNetIpTunnelingSlotInfo class contains information about the individual address that is currently assigned to the tunneling slot as well as the current state of the tunneling slot.

If a KNXnet/IP server supports tunneling, it can send more detailed information about the supported tunnel connections. The tunneling slot info class can be used to represent this information. Usually it includes the individual addresses used for the connection once it has been established and whether the connection slot is available at all.

See also QKnxNetIpTunnelingInfoDibProxy, Qt KNX Tunneling Classes, and Qt KNXnet/IP Connection Classes.

Member Type Documentation

enum QKnxNetIpTunnelingSlotInfo::State
flags QKnxNetIpTunnelingSlotInfo::Status

This enumeration describes the current state of the tunneling slot. Only if all values are set, the slot is available for a KNXnet/IP client connection.

ConstantValueDescription
QKnxNetIpTunnelingSlotInfo::NotAvailable0x00000000Indicates that the slot is not available for a KNXnet/IP client connection.
QKnxNetIpTunnelingSlotInfo::Free0x00000001Indicates whether this tunneling slot is currently free or not.
QKnxNetIpTunnelingSlotInfo::Authorized0x00000002Indications about the authorization of this tunneling slot.
QKnxNetIpTunnelingSlotInfo::Usable0x00000004Indicates whether this tunneling slot is currently usable or not.
QKnxNetIpTunnelingSlotInfo::AvailableFree | Authorized | UsableIndicates that the slot is available for a KNXnet/IP client connection.

The Status type is a typedef for QFlags<State>. It stores an OR combination of State values.

Member Function Documentation

QKnxNetIpTunnelingSlotInfo::QKnxNetIpTunnelingSlotInfo()

Creates a new empty invalid tunneling slot information object.

QKnxNetIpTunnelingSlotInfo::QKnxNetIpTunnelingSlotInfo(const QKnxAddress &ia)

Creates a tunneling slot information object with the individual address set to ia and the status field set to NotAvailable.

QKnxNetIpTunnelingSlotInfo::QKnxNetIpTunnelingSlotInfo(const QKnxAddress &ia, QKnxNetIpTunnelingSlotInfo::Status status)

Creates a tunneling slot information object with the individual address set to ia and the status field set to status.

QKnxNetIpTunnelingSlotInfo::QKnxNetIpTunnelingSlotInfo(const QKnxNetIpTunnelingSlotInfo &other)

Constructs a copy of other.

QKnxNetIpTunnelingSlotInfo::QKnxNetIpTunnelingSlotInfo(QKnxNetIpTunnelingSlotInfo &&other)

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

QKnxNetIpTunnelingSlotInfo::~QKnxNetIpTunnelingSlotInfo()

Destroys the object and frees any allocated resources.

QKnxByteArray QKnxNetIpTunnelingSlotInfo::bytes() const

Returns an array of data that represents the tunneling information slot object.

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

Constructs the tunneling information slot object from the byte array data starting at the position index inside the array.

QKnxAddress QKnxNetIpTunnelingSlotInfo::individualAddress() const

Returns the individual address of the tunneling information slot object.

See also setIndividualAddress().

bool QKnxNetIpTunnelingSlotInfo::isValid() const

Returns true if the tunneling slot information is valid; otherwise returns false. The object is considered valid if the individual address is valid and the status field is properly set.

void QKnxNetIpTunnelingSlotInfo::setIndividualAddress(const QKnxAddress &ia)

Sets the individual address of the tunneling information slot object to ia if the passed argument is a valid QKnxAddress and of type QKnxAddress::Individual.

See also individualAddress().

void QKnxNetIpTunnelingSlotInfo::setStatus(QKnxNetIpTunnelingSlotInfo::Status status)

Sets the status of the tunneling information slot object to status if the passed argument is a valid.

See also status().

QKnxNetIpTunnelingSlotInfo::Status QKnxNetIpTunnelingSlotInfo::status() const

Returns the status of the tunneling information slot object.

See also setStatus().

void QKnxNetIpTunnelingSlotInfo::swap(QKnxNetIpTunnelingSlotInfo &other)

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

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

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

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

Assigns the specified other to this object.

QKnxNetIpTunnelingSlotInfo &QKnxNetIpTunnelingSlotInfo::operator=(QKnxNetIpTunnelingSlotInfo &&other)

Move-assigns other to this object instance.

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

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

© 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.