Класс QCanBusDevice

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

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

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

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

• 31 открытые функции унаследованные от QObject

Сигналы

• 2 сигнала унаследованные от QObject

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

• 9 защищенных функций унаследованных от QObject

Дополнительные унаследованные члены

• 1 свойство унаследованное от QObject
• 1 открытый слот унаследованный от QObject
• 11 статические открытые члены унаследованные от QObject

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

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

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

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

перечисление QCanBusDevice::Состояние устройства шины CAN

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

перечисление QCanBusDevice::Ошибка шины CAN

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

перечисление QCanBusDevice::Ключ конфигурации

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

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

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

QCanBusDevice::QCanBusDevice(QObject *parent = nullptr)

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

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

Эта функция отвечает за закрытие соединения CAN-шины. Реализация должна гарантировать, что состояние экземпляра state() установлено в QCanBusDevice::UnconnectedState.

Главная задача этой функции — закрыть сокет для CAN-устройства и вызвать QCanBusDevice::setState().

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

QVector<int> QCanBusDevice::configurationKeys() const

Возвращает список ключей, используемых соединением CAN-шины.

Значение ключей эквивалентно ConfigurationKey. Если ключ не указан, используется значение по умолчанию платформы для соответствующего ключа.

QVariant QCanBusDevice::configurationParameter(int key) const

Возвращает текущее значение, назначенное ключу ConfigurationKey key; в противном случае — недействительный QVariant.

См. также setConfigurationParameter() и configurationKeys().

bool QCanBusDevice::connectDevice()

Подключает устройство к CAN-шине. Возвращает true при успехе; в противном случае false.

Эта функция вызывает open() как часть своей реализации.

[protected] QCanBusFrame QCanBusDevice::dequeueOutgoingFrame()

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

void QCanBusDevice::disconnectDevice()

Отключает устройство от CAN-шины.

Эта функция вызывает close() как часть своей реализации.

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

Добавляет newFrame во внутренний список исходящих фреймов, к которому можно получить доступ с помощью writeFrame().

Подклассы должны вызывать эту функцию при записи нового фрейма.

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

Добавляет newFrames во внутренний список фреймов, к которому можно получить доступ с помощью readFrame(), и излучает сигнал framesReceived().

Подклассы должны вызывать эту функцию при получении фреймов.

CanBusError QCanBusDevice::error() const

Возвращает последнюю произошедшую ошибку. Значение ошибки всегда устанавливается на последнюю произошедшую ошибку и никогда не сбрасывается.

См. также setError() и errorString().

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

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

QString QCanBusDevice::errorString() const

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

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

qint64 QCanBusDevice::framesAvailable() const

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

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

[signal] void QCanBusDevice::framesReceived()

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

qint64 QCanBusDevice::framesToWrite() const

Возвращает количество фреймов, ожидающих записи.

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

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

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

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

QCanBusFrame QCanBusDevice::readFrame()

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

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

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

[virtual] void QCanBusDevice::setConfigurationParameter(int 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().

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

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

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

CanBusDeviceState QCanBusDevice::state() const

Возвращает текущее состояние устройства.

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

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

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

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

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

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

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

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

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