QCanBusDevice Class

成员函数文档

[explicit] QCanBusDevice::QCanBusDevice(QObject *parent = nullptr)

使用指定的parent 构建一个串行总线设备。

[virtual] QCanBusDevice::CanBusStatus QCanBusDevice::busStatus()

返回当前的 CAN 总线状态。如果无法查询状态，则返回 QCanBusDevice::UnknownStatus。

另请参阅 hasBusStatus() 和resetController()。

void QCanBusDevice::clear(QCanBusDevice::Directions direction = Direction::AllDirections)

根据direction ，清空设备的输入或输出缓冲区。

该函数仅对QCanBusDevice 缓冲区进行操作。已写入CAN驱动程序或CAN硬件层，或尚未从这些层读取的帧，不会被该函数清除。

另请参阅 framesAvailable()、readFrame()、framesToWrite() 和writeFrame()。

[protected] void QCanBusDevice::clearError()

清除上次设备错误的错误 ID 及其通俗易懂的描述。

CAN总线实现必须使用此函数来更新设备的错误状态。

另请参阅 error()、errorOccurred() 和setError()。

[pure virtual protected] void QCanBusDevice::close()

该函数负责关闭CAN总线连接。实现时必须确保该实例的state()被设置为QCanBusDevice::UnconnectedState 。

该函数最重要的任务是关闭与 CAN 设备的套接字连接，并调用QCanBusDevice::setState()。

另请参阅 disconnectDevice()。

QList<QCanBusDevice::ConfigurationKey> QCanBusDevice::configurationKeys() const

返回 CAN 总线连接所使用的键列表。

这些键的含义与ConfigurationKey 中的定义一致。如果未明确指定某个键，则使用平台对该键的默认设置。

QVariant QCanBusDevice::configurationParameter(QCanBusDevice::ConfigurationKey key) const

返回当前分配给 `ConfigurationKey ` 的值 `key`；否则返回无效的 `QVariant`。

另请参阅 setConfigurationParameter() 和configurationKeys()。

bool QCanBusDevice::connectDevice()

将设备连接到 CAN 总线。成功时返回 `true `；否则返回 `false`。

该函数在其实现过程中会调用open()。

另请参阅 disconnectDevice()。

[protected] QCanBusFrame QCanBusDevice::dequeueOutgoingFrame()

返回出站帧内部列表中的下一个QCanBusFrame ；否则返回一个无效的QCanBusFrame 。返回的帧将从内部列表中移除。

[virtual, since 6.2] QCanBusDeviceInfo QCanBusDevice::deviceInfo() const

返回当前QCanBusDevice 对应的QCanBusDeviceInfo 。如果该函数未由QCanBusDevice 的子类实现，则返回一个通过默认构造函数创建的对象。

该函数在 Qt 6.2 中引入。

void QCanBusDevice::disconnectDevice()

将设备从 CAN 总线上断开。

该函数的实现过程中会调用close()。

另请参阅 connectDevice()。

[protected] void QCanBusDevice::enqueueOutgoingFrame(const QCanBusFrame &newFrame)

将 `newFrame ` 追加到待发送帧的内部列表中，该列表可通过 `writeFrame()` 访问。

子类在写入新帧时必须调用此函数。

[protected] void QCanBusDevice::enqueueReceivedFrames(const QList<QCanBusFrame> &newFrames)

将newFrames 添加到内部帧列表中（可通过readFrame()访问），并触发framesReceived()信号。

子类在接收帧时必须调用此函数。

QCanBusDevice::CanBusError QCanBusDevice::error() const

返回最近发生的错误。错误值始终设置为最近发生的错误，且不会被重置。

另请参阅 setError() 和errorString()。

[signal] void QCanBusDevice::errorOccurred(QCanBusDevice::CanBusError)

当发生错误时，会发出该信号。

QString QCanBusDevice::errorString() const

返回最近发生的设备错误的人类可读描述。

另请参阅 error()。

qint64 QCanBusDevice::framesAvailable() const

返回可用帧的数量。如果没有可用帧，该函数返回 0。

另请参阅 clear()、readFrame()，以及readAllFrames()。

[signal] void QCanBusDevice::framesReceived()

当接收到一个或多个帧时，会发出此信号。应使用readFrame() 和framesAvailable() 读取这些帧。

qint64 QCanBusDevice::framesToWrite() const

对于带缓冲的设备，该函数返回待写入的帧数。对于不带缓冲的设备，该函数始终返回零。

另请参见 clear() 和writeFrame()。

[signal] void QCanBusDevice::framesWritten(qint64 framesCount)

每当将一组帧写入 CAN 总线时，都会发出此信号。framesCount 参数的值设置为该组帧中写入的帧数。

[virtual] bool QCanBusDevice::hasBusStatus() const

如果 CAN 插件支持查询 CAN 总线状态，则返回 true。

另请参阅 busStatus()。

[protected] bool QCanBusDevice::hasOutgoingFrames() const

