Класс QCanBusDevice

Класс QCanBusDevice является интерфейсным классом для шины CAN. Подробнее...

• Список всех членов, включая унаследованные

Открытые типы

Открытые функции

Сигналы

Защищенные функции

Подробное описание

QCanBusDevice взаимодействует с плагином CAN, предоставляя пользователям удобный API. Плагин CAN должен быть указан во время создания объекта.

Документация по типам членов

перечисление QCanBusDevice::CanBusDeviceState

Это перечисление описывает все возможные состояния устройства.

перечисление QCanBusDevice::CanBusError

Это перечисление описывает все возможные условия ошибок.

[since 5.14] enum class QCanBusDevice::CanBusStatus

Это перечисление описывает возможные значения состояния шины CAN.

Это перечисление было введено или изменено в Qt 5.14.

enum QCanBusDevice::ConfigurationKey

Это перечисление описывает возможные параметры конфигурации соединения CAN-шины.

См. также configurationParameter().

[since 5.12] enum QCanBusDevice::Directionflags QCanBusDevice::Directions

Это перечисление описывает возможные направления передачи данных.

Это перечисление было введено или изменено в Qt 5.12.

Тип Directions является typedef для QFlags<Direction>. Он хранит комбинацию значений Direction с использованием оператора OR.

Описание функций-членов

QCanBusDevice::QCanBusDevice(QObject *parent = nullptr)

Конструирует устройство последовательной шины с указанным parent.

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

Этот сигнал испускается при возникновении ошибки.

[signal] void QCanBusDevice::framesReceived()

Этот сигнал испускается, когда один или несколько кадров были получены. Кадры должны быть прочитаны с помощью readFrame() и framesAvailable().

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

Этот сигнал испускается каждый раз, когда полезная нагрузка кадров была записана в шину CAN. Аргумент framesCount устанавливается в количество кадров, которые были записаны в эту полезную нагрузку.

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

Этот сигнал испускается каждый раз, когда изменяется состояние устройства. Новое состояние представлено state.

См. также setState() и state().

[virtual, since 5.14] QCanBusDevice::CanBusStatus QCanBusDevice::busStatus()

Возвращает текущее состояние шины CAN. Если состояние запросить невозможно, возвращается QCanBusDevice::UnknownStatus.

Эта функция была введена в Qt 5.14.

См. также hasBusStatus() и resetController().

[since 5.12] void QCanBusDevice::clear(QCanBusDevice::Directions direction = Direction::AllDirections)

Очищает входные или выходные буферы устройств в зависимости от direction.

Эта функция работает только с буферами QCanBusDevice. Кадры, которые уже записаны в драйвер CAN или на аппаратном уровне CAN, или которые еще не считаны с этих уровней, не очищаются этой функцией.

Эта функция была введена в Qt 5.12.

См. также framesAvailable(), readFrame(), framesToWrite() и writeFrame().

[protected, since 5.14] void QCanBusDevice::clearError()

Очищает идентификатор ошибки и удобочитаемое описание последней ошибки устройства.

Реализации CAN-шины должны использовать эту функцию для обновления состояния ошибки устройства.

Эта функция была добавлена в Qt 5.14.

См. также 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. Если функция не реализована подклассом 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().

QString QCanBusDevice::errorString() const

Возвращает удобочитаемое описание последней ошибки устройства.

См. также error().

qint64 QCanBusDevice::framesAvailable() const

Возвращает количество доступных кадров. Если кадров нет, эта функция возвращает 0.

См. также clear(), readFrame() и readAllFrames().

qint64 QCanBusDevice::framesToWrite() const

Для буферизованных устройств эта функция возвращает количество кадров, ожидающих записи. Для устройств без буферизации эта функция всегда возвращает ноль.

См. также clear() и writeFrame().

[virtual, since 5.14] bool QCanBusDevice::hasBusStatus() const

Возвращает true, если плагин CAN поддерживает запрос состояния CAN-шины.

Эта функция была добавлена в Qt 5.14.

См. также 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(). Подклассы должны предоставить реализацию, которая возвращает true если соединение с CAN-шиной установлено; в противном случае false. Реализация QCanBusDevice гарантирует, что при входе в эту функцию состояние устройства state() уже установлено в QCanBusDevice::ConnectingState.

Реализация должна гарантировать, что при успехе состояние экземпляра state() устанавливается в QCanBusDevice::ConnectedState; в противном случае QCanBusDevice::UnconnectedState. Для установки нового состояния устройства должен использоваться setState().

Пользовательская реализация отвечает за открытие сокета, создание потенциально необходимого QSocketNotifier и применение пользовательских и стандартных значений QCanBusDevice::configurationParameter.

См. также connectDevice().

[since 5.12] QList<QCanBusFrame> QCanBusDevice::readAllFrames()

Возвращает все QCanBusFrame из очереди; в противном случае возвращает пустой QList. Возвращаемые кадры удаляются из очереди.

Очередь работает по принципу FIFO.

Эта функция была добавлена в Qt 5.12.

См. также clear(), framesAvailable() и readFrame().

QCanBusFrame QCanBusDevice::readFrame()

Возвращает следующий QCanBusFrame из очереди; в противном случае возвращает пустой QCanBusFrame. Возвращаемый кадр удаляется из очереди.

Очередь работает по принципу FIFO.

См. также clear(), framesAvailable() и readAllFrames().

[virtual, since 5.14] void QCanBusDevice::resetController()

Выполняет сброс контроллера CAN, чтобы освободить контроллер CAN от состояния «остановлен на шине», если это возможно.

Функция была добавлена в Qt 5.14.

См. также busStatus().

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

Устанавливает параметр конфигурации key для подключения к шине CAN в значение 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().

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

Задерживает выполнение, пока новые кадры не станут доступны для чтения, и не будет отправлен сигнал framesReceived(), или пока не пройдут msecs миллисекунд. Если msecs равно -1, эта функция не будет ожидать истечения времени.

Возвращает true если новые кадры доступны для чтения и отправлен сигнал framesReceived(); в противном случае возвращает false (если операция истекла по времени или произошла ошибка).

См. также waitForFramesWritten().

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

Для буферизованных устройств эта функция ожидает, пока все буферизованные кадры не будут записаны в устройство и не будет отправлен сигнал framesWritten(), или пока не пройдут msecs миллисекунд. Если msecs равно -1, эта функция не будет ожидать истечения времени. Для устройств без буферизации она возвращает значение немедленно со значением false, так как writeFrame() не требует буфера записи.

Возвращает true если отправлен сигнал framesWritten(); в противном случае возвращает false (т.е. если операция истекла по времени или произошла ошибка).

См. также waitForFramesReceived().

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

Записывает frame на шину CAN и возвращает true при успехе; в противном случае false.

На некоторых платформах кадр может помещаться в очередь, и возвращаемое значение может указывать только на успешное добавление в очередь. Фактическое отправление кадра произойдёт позднее. Поэтому сигнал framesWritten() является окончательным подтверждением того, что кадр был передан транспортному слою. При возникновении ошибки отправляется сигнал errorOccurred().

В соответствии со спецификацией шины CAN кадры типа запрос на удалённый перенос (RTR) не имеют полезной нагрузки, но имеют длину от 0 до 8 (включительно). Эта длина указывает ожидаемую длину полезной нагрузки ответа от удалённой стороны. Поэтому при отправке кадра RTR с помощью этой функции всё ещё может потребоваться установить произвольную полезную нагрузку на frame. Длина произвольной полезной нагрузки устанавливается как ожидаемая длина полезной нагрузки для кадра RTR.

См. также QCanBusFrame::setPayload().