Класс QCanBusFrame

QCanBusFrame — это контейнерный класс, представляющий собой отдельный кадр CAN. Подробнее...

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

Типы

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

Связанные нечлены

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

QCanBusFrame — это контейнерный класс, представляющий собой отдельный кадр CAN.

QCanBusDevice может использовать QCanBusFrame для операций чтения и записи. Он содержит идентификатор кадра и полезную нагрузку. QCanBusFrame содержит метку времени момента, когда он был прочитан.

См. также QCanBusFrame::TimeStamp.

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

перечисление QCanBusFrame::FrameErrorфлаги QCanBusFrame::FrameErrors

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

Тип FrameErrors — это typedef для QFlags<FrameError>. Он хранит логическое ИЛИ комбинацию значений FrameError.

перечисление QCanBusFrame::FrameType

Это перечисление описывает тип кадра CAN.

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

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

QCanBusFrame::QCanBusFrame(QCanBusFrame::FrameType type)

Создает кадр CAN указанного типа.

QCanBusFrame::QCanBusFrame(quint32 identifier = 0, const QByteArray &data = QByteArray())

Создает кадр CAN, используя identifier в качестве идентификатора кадра и data в качестве полезной нагрузки.

QCanBusFrame::FrameErrors QCanBusFrame::error() const

Возвращает ошибку текущего кадра ошибки. Если кадр не является ErrorFrame, эта функция возвращает NoError.

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

quint32 QCanBusFrame::frameId() const

Возвращает идентификатор кадра CAN. Если кадр CAN использует расширенный формат кадра, идентификатор имеет максимальную длину 29 бит; в противном случае 11 бит.

Если кадр имеет тип ErrorFrame, этот ID всегда равен 0.

См. также setFrameId() и hasExtendedFrameFormat().

FrameType QCanBusFrame::frameType() const

Возвращает тип кадра.

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

bool QCanBusFrame::hasExtendedFrameFormat() const

Возвращает true если в формате кадра CAN используется 29-битный идентификатор; в противном случае false, подразумевая 11-битный идентификатор.

См. также setExtendedFrameFormat() и frameId().

bool QCanBusFrame::isValid() const

Возвращает false если тип кадра frameType() равен InvalidFrame, hasExtendedFrameFormat() не установлен, хотя frameId() длиннее 11 бит или размер полезной нагрузки превышает максимальную разрешенную длину в 64 байта.

В противном случае эта функция возвращает true.

QByteArray QCanBusFrame::payload() const

Возвращает полезную нагрузку кадра.

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

void QCanBusFrame::setError(QCanBusFrame::FrameErrors error)

Устанавливает тип ошибки кадра error. Эта функция ничего не делает, если frameType() не является ErrorFrame.

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

void QCanBusFrame::setExtendedFrameFormat(bool isExtended)

Устанавливает флаг расширенного формата кадра в значение isExtended.

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

void QCanBusFrame::setFrameId(quint32 newFrameId)

Устанавливает идентификатор кадра CAN в значение newFrameId. Максимальный размер идентификатора кадра CAN составляет 11 бит, который может быть расширен до 29 бит, поддерживая расширенный формат кадра CAN. Настройка расширенного формата кадра CAN автоматически адаптируется для соответствия newFrameId.

См. также frameId() и hasExtendedFrameFormat().

void QCanBusFrame::setFrameType(FrameType newType)

Устанавливает тип кадра в значение newType.

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

void QCanBusFrame::setPayload(const QByteArray &data)

Устанавливает data в качестве полезной нагрузки для кадра CAN. Максимальный размер полезной нагрузки составляет 8 байт, который может быть расширен до 64 байт при поддержке Flexible Data-Rate. Flexible Data-Rate должен быть включен в QCanBusDevice, установив значение QCanBusDevice::CanFdKey.

Кадры типа RemoteRequestFrame (RTR) не имеют полезной нагрузки. Однако они должны указать ожидаемый размер полезной нагрузки ответов. Чтобы установить ожидаемую длину, необходимо установить фиктивную полезную нагрузку, длина которой соответствует ожидаемой длине полезной нагрузки ответа. Один из способов сделать это показан ниже:

QCanBusFrame frame(QCanBusFrame::RemoteRequestFrame);
int expectedResponseLength = ...;
frame.setPayload(QByteArray(expectedResponseLength, 0));

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

void QCanBusFrame::setTimeStamp(const TimeStamp &ts)

Устанавливает ts в качестве метки времени для кадра CAN. Как правило, эта функция не требуется, поскольку метка времени создается во время операции чтения, а не во время операции записи.

См. также timeStamp() и QCanBusFrame::TimeStamp.

TimeStamp QCanBusFrame::timeStamp() const

Возвращает метку времени кадра.

См. также QCanBusFrame::TimeStamp и QCanBusFrame::setTimeStamp().