QCanBusDevice Class

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

[explicit] QCanBusDevice::QCanBusDevice(QObject *parent = nullptr)

指定されたparent でシリアル・バス・デバイスを構築する。

[virtual] 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

現在のQCanBusDevice に対するQCanBusDeviceInfo を返す。この関数がQCanBusDevice のサブクラスによって実装されていない場合、デフォルトの構築済みオブジェクトが返されます。

この関数は Qt 6.2 で導入されました。

void QCanBusDevice::disconnectDevice()

デバイスをCANバスから切断する。

この関数は、実装の一部としてclose() を呼び出す。

connectDevice()も参照 。

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

writeFrame() でアクセスできる発信フレームの内部リストにnewFrame を追加する。

サブクラスは、新しいフレームを書くときにこの関数を呼び出す必要があります。

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

readFrame() を使ってアクセスできるフレームの内部リストにnewFrames を追加し、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()

このシグナルは、1つ以上のフレームを受信したときに発せられる。フレームはreadFrame() とframesAvailable() を使って読み込む必要がある。

qint64 QCanBusDevice::framesToWrite() const

バッファ付きデバイスの場合、この関数は書き込み待ちフレーム数を返す。バッファリングされていないデバイスの場合、この関数は常にゼロを返す。

clear() およびwriteFrame()も参照 。

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

このシグナルは、フレームのペイロードがCANバスに書き込まれるたびに発行される。引数framesCount には、このペイロードに書き込まれたフレーム数が設定される。

[virtual] bool QCanBusDevice::hasBusStatus() const

CAN プラグインが CAN バスステータスのリクエストをサポートしている場合は true を返す。

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()によって呼び出される。サブクラスは、CANバス接続が確立できた場合はtrue を返す実装を提供しなければならない。そうでない場合はfalse 。QCanBusDevice の実装は、この関数のエントリー時に、デバイスのstate() がすでにQCanBusDevice::ConnectingState に設定されていることを保証する。

QCanBusDevice::UnconnectedState実装は、成功時にインスタンスのstate() がQCanBusDevice::ConnectedState に設定されていることを保証しなければならない。setState()を使用して新しいデバイスの状態を設定しなければならない。

カスタム実装は、ソケットのオープン、潜在的に必要とされるQSocketNotifier のインスタンス化、カスタムおよびデフォルトのQCanBusDevice::configurationParameter() の適用を担当する。

connectDevice()も参照のこと 。

QList<QCanBusFrame> QCanBusDevice::readAllFrames()

全てのQCanBusFrames をキューから返す。そうでなければ、空の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()も参照のこと 。

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

バッファリングされたデバイスの場合、この関数は、バッファリングされたすべてのフレームがデバイスに書き込まれ、framesWritten （）シグナルが発せられるか、msecs ミリ秒が経過するまで待ちます。msecs が -1 の場合、この関数はタイムアウトしません。バッファのないデバイスの場合、writeFrame （）は書き込みバッファを必要としないため、false で即座に返される。

framesWritten() シグナルが発せられた場合はtrue を返し、そうでない場合はfalse を返す（操作がタイムアウトした場合、またはエラーが発生した場合など）。

waitForFramesReceived()も参照のこと 。

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

CANバスにframe を書き込み、成功した場合はtrue を返す。そうでない場合はfalse 。

プラットフォームによっては、フレームがキューに入れられ、戻り値がキューへの挿入の成功のみを示す場合もある。実際のフレームは後で送信される。したがって、framesWritten() シグナルは、フレームがトランスポート層に引き渡されたことを最終的に確認するものである。エラーが発生した場合は、errorOccurred （）が発信される。

CANバスの仕様に従い、remote transfer request (RTR) タイプのフレームはペイロードを持たず、0～8（を含む）の長さを持つ。この長さは、リモート・パーティから予想されるレスポンスのペイロード長を示します。したがって、この機能を使用して RTR フレームを送信する場合でも、frame に任意のペイロードを設定する必要がある場合があります。任意のペイロードの長さは、RTR フレームの期待サイズとして設定されるものです。

QCanBusFrame::setPayload()も参照のこと 。