如果待发送帧的内部列表不为空，则返回true ；否则返回false 。

[pure virtual] QString QCanBusDevice::interpretErrorFrame(const QCanBusFrame &frame)

将frame 解释为错误帧，并返回该错误的人可读描述。

如果frame 不是错误帧，则返回的字符串为空。

[pure virtual protected] bool QCanBusDevice::open()

该函数由connectDevice()调用。子类必须提供一个实现：如果成功建立CAN总线连接，则返回true ；否则返回false 。QCanBusDevice 的实现确保在进入该函数时，设备的state()已设置为QCanBusDevice::ConnectingState 。

该实现必须确保在成功时，实例的state() 被设置为QCanBusDevice::ConnectedState ；否则应返回QCanBusDevice::UnconnectedState 。必须使用setState() 来设置新的设备状态。

自定义实现负责打开套接字、实例化可能需要的QSocketNotifier ，以及应用自定义和默认的QCanBusDevice::configurationParameter()。

另请参阅 connectDevice()。

QList<QCanBusFrame> QCanBusDevice::readAllFrames()

返回队列中的所有QCanBusFrame；否则返回一个空的QList 。返回的帧将从队列中移除。

该队列按照FIFO原则运行。

另请参阅 clear()、framesAvailable() 和readFrame()。

QCanBusFrame QCanBusDevice::readFrame()

返回队列中的下一个QCanBusFrame ；否则返回一个空的QCanBusFrame 。返回的帧将从队列中移除。

该队列遵循FIFO（先进先出）原则。

另请参阅 clear()、framesAvailable() 和readAllFrames()。

[virtual] void QCanBusDevice::resetController()

执行 CAN 控制器复位，以将 CAN 控制器从总线断开状态中释放（如果可能的话）。

另请参阅 busStatus()。

[virtual] void QCanBusDevice::setConfigurationParameter(QCanBusDevice::ConfigurationKey key, const QVariant &value)

将CAN总线连接的配置参数key 设置为value 。可能的键值由ConfigurationKey 表示。

可以通过设置无效的QVariant 来取消该参数的配置。取消配置意味着该参数将恢复为默认设置。

另请参阅 configurationParameter()。

[protected] void QCanBusDevice::setError(const QString &errorText, QCanBusDevice::CanBusError errorId)

将上次设备错误的人机可读描述设置为errorText 。errorId 用于分类错误类型。

CAN总线实现必须使用此函数来更新设备的错误状态。

另请参见 error()、errorOccurred() 和clearError()。

[protected] void QCanBusDevice::setState(QCanBusDevice::CanBusDeviceState newState)

将设备状态设置为newState 。CAN总线实现必须使用此函数来更新设备状态。

另请参阅 state()。

QCanBusDevice::CanBusDeviceState QCanBusDevice::state() const

返回设备的当前状态。

另请参阅 setState() 和stateChanged()。

[signal] void QCanBusDevice::stateChanged(QCanBusDevice::CanBusDeviceState state)

每当设备状态发生变化时，都会发出此信号。新状态由state 表示。

另请参阅 setState() 和state()。

[virtual] bool QCanBusDevice::waitForFramesReceived(int msecs)

该函数将阻塞，直到有新的帧可供读取且已发出framesReceived()信号，或者直到经过msecs 毫秒。如果msecs 的值为-1 ，则该函数不会超时。

如果可读取新帧且已发出framesReceived() 信号，则返回true ；否则返回false （如果操作超时或发生错误）。

另请参阅 waitForFramesWritten()。

[virtual] bool QCanBusDevice::waitForFramesWritten(int msecs)

对于带缓冲的设备，该函数会等待直至所有缓冲帧均已写入设备且已发出framesWritten()信号，或者等待msecs 毫秒后返回。若msecs 为-1，则该函数不会超时。对于不带缓冲的设备，该函数会立即返回false ，因为writeFrame()不需要写入缓冲区。

如果触发了framesWritten()信号，则返回true ；否则返回false （即操作超时或发生错误时）。

另请参阅 waitForFramesReceived()。

[pure virtual] bool QCanBusDevice::writeFrame(const QCanBusFrame &frame)

将frame 写入CAN总线，成功时返回true ；否则返回false 。

在某些平台上，帧可能会被放入队列中，而返回值可能仅表示已成功将帧插入队列。实际的帧将在稍后发送。因此，framesWritten() 信号是帧已移交至传输层的最终确认。如果发生错误，将发出errorOccurred() 信号。

根据 CAN 总线规范，类型为remote transfer request (RTR) 的帧不包含有效载荷，但具有 0 到 8（含）的长度。该长度表示预期来自远端节点的响应有效载荷长度。 因此，使用此函数发送 RTR 帧时，可能仍需在frame 上设置一个任意有效载荷。该任意有效载荷的长度即为 RTR 帧的预期大小。

另请参阅 QCanBusFrame::setPayload()。