QKnxGroupAddressInfo Class

The QKnxGroupAddressInfo class contains information about a single KNX group address object used inside a KNX installation. More...

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

Public Functions

QKnxGroupAddressInfo(QKnxGroupAddressInfo &&other)
QKnxGroupAddressInfo(const QKnxGroupAddressInfo &other)
QKnxGroupAddressInfo(const QString &installation, const QString &name, const QKnxAddress &address, const QString &datapointType, const QString &description = {})
QKnxGroupAddressInfo(const QString &installation, const QString &name, const QKnxAddress &address, QKnxDatapointType::Type type, const QString &description = {})
QKnxGroupAddressInfo(const QString &installation, const QString &name, quint16 address, const QString &datapointType, const QString &description = {})
QKnxGroupAddressInfo(const QString &installation, const QString &name, quint16 address, QKnxDatapointType::Type type, const QString &description = {})
QKnxGroupAddressInfo()
QKnxGroupAddressInfo &operator=(QKnxGroupAddressInfo &&other)
QKnxGroupAddressInfo &operator=(const QKnxGroupAddressInfo &other)
~QKnxGroupAddressInfo()
QKnxAddress address() const
QKnxDatapointType::Type datapointType() const
QString description() const
QString installation() const
bool isValid() const
QString name() const
void setAddress(const QKnxAddress &address)
void setDatapointType(QKnxDatapointType::Type type)
void setDescription(const QString &description)
void setInstallation(const QString &installation)
void setName(const QString &name)
void swap(QKnxGroupAddressInfo &other)
bool operator!=(const QKnxGroupAddressInfo &other) const
bool operator==(const QKnxGroupAddressInfo &other) const
QDebug operator<<(QDebug debug, const QKnxGroupAddressInfo &info)

Detailed Description

The information contained in this class corresponds to the information described by the GroupRange_t/GroupAddress XML element in the KNX Project-Schema XML file.

Note: Not all GroupRange_t/GroupAddress attributes are reflected by the API.

Member Function Documentation

QKnxGroupAddressInfo::QKnxGroupAddressInfo(QKnxGroupAddressInfo &&other)

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

QKnxGroupAddressInfo::QKnxGroupAddressInfo(const QKnxGroupAddressInfo &other)

Constructs a copy of other.

QKnxGroupAddressInfo::QKnxGroupAddressInfo(const QString &installation, const QString &name, const QKnxAddress &address, const QString &datapointType, const QString &description = {})

Creates a new group address info object and sets the installation, name, KNX group address, the corresponding datapoint type datapointType, and the object description.

QKnxGroupAddressInfo::QKnxGroupAddressInfo(const QString &installation, const QString &name, const QKnxAddress &address, QKnxDatapointType::Type type, const QString &description = {})

Creates a new group address info object and sets the installation, name, KNX group address, the corresponding datapoint type, and the object description.

QKnxGroupAddressInfo::QKnxGroupAddressInfo(const QString &installation, const QString &name, quint16 address, const QString &datapointType, const QString &description = {})

Creates a new group address info object and sets the installation, name, KNX group address, the corresponding datapoint type datapointType, and the object description.

QKnxGroupAddressInfo::QKnxGroupAddressInfo(const QString &installation, const QString &name, quint16 address, QKnxDatapointType::Type type, const QString &description = {})

Creates a new group address info object and sets the installation, name, KNX group address, the corresponding datapoint type, and the object description.

QKnxGroupAddressInfo::QKnxGroupAddressInfo()

Creates a new empty group address info object.

QKnxGroupAddressInfo &QKnxGroupAddressInfo::operator=(QKnxGroupAddressInfo &&other)

Move-assigns other to this object instance.

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

Assigns the specified other to this object.

QKnxGroupAddressInfo::~QKnxGroupAddressInfo()

Destroys the object and frees any allocated resources.

QKnxAddress QKnxGroupAddressInfo::address() const

Returns the KNX address of this group address info object.

See also setAddress().

QKnxDatapointType::Type QKnxGroupAddressInfo::datapointType() const

Returns the datapoint type of this group address info object. If the datapoint is not set, it will return QKnxDatapointType::Unknown.

See also setDatapointType().

QString QKnxGroupAddressInfo::description() const

Returns the description of this group address info object. The value can be empty.

See also setDescription().

QString QKnxGroupAddressInfo::installation() const

Returns the name of the installation this group address info object belongs to. The value can be empty.

See also setInstallation().

bool QKnxGroupAddressInfo::isValid() const

Returns true if the object is non-empty and valid; otherwise returns false.

A valid object has a KNX address of the type QKnxAddress::Group set.

QString QKnxGroupAddressInfo::name() const

Returns the name of this group address info object. The value can be empty.

See also setName().

void QKnxGroupAddressInfo::setAddress(const QKnxAddress &address)

Sets the KNX address of this group address info object. The address must be of type QKnxAddress::Group to keep the object valid.

See also address() and isValid.

void QKnxGroupAddressInfo::setDatapointType(QKnxDatapointType::Type type)

Sets the datapoint type of this group address info object.

See also datapointType().

void QKnxGroupAddressInfo::setDescription(const QString &description)

Sets the description of this group address info object to description. The value can be empty.

See also description().

void QKnxGroupAddressInfo::setInstallation(const QString &installation)

Sets the name of the installation this group address info object belongs to. The value can be empty.

See also installation().

void QKnxGroupAddressInfo::setName(const QString &name)

Sets the name of this group address info object. The value can be empty.

See also name().

void QKnxGroupAddressInfo::swap(QKnxGroupAddressInfo &other)

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

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

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

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

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

Related Non-Members

QDebug operator<<(QDebug debug, const QKnxGroupAddressInfo &info)

Writes the info object to the debug stream and returns a reference to the stream.