QCanMessageDescription Class
La classe QCanMessageDescription décrit les règles de traitement d'un message CAN et sa représentation dans un format défini par l'application. Plus d'informations...
| En-tête : | #include <QCanMessageDescription> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS SerialBus)target_link_libraries(mytarget PRIVATE Qt6::SerialBus) |
| qmake : | QT += serialbus |
| Depuis : | Qt 6.5 |
| Statut : | Préliminaire |
Cette classe est en cours de développement et peut être modifiée.
Fonctions publiques
| 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) |
Description détaillée
Un message CAN est essentiellement un QCanBusFrame. La description d'un message CAN comprend les éléments suivants :
- ID du message.
- Nom du message.
- Longueur du message en octets.
- Source du message (émetteur).
- Description des signaux dans le message.
La classe QCanMessageDescription fournit des méthodes pour contrôler tous ces paramètres.
ID du message
L'ID du message est un identifiant unique, qui est utilisé pour sélectionner la description de message appropriée lors du décodage du message entrant QCanBusFrame ou de l'encodage d'un message QCanBusFrame sur la base des données fournies.
Voir la documentation QCanUniqueIdDescription pour plus de détails sur la description de l'identifiant unique.
Description du signal
La description du signal est représentée par la classe QCanSignalDescription. La classe QCanMessageDescription ne fournit qu'une liste de signaux appartenant au message.
Voir également QCanSignalDescription et QCanUniqueIdDescription.
Documentation des fonctions membres
QCanMessageDescription::QCanMessageDescription()
Crée une description de message vide.
QCanMessageDescription::QCanMessageDescription(const QCanMessageDescription &other)
Crée une description de message avec les valeurs copiées à partir de other.
[constexpr noexcept] QCanMessageDescription::QCanMessageDescription(QCanMessageDescription &&other)
Crée une description de message en la déplaçant de other.
Note : L'objet QCanMessageDescription déplacé ne peut être que détruit ou assigné. L'effet de l'appel à d'autres fonctions que le destructeur ou l'un des opérateurs d'affectation n'est pas défini.
[constexpr noexcept] QCanMessageDescription::~QCanMessageDescription()
Détruit la description de ce message.
void QCanMessageDescription::addSignalDescription(const QCanSignalDescription &description)
Ajoute une nouvelle description de signal description à cette description de message.
Si la description du message contient déjà une description de signal pour un signal portant le même nom, elle est écrasée.
Voir également signalDescriptions(), signalDescriptionForName(), setSignalDescriptions() et clearSignalDescriptions().
void QCanMessageDescription::clearSignalDescriptions()
Efface toutes les descriptions de signaux de ce message.
Voir également signalDescriptions(), signalDescriptionForName(), addSignalDescription() et setSignalDescriptions().
QString QCanMessageDescription::comment() const
Renvoie le commentaire du message.
Ce paramètre n'est introduit que pour une description supplémentaire. Il n'est pas utilisé lors de l'encodage ou du décodage des messages.
Voir aussi setComment().
bool QCanMessageDescription::isValid() const
Renvoie true si la description du message est valide et false dans le cas contraire.
Une description de message valide doit comporter au moins une description de signal. Toutes les descriptions de signaux doivent également être valides.
Voir aussi signalDescriptions() et QCanSignalDescription::isValid().
QString QCanMessageDescription::name() const
Renvoie le nom du message CAN.
Ce paramètre n'est introduit que pour une description supplémentaire. Il n'est pas utilisé lors de l'encodage ou du décodage du message.
Voir aussi setName().
void QCanMessageDescription::setComment(const QString &text)
Définit le commentaire du message à text.
Ce paramètre n'est introduit que pour une description supplémentaire. Il n'est pas utilisé lors de l'encodage ou du décodage des messages.
Voir aussi comment().
void QCanMessageDescription::setName(const QString &name)
Définit le nom du message CAN à name.
Ce paramètre n'est introduit qu'à des fins de description supplémentaire. Il n'est pas utilisé lors de l'encodage ou du décodage des messages.
Voir également name().
void QCanMessageDescription::setSignalDescriptions(const QList<QCanSignalDescription> &descriptions)
Définit les descriptions des signaux appartenant à cette description de message sur descriptions.
Remarque : la description du message doit comporter des descriptions de signaux avec des noms de signaux uniques, de sorte que si la liste descriptions contient des entrées avec des noms dupliqués, seule la dernière entrée sera ajoutée.
Voir également signalDescriptions(), signalDescriptionForName(), addSignalDescription() et clearSignalDescriptions().
void QCanMessageDescription::setSize(quint8 size)
Fixe la taille en octets du message CAN à size.
Voir aussi size().
void QCanMessageDescription::setTransmitter(const QString &transmitter)
Définit le nœud émetteur du message à transmitter.
Ce paramètre n'est introduit qu'à des fins de description supplémentaire. Il n'est pas utilisé lors de l'encodage ou du décodage des messages.
Voir aussi transmitter().
void QCanMessageDescription::setUniqueId(QtCanBus::UniqueId id)
Définit l'identifiant unique du message CAN à id.
Voir la section Message ID pour plus d'informations sur l'identifiant unique.
Voir aussi uniqueId().
QCanSignalDescription QCanMessageDescription::signalDescriptionForName(const QString &name) const
Renvoie la description d'un signal portant le nom name.
Si la description du message n'a pas de description de signal, un objet QCanSignalDescription construit par défaut est renvoyé.
Voir aussi signalDescriptions(), addSignalDescription(), setSignalDescriptions() et clearSignalDescriptions().
QList<QCanSignalDescription> QCanMessageDescription::signalDescriptions() const
Renvoie la liste des descriptions de signaux qui appartiennent à cette description de message.
Voir aussi signalDescriptionForName(), addSignalDescription(), setSignalDescriptions() et clearSignalDescriptions().
quint8 QCanMessageDescription::size() const
Renvoie la taille en octets du message CAN.
Voir également setSize().
QString QCanMessageDescription::transmitter() const
Renvoie le nœud émetteur du message.
Ce paramètre n'est introduit que pour une description supplémentaire. Il n'est pas utilisé pendant l'encodage ou le décodage du message.
Voir aussi setTransmitter().
QtCanBus::UniqueId QCanMessageDescription::uniqueId() const
Renvoie l'identifiant unique du message CAN.
Voir la section Message ID pour plus d'informations sur l'identifiant unique.
Voir aussi setUniqueId().
[noexcept] QCanMessageDescription &QCanMessageDescription::operator=(QCanMessageDescription &&other)
Déplacer - assigne les valeurs de other à cette description de message.
Remarque : l'objet QCanMessageDescription déplacé ne peut être que détruit ou affecté. L'effet de l'appel à d'autres fonctions que le destructeur ou l'un des opérateurs d'affectation n'est pas défini.
QCanMessageDescription &QCanMessageDescription::operator=(const QCanMessageDescription &other)
Attribue les valeurs de other à cette description de message.
© 2026 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.
