QCanBusFrame Class

メンバー関数ドキュメント

[explicit noexcept] QCanBusFrame::QCanBusFrame(QCanBusFrame::FrameType type = DataFrame)

指定されたtype の CAN フレームを構築します。

QCanBusFrame::FrameType およびsetFrameType() も参照 。

[explicit] QCanBusFrame::QCanBusFrame(QCanBusFrame::FrameId identifier, const QByteArray &data)

identifier をフレーム識別子、data をペイロードとして CAN フレームを構築する。

QCanBusFrame::FrameIdも参照して ください。

[constexpr noexcept] QCanBusFrame::FrameErrors QCanBusFrame::error() const

現在のエラーフレームのエラーを返します。フレームがErrorFrame でない場合、この関数はNoError を返します。

QCanBusFrame::FrameError およびsetError() も参照 。

[constexpr noexcept] QCanBusFrame::FrameId QCanBusFrame::frameId() const

CAN フレーム識別子を返します。CANフレームが拡張フレームフォーマットを使用している場合、識別子は最大29ビット。

フレームがErrorFrame タイプの場合、この ID は常に 0 となる。

QCanBusFrame::FrameId 、setFrameId()、hasExtendedFrameFormat()も参照 。

[constexpr noexcept] QCanBusFrame::FrameType QCanBusFrame::frameType() const

フレームの型を返す。

QCanBusFrame::FrameType およびsetFrameType() も参照 。

[constexpr noexcept] bool QCanBusFrame::hasBitrateSwitch() const

CAN がFlexible Data-RatewithBitrate Switch を使用し、ペイロードデータをより高いデータビットレートで転送する場合、true を返す。

setBitrateSwitch() およびQCanBusDevice::DataBitRateKey も参照 。

[constexpr noexcept] bool QCanBusFrame::hasErrorStateIndicator() const

CANがFlexible Data-RatewithError State Indicatorを使用している場合、true を返す。

このフラグは、トランスミッターのCAN FDハードウェアによって設定され、トランスミッターのエラー状態を示す。

setErrorStateIndicator()も参照 。

[constexpr noexcept] bool QCanBusFrame::hasExtendedFrameFormat() const

CANフレームが29ビットの識別子を使用している場合はtrue を返し、そうでない場合はfalse を返す。

setExtendedFrameFormat() およびframeId() も参照 。

[constexpr noexcept] bool QCanBusFrame::hasFlexibleDataRateFormat() const

CAN フレームがフレキシブル・データレート（Flexible Data-Rate）を使用している場合はtrue を返し、そうでない場合はfalse を返す。

setFlexibleDataRateFormat() およびpayload()も参照のこと 。

[constexpr noexcept] bool QCanBusFrame::hasLocalEcho() const

フレームがローカル・エコー・フレームである場合、すなわち、同じ内容のフレームが CAN バスへ正常に送信されたときにエコーとして受信されたフレームである場合、true を返します。このフラグは、アプリケーション自身によって送信されたフレームにも、同じシステム上で動作している他のアプリケーションによって送信されたフレームにも設定されます。

QCanBusDevice::ReceiveOwnKey エコー・フレームを受信するには、true を設定する必要があります。

setLocalEcho()、QCanBusDevice::ReceiveOwnKey 、およびQCanBusDevice::LoopbackKeyも参照してください 。

[noexcept] bool QCanBusFrame::isValid() const

frameType() がInvalidFrame の場合、frameId() が 11 ビットより長いか、ペイロードが最大許容ペイロード長である 64 バイト（フレキシブル・データ・レート・モードが有効な場合は 64 バイト、無効な場合は 8 バイト）より長いが、hasExtendedFrameFormat() が設定されていない場合、false を返す。frameType() がRemoteRequestFrame であり、同時にフレキシブル・データ・レート・モードが有効になっている場合、false も返される。

そうでない場合、この関数はtrue を返す。

QByteArray QCanBusFrame::payload() const

フレームのデータペイロードを返す。

setPayload()も参照のこと 。

[constexpr noexcept] void QCanBusFrame::setBitrateSwitch(bool bitrateSwitch)

Flexible Data-RateflagBitrate SwitchフラグをbitrateSwitch に設定する。 このフラグが設定されたフレームのデータフィールドは、より高いデータビットレートで転送される。

hasBitrateSwitch() およびQCanBusDevice::DataBitRateKey も参照 。

[constexpr] void QCanBusFrame::setError(QCanBusFrame::FrameErrors error)

フレームのerror タイプを設定する。frameType() がErrorFrame でない場合、この関数は何もしない。

QCanBusFrame::FrameError およびerror()も参照 。

