QCanBusFrame Class

成员函数文档

[explicit noexcept] QCanBusFrame::QCanBusFrame(QCanBusFrame::FrameType type = DataFrame)

根据指定的type 构建一个CAN帧。

另请参阅 QCanBusFrame::FrameType 以及setFrameType()。

[explicit] QCanBusFrame::QCanBusFrame(QCanBusFrame::FrameId identifier, const QByteArray &data)

使用identifier 作为帧标识符，data 作为有效载荷，构建一个CAN帧。

另请参阅 QCanBusFrame::FrameId 。

[constexpr noexcept] QCanBusFrame::FrameErrors QCanBusFrame::error() const

返回当前错误帧的错误。如果该帧不是ErrorFrame ，则此函数返回NoError 。

另请参阅 QCanBusFrame::FrameError 和setError()。

[constexpr noexcept] QCanBusFrame::FrameId QCanBusFrame::frameId() const

返回 CAN 帧标识符。如果 CAN 帧采用扩展帧格式，则该标识符的最大位数为 29 位；否则为 11 位。

如果帧属于ErrorFrame 类型，则该标识符始终为0。

另请参阅 QCanBusFrame::FrameId 、setFrameId() 和hasExtendedFrameFormat()。

[constexpr noexcept] QCanBusFrame::FrameType QCanBusFrame::frameType() const

返回帧的类型。

另请参阅 ` QCanBusFrame::FrameType ` 和 `setFrameType()`。

[constexpr noexcept] bool QCanBusFrame::hasBitrateSwitch() const

如果 CAN 采用“带比特率切换的 灵活数据速率”来以更高的数据比特率传输有效载荷数据，则返回true 。

另请参见 setBitrateSwitch() 和QCanBusDevice::DataBitRateKey 。

[constexpr noexcept] bool QCanBusFrame::hasErrorStateIndicator() const

如果 CAN 采用“灵活数据速率”且“错误状态指示器”已设置，则返回true 。

该标志由发送方的 CAN FD 硬件设置，用于指示发送方的错误状态。

另请参阅 setErrorStateIndicator()。

[constexpr noexcept] bool QCanBusFrame::hasExtendedFrameFormat() const

如果 CAN 帧使用 29 位标识符，则返回true ；否则返回false ，表示使用 11 位标识符。

另请参阅 setExtendedFrameFormat() 和frameId()。

[constexpr noexcept] bool QCanBusFrame::hasFlexibleDataRateFormat() const

如果 CAN 帧使用灵活数据速率（Flexible Data-Rate），且允许最多 64 个数据字节，则返回true ；否则返回false ，表示有效载荷最多为 8 字节。

另请参见 setFlexibleDataRateFormat() 和payload()。

[constexpr noexcept] bool QCanBusFrame::hasLocalEcho() const

如果帧是本地回显帧（即当内容相同的帧成功发送至 CAN 总线后，作为回显接收到的帧），则返回true 。该标志不仅适用于应用程序自身发送的帧，也适用于在同一系统上运行的其他应用程序发送的帧。

QCanBusDevice::ReceiveOwnKey 必须设置为 true 才能接收回显帧。

另请参阅 setLocalEcho()、QCanBusDevice::ReceiveOwnKey 以及QCanBusDevice::LoopbackKey 。

[noexcept] bool QCanBusFrame::isValid() const

如果frameType()的值为InvalidFrame ，且hasExtendedFrameFormat()未设置（尽管frameId()的长度超过11位），或者在灵活数据速率模式启用时有效载荷长度超过64字节（若该模式禁用则超过8字节）的上限，则返回false 。 如果frameType()的值为RemoteRequestFrame ，且同时启用了灵活数据速率模式，则还会返回false 。

否则，该函数返回true 。

QByteArray QCanBusFrame::payload() const

返回帧的数据负载。

另请参阅 setPayload()。

[constexpr noexcept] void QCanBusFrame::setBitrateSwitch(bool bitrateSwitch)

将“灵活数据速率”标志（Bitrate Switchflag）设置为bitrateSwitch 。带有此标志的帧的数据字段将以更高的数据比特率传输。

另请参阅 hasBitrateSwitch() 和QCanBusDevice::DataBitRateKey 。

[constexpr] void QCanBusFrame::setError(QCanBusFrame::FrameErrors error)

设置帧的error 类型。如果frameType()不是ErrorFrame ，则该函数不执行任何操作。

另请参阅 QCanBusFrame::FrameError 和error()。

[constexpr noexcept] void QCanBusFrame::setErrorStateIndicator(bool errorStateIndicator)

