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 使用带比特率切换的灵活数据速率（Flexible Data-RatewithBitrate Switch），以较高的数据比特率传输有效载荷数据，则返回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 帧使用允许多达 64数据字节的"灵活数据速率"（Flexible Data-Rate），则返回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 ，则返回false ；如果frameId() 长度超过 11 位，则不设置hasExtendedFrameFormat() ；如果启用了 "灵活数据速率"模式，则有效载荷长度超过最大允许有效载荷长度 64 字节；如果禁用了 "灵活数据速率"模式，则有效载荷长度为 8 字节。如果frameType() 是RemoteRequestFrame ，且同时启用了灵活数据速率模式，则false 也会返回。

否则，该函数将返回true 。

QByteArray QCanBusFrame::payload() const

返回帧的数据有效载荷。

另请参见 setPayload()。

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

将 "灵活数据速率标志比特率切换"标志设为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 扩展帧格式设置将自动设置。

当格式被扩展，并通过一个 11 位或更小的newFrameId 时，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