QCanMessageDescription 类
QCanMessageDescription 类描述处理 CAN 消息的规则,并以应用程序定义的格式表示它。 更多...
头文件 | #include <QCanMessageDescription> |
CMake | find_package(Qt6 REQUIRED COMPONENTS SerialBus) target_link_libraries(mytarget PRIVATE Qt6::SerialBus) |
qmake | QT += serialbus |
自 | Qt 6.5 |
状态 | 初步 |
此类正在开发中,可能会有所变化。
公共函数
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=(const QCanMessageDescription &other) |
QCanMessageDescription & | operator=(QCanMessageDescription &&other) |
详细说明
CAN 消息基本上是一个 QCanBusFrame。CAN 消息的描述包括以下内容
- 消息 ID。
- 消息名称。
- 消息长度(以字节为单位)。
- 消息的来源(发送者)。
- 消息中信号的描述。
QCanMessageDescription 类提供了控制所有这些参数的方法。
消息ID
消息ID是一个唯一的标识符,用于在解码传入的QCanBusFrame或根据提供的数据编码基于QCanBusFrame时选择适当的消息描述。
有关唯一标识符描述的详细信息,请参阅QCanUniqueIdDescription文档。
信号描述
信号描述由QCanSignalDescription类表示。QCanMessageDescription类仅提供属于消息的信号列表。
另请参阅QCanSignalDescription和QCanUniqueIdDescription。
成员函数文档
QCanMessageDescription::QCanMessageDescription()
创建一个空的消息描述。
QCanMessageDescription::QCanMessageDescription(const QCanMessageDescription &other)
创建一个从other复制的消息描述。
[noexcept]
QCanMessageDescription::QCanMessageDescription(QCanMessageDescription &&other)
通过移动从other创建消息描述。
注意:被移动的QCanMessageDescription对象只能被销毁或赋值。调用除析构函数或某个赋值运算符以外的其他函数的效果是未定义的。
[noexcept]
QCanMessageDescription::~QCanMessageDescription()
销毁这个消息描述。
void QCanMessageDescription::addSignalDescription(const QCanSignalDescription &description)
向此消息描述添加一个新的信号描述description。
如果消息描述已经具有相同名称的信号描述,它将被覆盖。
另请参阅signalDescriptions(), signalDescriptionForName(), setSignalDescriptions()和clearSignalDescriptions。
void QCanMessageDescription::clearSignalDescriptions()
清除此消息的所有信号描述。
另请参阅signalDescriptions(), signalDescriptionForName(), addSignalDescription()和setSignalDescriptions。
QString QCanMessageDescription::comment() const
返回消息的注释。
此参数仅用于额外描述。它在消息编码或解码过程中不被使用。
另请参阅setComment。
bool QCanMessageDescription::isValid() const
当消息描述有效时返回true
,否则返回false
。
有效的消息描述必须包含至少一个信号描述。所有信号描述必须也是有效的。
另请参阅signalDescriptions() 和 QCanSignalDescription::isValid。
QString QCanMessageDescription::name() const
返回CAN消息的名称。
此参数仅用于额外描述。它在消息编码或解码过程中不被使用。
另请参阅setName。
void QCanMessageDescription::setComment(const QString &text)
将消息的注释设置为text。
此参数仅用于额外描述。它在消息编码或解码过程中不被使用。
另请参阅comment。
void QCanMessageDescription::setName(const QString &name)
将CAN消息的名称设置为name。
此参数仅用于额外描述。它在消息编码或解码过程中不被使用。
另请参阅name。
void QCanMessageDescription::setSignalDescriptions(const QList<QCanSignalDescription> &descriptions)
将属于此消息描述的信号描述设置为descriptions。
注意:消息描述必须具有具有唯一信号名称的信号描述,因此如果descriptions列表中包含具有重复名称的条目,则仅添加最后一个条目。
另请参阅signalDescriptions,signalDescriptionForName,addSignalDescription 和 clearSignalDescriptions。
void QCanMessageDescription::setSize(quint8 size)
将CAN消息的字节数设置为size。
另请参阅size。
void QCanMessageDescription::setTransmitter(const QString &transmitter)
将消息的发送节点设置为transmitter。
此参数仅用于额外描述。它在消息编码或解码过程中不被使用。
另请参阅transmitter。
void QCanMessageDescription::setUniqueId(QtCanBus::UniqueId id)
将CAN消息的唯一标识符设置为id。
有关唯一标识符的更多信息,请参阅消息标识符部分。
另请参阅uniqueId。
QCanSignalDescription QCanMessageDescription::signalDescriptionForName(const QString &name) const
返回名称为name的信号的信号描述。
如果消息描述没有这样的信号描述,将返回一个默认构建的QCanSignalDescription对象。
另请参阅 signalDescriptions(),addSignalDescription(),setSignalDescriptions() 以及 clearSignalDescriptions()。
QList<QCanSignalDescription> QCanMessageDescription::signalDescriptions() const
返回属于此消息描述的信号描述列表。
另请参阅 signalDescriptionForName(),addSignalDescription(),setSignalDescriptions() 及 clearSignalDescriptions()。
quint8 QCanMessageDescription::size() const
返回CAN消息的字节数。
另请参阅 setSize()。
QString QCanMessageDescription::transmitter() const
返回消息的发送节点。
此参数仅用于额外描述。它在消息编码或解码过程中不被使用。
另请参阅 setTransmitter()。
QtCanBus::UniqueId QCanMessageDescription::uniqueId() const
返回CAN消息的唯一标识符。
有关唯一标识符的更多信息,请参阅消息标识符部分。
另请参阅 setUniqueId()。
QCanMessageDescription &QCanMessageDescription::operator=(const QCanMessageDescription &other)
将other的值赋给此消息描述。
[noexcept]
QCanMessageDescription &QCanMessageDescription::operator=(QCanMessageDescription &&other)
移动赋值other的值到此处。
注意: 移动后的QCanMessageDescription对象只能被销毁或赋值。调用除析构函数或赋值运算符之外的其他函数的效果是未定义的。
© 2024 The Qt Company Ltd. 本文档中的文档贡献包含各自的版权。所提供文档的版本许可受GNU自由文档许可证版本1.3的条款约束,由自由软件基金会发布。Qt和相应的标志是芬兰和/或其他国家的The Qt Company Ltd的商标。所有其他商标均为其所有者的财产。