QCanMessageDescription Class
La classe QCanMessageDescription définit les règles permettant de traiter un message CAN et de le représenter dans un format défini par l'application. En savoir plus...
| 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 : | Aperçu technologique |
Cette classe est en avant-première technologique et est susceptible d'ê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 contenus dans le message.
La classe QCanMessageDescription fournit des méthodes permettant de contrôler tous ces paramètres.
ID du message
L'ID du message est un identifiant unique, utilisé pour sélectionner la description de message appropriée lors du décodage de l'QCanBusFrame e entrant ou lors de l'encodage d'une QCanBusFrame e à partir des données fournies.
Consultez la documentation d’ 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` fournit uniquement une liste des signaux appartenant au message.
Voir également QCanSignalDescription et QCanUniqueIdDescription.
Documentation sur les fonctions membres
QCanMessageDescription::QCanMessageDescription()
Crée une description de message vide.
QCanMessageDescription::QCanMessageDescription(const QCanMessageDescription &other)
Crée une description de message à partir des valeurs copiées depuis other.
[constexpr noexcept default] QCanMessageDescription::QCanMessageDescription(QCanMessageDescription &&other)
Crée une description de message à partir de l'objet ` other`.
Remarque : l'objet QCanMessageDescription issu de la copie ne peut être ni détruit ni affecté. L'effet de l'appel de fonctions autres que le destructeur ou l'un des opérateurs d'affectation est indéfini.
[constexpr noexcept default] QCanMessageDescription::~QCanMessageDescription()
Supprime 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 portant le même nom, celle-ci est écrasée.
Voir également signalDescriptions(), signalDescriptionForName(), setSignalDescriptions() et clearSignalDescriptions().
void QCanMessageDescription::clearSignalDescriptions()
Efface toutes les descriptions de signal de ce message.
Voir également signalDescriptions(), signalDescriptionForName(), addSignalDescription() et setSignalDescriptions().
QString QCanMessageDescription::comment() const
Renvoie le commentaire associé au message.
Ce paramètre est fourni uniquement à titre d'information complémentaire. Il n'est pas utilisé lors de l'encodage ou du décodage du message.
Voir également 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 signal doivent également être valides.
Voir également signalDescriptions() et QCanSignalDescription::isValid().
QString QCanMessageDescription::name() const
Renvoie le nom du message CAN.
Ce paramètre est fourni uniquement à titre d'information complémentaire. Il n'est pas utilisé lors de l'encodage ou du décodage du message.
Voir également setName().
void QCanMessageDescription::setComment(const QString &text)
Définit le commentaire du message sur « text ».
Ce paramètre est fourni uniquement à titre de description supplémentaire. Il n'est pas utilisé lors de l'encodage ou du décodage du message.
Voir également comment().
void QCanMessageDescription::setName(const QString &name)
Définit le nom du message CAN sur « name ».
Ce paramètre est fourni à titre indicatif uniquement. Il n’est pas utilisé lors du codage ou du décodage des messages.
Voir également name().
void QCanMessageDescription::setSignalDescriptions(const QList<QCanSignalDescription> &descriptions)
Définit les descriptions des signaux associés à cette description de message sur descriptions.
Remarque : la descriptiondu message doit comporter des descriptions de signaux dont les noms sont uniques ; par conséquent, si la liste descriptions contient des entrées dont les noms sont en double, seule la dernière entrée sera ajoutée.
Voir également signalDescriptions(), signalDescriptionForName(), addSignalDescription() et clearSignalDescriptions().
void QCanMessageDescription::setSize(quint8 size)
Définit la taille en octets du message CAN sur size.
Voir également size().
void QCanMessageDescription::setTransmitter(const QString &transmitter)
Définit le nœud émetteur du message sur transmitter.
Ce paramètre est fourni uniquement à titre d'information complémentaire. Il n'est pas utilisé lors du codage ou du décodage du message.
Voir également transmitter().
void QCanMessageDescription::setUniqueId(QtCanBus::UniqueId id)
Définit l'identifiant unique du message CAN sur « id ».
Pour plus d'informations sur l'identifiant unique, consultez la section Message ID.
Voir également uniqueId().
QCanSignalDescription QCanMessageDescription::signalDescriptionForName(const QString &name) const
Renvoie la description d'un signal nommé « name ».
Si la description du message ne contient pas cette description de signal, un objet ` QCanSignalDescription ` construit par défaut est renvoyé.
Voir également signalDescriptions(), addSignalDescription(), setSignalDescriptions() et clearSignalDescriptions().
QList<QCanSignalDescription> QCanMessageDescription::signalDescriptions() const
Renvoie la liste des descriptions de signaux associées à cette description de message.
Voir également signalDescriptionForName(), addSignalDescription(), setSignalDescriptions() et clearSignalDescriptions().
quint8 QCanMessageDescription::size() const
Renvoie la taille, en octets, du message CAN.
Voir également la fonction ` setSize()`.
QString QCanMessageDescription::transmitter() const
Renvoie le nœud émetteur du message.
Ce paramètre est fourni uniquement à titre d'information complémentaire. Il n'est pas utilisé lors du codage ou du décodage du message.
Voir également setTransmitter().
QtCanBus::UniqueId QCanMessageDescription::uniqueId() const
Renvoie l'identifiant unique du message CAN.
Pour plus d’informations sur l’identifiant unique, consultez la section « Message ID ».
Voir également setUniqueId().
[noexcept] QCanMessageDescription &QCanMessageDescription::operator=(QCanMessageDescription &&other)
Cette fonction copie les valeurs de l'objet ` other ` vers la description de ce message.
Remarque : l’objet « moved-from » QCanMessageDescription ne peut être ni détruit, ni affecté. L’effet de l’appel à des fonctions autres que le destructeur ou l’un des opérateurs d’affectation est indéfini.
QCanMessageDescription &QCanMessageDescription::operator=(const QCanMessageDescription &other)
Attribue les valeurs de other à la description de ce 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.