[constexpr noexcept] void QCanBusFrame::setErrorStateIndicator(bool errorStateIndicator)

Flexible Data-RateflagError State IndicatorフラグをerrorStateIndicator に設定する。

CAN FDフレームを送信するとき、このフラグはCAN FDハードウェアによって自動的に設定される。QCanBusFrame::setErrorStateIndicator() は、仮想CAN FDバスなどのアプリケーションテストにのみ使用すべきである。

hasErrorStateIndicator()も参照 。

[constexpr noexcept] void QCanBusFrame::setExtendedFrameFormat(bool isExtended)

拡張フレーム・フォーマット・フラグをisExtended に設定する。

hasExtendedFrameFormat()も参照 。

[constexpr noexcept] void QCanBusFrame::setFlexibleDataRateFormat(bool isFlexibleData)

フレキシブル・データ・レート・フラグをisFlexibleData に設定します。これらのフレームは、サポートするコントローラでより高速に送信することができます。さらに、ペイロード長の上限が64バイトに引き上げられる。

hasFlexibleDataRateFormat()も参照 。

[constexpr] void QCanBusFrame::setFrameId(QCanBusFrame::FrameId newFrameId)

CAN フレームの識別子をnewFrameId に設定する。

CANフレーム識別子の最大サイズは11ビットで、CAN拡張フレーム・フォーマットをサポートすることで、最大29ビットまで拡張できます。11ビットを超えるサイズのnewFrameId を指定すると、CAN拡張フレームフォーマットの設定が自動的に設定されます。

フォーマットが拡張され、11ビット以下のnewFrameId が渡された場合、CAN拡張フレームフォーマットの設定は変更されない。

QCanBusFrame::FrameId 、frameId （）、hasExtendedFrameFormat （）も参照 。

[constexpr noexcept] void QCanBusFrame::setFrameType(QCanBusFrame::FrameType newType)

フレームのタイプをnewType に設定する。

QCanBusFrame::FrameType およびframeType() も参照 。

[constexpr noexcept] void QCanBusFrame::setLocalEcho(bool echo)

ローカル・エコー・フラグをecho に設定する。

QCanBusDevice::ReceiveOwnKey を有効にしてCANバスフレームを送信すると、正常に送信されたフレームはすべて受信キューにエコーされ、ローカルエコーフレームとしてマークされます。したがって、QCanBusFrame::setLocalEcho は、仮想CANバスなどのアプリケーションテストにのみ使用する必要があります。

hasLocalEcho()も参照してください 。

void QCanBusFrame::setPayload(const QByteArray &data)

CAN フレームのペイロードとしてdata を設定する。ペイロードの最大サイズは8バイトであり、Flexible Data-Rateをサポートすることで最大64バイトまで拡張できる。data に 8 バイト以上のデータが入っている場合、自動的にFlexible Data-Rateフラグが設定される。フレキシブル・データ・レートは、QCanBusDevice::CanFdKey を設定することによって、QCanBusDevice で有効にする必要がある。

タイプRemoteRequestFrame （RTR）のフレームはペイロードを持たない。しかし、レスポンスの予想ペイロード長を示す必要がある。期待される長さを設定するには、応答の期待されるペイロード長と一致する長さの 偽のペイロードを設定する必要がある。これを行う1つの方法は以下のようなものである：

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

payload() およびhasFlexibleDataRateFormat()も参照のこと 。

[constexpr noexcept] void QCanBusFrame::setTimeStamp(QCanBusFrame::TimeStamp ts)

CANフレームのタイムスタンプとしてts 。通常、この関数は不要である。なぜなら、タイムスタンプは読み込み時に作成され、書き込み時には必要ないからである。

timeStamp() およびQCanBusFrame::TimeStampも参照 。

[constexpr noexcept] QCanBusFrame::TimeStamp QCanBusFrame::timeStamp() const

フレームのタイムスタンプを返します。

QCanBusFrame::TimeStamp およびQCanBusFrame::setTimeStamp() も参照 。

QString QCanBusFrame::toString() const

CANフレームをフォーマットされた文字列として返します。

出力には、32ビットに右寄せされた16進数形式のCAN識別子、角括弧内のデータ長、16進数形式のペイロードが含まれる。

標準識別子はスペースで埋められ、拡張識別子はゼロで埋められます。

典型的な出力は以下の通り：

(Error)                                  - error frame
     7FF   [1]  01                       - data frame with standard identifier
1FFFFFFF   [8]  01 23 45 67 89 AB CD EF  - data frame with extended identifier
     400  [10]  01 23 45 67 ... EF 01 23 - CAN FD frame
     123   [5]  Remote Request           - remote frame with standard identifier
00000234   [0]  Remote Request           - remote frame with extended identifier