QKnxGroupAddressInfos Class

Member Function Documentation

QKnxGroupAddressInfos::QKnxGroupAddressInfos(QKnxGroupAddressInfos &&other)

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

QKnxGroupAddressInfos::QKnxGroupAddressInfos(const QKnxGroupAddressInfos &other)

Constructs a copy of other.

QKnxGroupAddressInfos::QKnxGroupAddressInfos(const QString &projectFile)

Creates a new empty group address infos object and sets the current project file to projectFile. Creating the object does not automatically trigger parsing the given projectFile.

The function argument can be either a valid KNX 0.xml or a .knxproj project file.

See also parse().

QKnxGroupAddressInfos::QKnxGroupAddressInfos()

Creates a new empty group address infos object.

QKnxGroupAddressInfos &QKnxGroupAddressInfos::operator=(QKnxGroupAddressInfos &&other)

Move-assigns other to this object instance.

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

Assigns the specified other to this object.

QKnxGroupAddressInfos::~QKnxGroupAddressInfos()

Destroys the object and frees any allocated resources.

void QKnxGroupAddressInfos::add(const QKnxGroupAddressInfo &info, const QString &projectId)

Adds a group address info object of a KNX project identified by projectId. The group address info QKnxGroupAddressInfo::installation ID is used to associate the group address info with an existing KNX project.

void QKnxGroupAddressInfos::add(const QString &name, const QKnxAddress &address, QKnxDatapointType::Type type, const QString &description, const QString &projectId, const QString &installation = {})

Creates a group address info object with values set to name, address, type, description and installation. The created object is associated with the given KNX projectId ID, and installation.

void QKnxGroupAddressInfos::add(const QString &name, const QKnxAddress &address, const QString &datapointType, const QString &description, const QString &projectId, const QString &installation = {})

Creates a group address info object with values set to name, address, datapointType, description and installation. The created object is associated with the given KNX projectId ID, and installation.

QVector<QKnxGroupAddressInfo> QKnxGroupAddressInfos::addressInfos(const QString &projectId, const QString &installation = {}) const

Returns a vector of all available group address infos from a KNX project identified by projectId and installation.

QVector<QKnxGroupAddressInfo> QKnxGroupAddressInfos::addressInfos(const QKnxAddress &address, const QString &projectId, const QString &installation = {}) const

Returns a vector of all available group address infos from a KNX project identified by address, projectId, and installation.

QVector<QKnxGroupAddressInfo> QKnxGroupAddressInfos::addressInfos(QKnxDatapointType::Type type, const QString &projectId, const QString &installation = {}) const

Returns a vector of all available group address infos from a KNX project identified by datapoint type, projectId and installation.

void QKnxGroupAddressInfos::clear()

Clears all existing information including the KNX project file name.

QString QKnxGroupAddressInfos::errorString() const

Returns the human-readable message appropriate to the reported read status.

qint32 QKnxGroupAddressInfos::infoCount(const QString &projectId, const QString &installation = {}) const

Returns the number of group address info objects contained in this class; identified by projectId and installation.

QVector<QString> QKnxGroupAddressInfos::installations(const QString &projectId) const

Returns a vector of all installation ids for the given KNX projectId ID.

bool QKnxGroupAddressInfos::parse()

Clears all existing information and parses the KNX project file.

Returns true if parsing was successful; otherwise returns false. If an error occurs, sets the Status, and fills the errorString().

QString QKnxGroupAddressInfos::projectFile() const

Returns the current project file from where the group address information was collected.

See also setProjectFile().

QVector<QString> QKnxGroupAddressInfos::projectIds() const

Returns a vector of all KNX project ids found in the KNX project file.

QString QKnxGroupAddressInfos::projectName(const QString &projectId) const

Returns the project name associated with the given KNX projectId ID. Since the project name is an optional field in a KNX project, it can be empty.

void QKnxGroupAddressInfos::remove(const QKnxAddress &address, const QString &projectId, const QString &installation = {})

Removes all the group address info objects from a KNX project identified by projectId and installation ID and with the same KNX group address.

void QKnxGroupAddressInfos::remove(const QKnxGroupAddressInfo &info, const QString &projectId)

Removes all the objects equal to group address info from a KNX project identified by projectId. The group address info QKnxGroupAddressInfo::installation ID is used to associate the group address info with an existing KNX project.

void QKnxGroupAddressInfos::setProjectFile(const QString &projectFile)

Sets the current project file to projectFile and clears all existing information. Calling this function does not automatically trigger parsing the given projectFile.

The function argument can be either a valid KNX 0.xml or a .knxproj project file.

See also projectFile() and parse().

QKnxGroupAddressInfos::Status QKnxGroupAddressInfos::status() const

Returns the read status of the current KNX project file.

void QKnxGroupAddressInfos::swap(QKnxGroupAddressInfos &other)

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

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

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

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

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