QCanFrameProcessor Class

成员函数文档

QCanFrameProcessor::QCanFrameProcessor()

创建 CAN 帧处理器。

[noexcept] QCanFrameProcessor::~QCanFrameProcessor()

销毁该帧处理器。

void QCanFrameProcessor::addMessageDescriptions(const QList<QCanMessageDescription> &descriptions)

将新的邮件描述descriptions 添加到可用的邮件描述中。

所有信息描述都应具有不同的唯一 ID。

如果某些消息描述有重复的唯一 ID，则只使用最后一个描述。

如果解析器已经有一个具有相同唯一 ID 的消息描述，它将被覆盖。

另请参阅 messageDescriptions()、setMessageDescriptions() 和clearMessageDescriptions()。

void QCanFrameProcessor::clearMessageDescriptions()

删除该帧处理器的所有信息描述。

另请参阅 messageDescriptions()、addMessageDescriptions() 和setMessageDescriptions()。

QCanFrameProcessor::Error QCanFrameProcessor::error() const

返回最后一个错误。

另请参阅 errorString()、prepareFrame() 和parseFrame()。

QString QCanFrameProcessor::errorString() const

返回最后一个错误的文本描述。

另请参阅 error()、prepareFrame() 和parseFrame()。

QList<QCanMessageDescription> QCanFrameProcessor::messageDescriptions() const

返回此帧处理器当前使用的所有报文描述。

另请参阅 addMessageDescriptions()、setMessageDescriptions() 和clearMessageDescriptions()。

QCanFrameProcessor::ParseResult QCanFrameProcessor::parseFrame(const QCanBusFrame &frame)

使用指定的报文描述解析帧frame 。

解析过程如下：

1. uniqueIdDescription() 用于提取报文的唯一标识符。
2. 提取的唯一标识符用于从所有可用的messageDescriptions() 列表中搜索合适的QCanMessageDescription 。
3. 匹配的QCanMessageDescription 用于提取帧中的信号值。

该方法会返回一个QCanFrameProcessor::ParseResult ，其中包含提取的唯一标识符和一个包含信号及其值的QVariantMap 。映射的键是signal names ，映射的值是信号值。

如果在解码过程中发生错误，则会返回一个空的signalValues 结果。在这种情况下，可以使用error() 和errorString() 方法获取有关错误的信息。

另请参阅 addMessageDescriptions()、error()、errorString() 和warnings()。

QCanBusFrame QCanFrameProcessor::prepareFrame(QtCanBus::UniqueId uniqueId, const QVariantMap &signalValues)

使用uniqueId 和signalValues 构建 CAN 数据帧，并返回所构建的QCanBusFrame 。

signalValues 参数必须包含作为键的信号名称和作为值的预期信号值。

创建框架的过程如下：

1. 使用uniqueId 查找合适的信息描述。
2. 如果找到了消息描述，就会创建一个具有指定大小有效载荷的QCanBusFrame 。有效载荷的所有字节以及帧 ID 都被初始化为 0。
3. uniqueIdDescription() 用于将uniqueId 编码到帧的适当部分（帧 ID 或有效载荷）。
4. 选定的信息描述用于将所有signalValues 编码到帧中。
5. 帧中未被唯一 id 或现有信号描述覆盖的部分将不会被触及（因此仍包含 0）。

如果在编码过程中发生错误，则会返回无效的QCanBusFrame 。在这种情况下，可以使用error() 和errorString() 方法获取错误信息。

另请参阅 addMessageDescriptions()、error()、errorString() 和warnings()。

void QCanFrameProcessor::setMessageDescriptions(const QList<QCanMessageDescription> &descriptions)

用新的报文描述替换该帧处理器使用的当前报文描述descriptions 。

另请参阅 messageDescriptions()、addMessageDescriptions() 和clearMessageDescriptions()。

void QCanFrameProcessor::setUniqueIdDescription(const QCanUniqueIdDescription &description)

将唯一标识符描述设置为description 。

唯一标识符描述必须有效，才能对 CAN 总线帧进行编码或解码。详情请参见QCanUniqueIdDescription 类文档。

另请参阅 uniqueIdDescription() 和QCanUniqueIdDescription 。

QCanUniqueIdDescription QCanFrameProcessor::uniqueIdDescription() const

返回唯一标识符描述。

唯一标识符描述必须有效，以便对 CAN 总线帧进行编码或解码。详情请参见QCanUniqueIdDescription 类文档。

另请参阅 setUniqueIdDescription() 和QCanUniqueIdDescription 。

QStringList QCanFrameProcessor::warnings() const

返回上次编码或解码调用时产生的警告列表。

另请参阅 error()、errorString()、prepareFrame() 和parseFrame()。