将“灵活数据速率”标志的“错误状态指示器”标志设置为errorStateIndicator 。

在发送 CAN FD 帧时，该标志会由 CAN FD 硬件自动设置。QCanBusFrame::setErrorStateIndicator() 仅应用于应用程序测试，例如在虚拟 CAN FD 总线上。

另请参阅 hasErrorStateIndicator()。

[constexpr noexcept] void QCanBusFrame::setExtendedFrameFormat(bool isExtended)

将扩展帧格式标志设置为isExtended 。

另请参阅 hasExtendedFrameFormat()。

[constexpr noexcept] void QCanBusFrame::setFlexibleDataRateFormat(bool isFlexibleData)

将“灵活数据速率”标志设置为isFlexibleData 。在支持该功能的控制器上，这些帧可以以更高的速度发送。此外，有效载荷长度限制提高到64字节。

另请参阅 hasFlexibleDataRateFormat()。

[constexpr] void QCanBusFrame::setFrameId(QCanBusFrame::FrameId newFrameId)

将CAN帧的标识符设置为newFrameId 。

CAN帧标识符的最大长度为11位，通过支持CAN扩展帧格式，可将其扩展至最多29位。当给定的newFrameId 长度超过11位时，CAN扩展帧格式设置将自动生效。

当格式被扩展且传入的newFrameId 长度不超过11位时，CAN扩展帧格式设置不会改变。

另请参阅 QCanBusFrame::FrameId 、frameId() 以及hasExtendedFrameFormat()。

[constexpr noexcept] void QCanBusFrame::setFrameType(QCanBusFrame::FrameType newType)

将帧类型设置为newType 。

另请参阅 QCanBusFrame::FrameType 和frameType()。

[constexpr noexcept] void QCanBusFrame::setLocalEcho(bool echo)

将“本地回显”标志设置为echo 。

当在启用QCanBusDevice::ReceiveOwnKey 的情况下发送CAN总线帧时，所有成功发送的帧都会被回显到接收队列中，并标记为本地回显帧。因此，QCanBusFrame::setLocalEcho 仅应用于应用程序测试，例如在虚拟CAN总线上进行测试。

另请参阅 hasLocalEcho()。

void QCanBusFrame::setPayload(const QByteArray &data)

将data 设置为CAN帧的有效载荷。有效载荷的最大大小为8字节，通过支持“灵活数据速率”功能，可将其扩展至最多64字节。如果data 包含超过8字节的数据，则会自动设置“灵活数据速率”标志。 必须通过设置QCanBusDevice::CanFdKey ，在QCanBusDevice 上启用灵活数据速率。

RemoteRequestFrame （RTR）类型的帧没有有效载荷。但是，它们必须提供响应预期有效载荷长度的指示。要设置预期长度，必须设置一个长度与响应预期有效载荷长度相匹配的伪有效载荷。实现此目的的一种方法如下：

QCanBusFrame frame(QCanBusFrame::RemoteRequestFrame);
int expectedResponseLength = ...;
frame.setPayload(QByteArray(expectedResponseLength, 0));

另请参阅 payload() 和hasFlexibleDataRateFormat()。

[constexpr noexcept] void QCanBusFrame::setTimeStamp(QCanBusFrame::TimeStamp ts)

将ts 设置为 CAN 帧的时间戳。通常情况下，无需调用此函数，因为时间戳是在读取操作期间生成的，而在写入操作期间则不需要。

另请参阅 timeStamp() 和QCanBusFrame::TimeStamp 。

[constexpr noexcept] QCanBusFrame::TimeStamp QCanBusFrame::timeStamp() const

返回该帧的时间戳。

另请参阅 QCanBusFrame::TimeStamp 和QCanBusFrame::setTimeStamp()。

QString QCanBusFrame::toString() const

将 CAN 帧作为格式化字符串返回。

输出包含以十六进制格式表示的 CAN 标识符（向右对齐至 32 位），后跟方括号内的数据长度以及以十六进制格式表示的有效载荷。

标准标识符用空格填充，而扩展标识符用零填充。

典型输出如下：

(Error)                                  - error frame
     7FF   [1]  01                       - data frame with standard identifier
1FFFFFFF   [8]  01 23 45 67 89 AB CD EF  - data frame with extended identifier
     400  [10]  01 23 45 67 ... EF 01 23 - CAN FD frame
     123   [5]  Remote Request           - remote frame with standard identifier
00000234   [0]  Remote Request           - remote frame with extended identifier