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()

返回队列中所有QCanBusFrames；否则返回空QList 。返回的帧将从队列中删除。

队列根据先进先出原则运行。

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

QCanBusFrame QCanBusDevice::readFrame()

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

队列根据先进先出原则运行。

另请参阅 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，则此函数不会超时。对于无缓冲区的设备，由于writeFrame() 不需要写缓冲区，因此会立即返回false 。

如果发出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()。