QCanFrameProcessor Class

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

QCanFrameProcessor::QCanFrameProcessor()

CANフレームプロセッサを作成する。

[noexcept] QCanFrameProcessor::~QCanFrameProcessor()

このフレームプロセッサを破壊する。

void QCanFrameProcessor::addMessageDescriptions(const QList<QCanMessageDescription> &descriptions)

利用可能なメッセージ記述に新しいメッセージ記述descriptions を追加します。

すべてのメッセージ記述は一意な ID を持つべきです。

いくつかのメッセージ記述が繰り返し一意な ID を持っている場合、最後の記述だけが使われます。

パーサが同じ一意な ID を持つメッセージ記述を持っていた場合、それは上書きされます。

messageDescriptions()、setMessageDescriptions()、clearMessageDescriptions()も参照のこと 。

void QCanFrameProcessor::clearMessageDescriptions()

このフレーム・プロセッサのすべてのメッセージ記述を削除します。

messageDescriptions()、addMessageDescriptions()、setMessageDescriptions()も参照してください 。

QCanFrameProcessor::Error QCanFrameProcessor::error() const

最後のエラーを返す。

errorString()、prepareFrame()、parseFrame()も参照 。

QString QCanFrameProcessor::errorString() const

最後のエラーの説明テキストを返す。

error()、prepareFrame() およびparseFrame()も参照 。

QList<QCanMessageDescription> QCanFrameProcessor::messageDescriptions() const

このフレーム・プロセッサが現在使用しているすべてのメッセージ記述を返します。

addMessageDescriptions()、setMessageDescriptions()、clearMessageDescriptions()も参照してください 。

QCanFrameProcessor::ParseResult QCanFrameProcessor::parseFrame(const QCanBusFrame &frame)

指定されたメッセージ記述を使ってフレームframe を解析する。

解析のプロセスは以下の通り：

1. uniqueIdDescription() は、メッセージの一意な識別子を抽出するために使用される。
2. 抽出された一意の識別子は、利用可能なすべてのmessageDescriptions() のリストから適切なQCanMessageDescription を検索するために使用される。
3. 一致したQCanMessageDescription は、フレームから信号値を抽出するために使用される。

このメソッドは、抽出された一意識別子と、シグナルとその値を含むQVariantMap の両方を含むQCanFrameProcessor::ParseResult を返す。マップのキーはsignal names であり、マップの値は信号値である。

デコード中にエラーが発生した場合、空のsignalValues が返される。このような場合、error() およびerrorString() メソッドを使用して、エラーに関する情報を得ることができる。

addMessageDescriptions()、error()、errorString()、warnings()も参照 。

QCanBusFrame QCanFrameProcessor::prepareFrame(QtCanBus::UniqueId uniqueId, const QVariantMap &signalValues)

uniqueId とsignalValues を使用して CAN データフレームを構築し、構築されたQCanBusFrame を返す。

signalValues パラメータには、キーとして信号名、値として期待される信号値を含める必要がある。

フレームの作成プロセスは以下のとおり：

1. uniqueId を使って、適切なメッセージ記述を探す。
2. メッセージ記述が見つかれば、指定されたサイズのペイロードを持つQCanBusFrame が作成される。ペイロードの全バイトとフレーム ID はゼロに初期化される。
3. uniqueIdDescription() は、uniqueId をフレームの適切な部分（フレーム ID またはペイロード）にエンコードするために使われる。
4. 選択されたメッセージ記述は、signalValues を全てフレームにエンコードするために使用される。
5. 一意な ID や既存の信号記述でカバーされていないフレームの部分は、そのままです（そのため、まだゼロが含まれています）。

エンコード中にエラーが発生した場合、無効なQCanBusFrame が返されます。このような場合、error() およびerrorString() メソッドを使用して、エラーに関する情報を得ることができる。

addMessageDescriptions()、error()、errorString()、warnings()も参照 。

void QCanFrameProcessor::setMessageDescriptions(const QList<QCanMessageDescription> &descriptions)

このフレーム・プロセッサが使用している現在のメッセージ記述を、新しいメッセージ記述descriptions で置き換えます。

messageDescriptions(),addMessageDescriptions(),clearMessageDescriptions()も参照 。

void QCanFrameProcessor::setUniqueIdDescription(const QCanUniqueIdDescription &description)

一意識別子記述をdescription に設定する。

CAN バスフレームをエンコードまたはデコードするには、一意識別子記述が有効でなければなりません。詳細はQCanUniqueIdDescription クラスのドキュメントを参照してください。

uniqueIdDescription() およびQCanUniqueIdDescriptionも参照してください 。

QCanUniqueIdDescription QCanFrameProcessor::uniqueIdDescription() const

一意識別子の記述を返す。

CANバスフレームをエンコードまたはデコードするためには、一意な識別子の記述が有効でなければなりません。詳細はQCanUniqueIdDescription クラスのドキュメントを参照。

setUniqueIdDescription() およびQCanUniqueIdDescriptionも参照 。

QStringList QCanFrameProcessor::warnings() const

最後のエンコードまたはデコード呼び出しの際に発生した警告のリストを返す。

error()、errorString()、prepareFrame()、parseFrame()も参照 。