QCanBusDevice 类

成员函数文档

[显式] QCanBusDevice::QCanBusDevice(QObject *parent = nullptr)

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

[虚拟] 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

返回当前 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()。

[信号] void QCanBusDevice::framesWritten(qint64 framesCount)

每当帧负载被写入到CAN总线上时，就会发出此信号。将framesCount参数设置为在此负载中写入的帧数。

[虚函数] bool QCanBusDevice::hasBusStatus() const

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

另请参阅：busStatus()。

[保护] bool QCanBusDevice::hasOutgoingFrames() const

如果内部传出帧列表不为空，则返回true；否则返回false。

[纯虚函数] QString QCanBusDevice::interpretErrorFrame(const QCanBusFrame &frame)

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

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

[纯虚保护] bool QCanBusDevice::open()

connectDevice 调用此函数。子类必须提供一个实现，如果CAN总线连接已建立，则返回true；否则返回false。在进入此函数之前，QCanBusDevice 实现确保设备的状态设置为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()。

[虚拟] bool QCanBusDevice::waitForFramesWritten(int msecs)

对于缓冲设备，此函数会等待直到所有缓冲帧都被写入到设备并且已发出 framesWritten() 信号，或者直到 msecs 毫秒已过。如果 msecs 是 -1，该函数将不会超时。对于非缓冲设备，它将立即返回 false，因为 writeFrame() 不需要写入缓冲区。

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

另请参阅：waitForFramesReceived()。

[纯虚] bool QCanBusDevice::writeFrame(const QCanBusFrame &frame)

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

在某些平台上，帧可能会放入队列中，且返回值可能只表示成功插入队列中。实际的帧将在之后发送。因此，framesWritten() 信号是帧已传递到传输层的确凿证据。如果发生错误，则发出 errorOccurred()。

根据 CAN 总线规范，远程传输请求 (RTR) 类型的帧没有有效载荷，但长度在 0 到 8（包括）之间。此长度表示远程方期望的有效载荷长度。因此，在发送 RTR 帧时，可能仍然需要在 frame 上设置任意有效载荷。任意有效载荷的长度是设置 RTR 帧大小的期望值。

另请参阅：QCanBusFrame::setPayload()。