QCanMessageDescription Class
Die Klasse QCanMessageDescription beschreibt die Regeln zur Verarbeitung einer CAN-Nachricht und deren Darstellung in einem anwendungsspezifischen Format. Mehr...
Kopfzeile: | #include <QCanMessageDescription> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS SerialBus) target_link_libraries(mytarget PRIVATE Qt6::SerialBus) |
qmake: | QT += serialbus |
Seit: | Qt 6.5 |
Status: | Vorläufig |
Diese Klasse befindet sich in der Entwicklung und kann sich noch ändern.
Öffentliche Funktionen
QCanMessageDescription() | |
QCanMessageDescription(const QCanMessageDescription &other) | |
QCanMessageDescription(QCanMessageDescription &&other) | |
~QCanMessageDescription() | |
void | addSignalDescription(const QCanSignalDescription &description) |
void | clearSignalDescriptions() |
QString | comment() const |
bool | isValid() const |
QString | name() const |
void | setComment(const QString &text) |
void | setName(const QString &name) |
void | setSignalDescriptions(const QList<QCanSignalDescription> &descriptions) |
void | setSize(quint8 size) |
void | setTransmitter(const QString &transmitter) |
void | setUniqueId(QtCanBus::UniqueId id) |
QCanSignalDescription | signalDescriptionForName(const QString &name) const |
QList<QCanSignalDescription> | signalDescriptions() const |
quint8 | size() const |
QString | transmitter() const |
QtCanBus::UniqueId | uniqueId() const |
QCanMessageDescription & | operator=(QCanMessageDescription &&other) |
QCanMessageDescription & | operator=(const QCanMessageDescription &other) |
Detaillierte Beschreibung
Eine CAN-Nachricht ist im Grunde eine QCanBusFrame. Die Beschreibung einer CAN-Nachricht umfasst Folgendes:
- Nachrichten-ID.
- Name der Nachricht.
- Nachrichtenlänge in Bytes.
- Quelle der Nachricht (Sender).
- Beschreibung der Signale in der Nachricht.
Die Klasse QCanMessageDescription bietet Methoden zur Steuerung all dieser Parameter.
Nachrichten-ID
Die Nachrichten-ID ist ein eindeutiger Bezeichner, der zur Auswahl der richtigen Nachrichtenbeschreibung bei der Dekodierung der eingehenden QCanBusFrame oder der Kodierung einer QCanBusFrame auf der Grundlage der bereitgestellten Daten verwendet wird.
Weitere Einzelheiten zur Beschreibung des eindeutigen Bezeichners finden Sie in der Dokumentation QCanUniqueIdDescription.
Signalbeschreibung
Die Signalbeschreibung wird durch die Klasse QCanSignalDescription dargestellt. Die Klasse QCanMessageDescription liefert nur eine Liste der Signale, die zur Nachricht gehören.
Siehe auch QCanSignalDescription und QCanUniqueIdDescription.
Dokumentation der Mitgliedsfunktionen
QCanMessageDescription::QCanMessageDescription()
Erzeugt eine leere Nachrichtenbeschreibung.
QCanMessageDescription::QCanMessageDescription(const QCanMessageDescription &other)
Erstellt eine Nachrichtenbeschreibung mit den aus other kopierten Werten.
[noexcept]
QCanMessageDescription::QCanMessageDescription(QCanMessageDescription &&other)
Erzeugt eine Nachrichtenbeschreibung durch Verschieben von other.
Hinweis: Das "moved-from"-Objekt QCanMessageDescription kann nur zerstört oder zugewiesen werden. Die Wirkung des Aufrufs anderer Funktionen als des Destruktors oder eines der Zuweisungsoperatoren ist undefiniert.
[noexcept]
QCanMessageDescription::~QCanMessageDescription()
Zerstört die Beschreibung dieser Nachricht.
void QCanMessageDescription::addSignalDescription(const QCanSignalDescription &description)
Fügt eine neue Signalbeschreibung description zu dieser Nachrichtenbeschreibung hinzu.
Wenn die Nachrichtenbeschreibung bereits eine Signalbeschreibung für ein Signal mit demselben Namen enthält, wird diese überschrieben.
Siehe auch signalDescriptions(), signalDescriptionForName(), setSignalDescriptions(), und clearSignalDescriptions().
void QCanMessageDescription::clearSignalDescriptions()
Löscht alle Signalbeschreibungen dieser Nachricht.
Siehe auch signalDescriptions(), signalDescriptionForName(), addSignalDescription(), und setSignalDescriptions().
QString QCanMessageDescription::comment() const
Gibt den Kommentar für die Nachricht zurück.
Dieser Parameter wird nur zur zusätzlichen Beschreibung eingeführt. Er wird nicht während der Kodierung oder Dekodierung der Nachricht verwendet.
Siehe auch setComment().
bool QCanMessageDescription::isValid() const
Gibt true
zurück, wenn die Nachrichtenbeschreibung gültig ist, und andernfalls false
.
Eine gültige Nachrichtenbeschreibung muss mindestens eine Signalbeschreibung enthalten. Alle Signalbeschreibungen müssen ebenfalls gültig sein.
Siehe auch signalDescriptions() und QCanSignalDescription::isValid().
QString QCanMessageDescription::name() const
Gibt den Namen der CAN-Nachricht zurück.
Dieser Parameter wird nur zur zusätzlichen Beschreibung eingeführt. Er wird nicht während der Kodierung oder Dekodierung der Nachricht verwendet.
Siehe auch setName().
void QCanMessageDescription::setComment(const QString &text)
Setzt den Kommentar für die Nachricht auf text.
Dieser Parameter wird nur zur zusätzlichen Beschreibung eingeführt. Er wird nicht während der Kodierung oder Dekodierung der Nachricht verwendet.
Siehe auch comment().
void QCanMessageDescription::setName(const QString &name)
Setzt den Namen der CAN-Nachricht auf name.
Dieser Parameter wird nur zur zusätzlichen Beschreibung eingeführt. Er wird nicht während der Nachrichtenkodierung oder -dekodierung verwendet.
Siehe auch name().
void QCanMessageDescription::setSignalDescriptions(const QList<QCanSignalDescription> &descriptions)
Setzt die Beschreibungen der Signale, die zu dieser Nachrichtenbeschreibung gehören, auf descriptions.
Hinweis: Nachrichtenbeschreibungen müssen Signalbeschreibungen mit eindeutigen Signalnamen haben. Wenn die Liste descriptions also Einträge mit doppelten Namen enthält, wird nur der letzte Eintrag hinzugefügt.
Siehe auch signalDescriptions(), signalDescriptionForName(), addSignalDescription(), und clearSignalDescriptions().
void QCanMessageDescription::setSize(quint8 size)
Setzt die Größe der CAN-Nachricht in Bytes auf size.
Siehe auch size().
void QCanMessageDescription::setTransmitter(const QString &transmitter)
Setzt den Senderknoten der Nachricht auf transmitter.
Dieser Parameter wird nur zur zusätzlichen Beschreibung eingeführt. Er wird nicht während der Kodierung oder Dekodierung der Nachricht verwendet.
Siehe auch transmitter().
void QCanMessageDescription::setUniqueId(QtCanBus::UniqueId id)
Setzt den eindeutigen Identifier der CAN-Nachricht auf id.
Weitere Informationen über den eindeutigen Bezeichner finden Sie im Abschnitt Message ID.
Siehe auch uniqueId().
QCanSignalDescription QCanMessageDescription::signalDescriptionForName(const QString &name) const
Gibt die Signalbeschreibung eines Signals mit dem Namen name zurück.
Wenn die Nachrichtenbeschreibung keine solche Signalbeschreibung enthält, wird ein standardmäßig konstruiertes QCanSignalDescription Objekt zurückgegeben.
Siehe auch signalDescriptions(), addSignalDescription(), setSignalDescriptions(), und clearSignalDescriptions().
QList<QCanSignalDescription> QCanMessageDescription::signalDescriptions() const
Gibt die Liste der Signalbeschreibungen zurück, die zu dieser Nachrichtenbeschreibung gehören.
Siehe auch signalDescriptionForName(), addSignalDescription(), setSignalDescriptions(), und clearSignalDescriptions().
quint8 QCanMessageDescription::size() const
Gibt die Größe der CAN-Nachricht in Bytes zurück.
Siehe auch setSize().
QString QCanMessageDescription::transmitter() const
Gibt den Senderknoten der Nachricht zurück.
Dieser Parameter wird nur zur zusätzlichen Beschreibung eingeführt. Er wird nicht während der Kodierung oder Dekodierung der Nachricht verwendet.
Siehe auch setTransmitter().
QtCanBus::UniqueId QCanMessageDescription::uniqueId() const
Gibt den eindeutigen Bezeichner der CAN-Nachricht zurück.
Weitere Informationen zum eindeutigen Identifier finden Sie im Abschnitt Message ID.
Siehe auch setUniqueId().
[noexcept]
QCanMessageDescription &QCanMessageDescription::operator=(QCanMessageDescription &&other)
Verschieben - ordnet die Werte von other dieser Nachrichtenbeschreibung zu.
Hinweis: Das von QCanMessageDescription verschobene Objekt kann nur zerstört oder zugewiesen werden. Die Auswirkungen des Aufrufs anderer Funktionen als des Destruktors oder eines der Zuweisungsoperatoren sind undefiniert.
QCanMessageDescription &QCanMessageDescription::operator=(const QCanMessageDescription &other)
Weist dieser Nachrichtenbeschreibung die Werte von other zu.
© 2025 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.