QCanMessageDescription Class
QCanMessageDescriptionクラスは、CANメッセージを処理し、アプリケーション定義のフォーマットで表現するルールを記述します。詳細...
| Header: | #include <QCanMessageDescription> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS SerialBus)target_link_libraries(mytarget PRIVATE Qt6::SerialBus) |
| qmake: | QT += serialbus |
| Since: | Qt 6.5 |
| Status: | Preliminary |
このクラスは開発中のため、変更される場合があります。
パブリック関数
| QCanMessageDescription() | |
| QCanMessageDescription(const QCanMessageDescription &other) | |
| QCanMessageDescription(QCanMessageDescription &&other) | |
| ~QCanMessageDescription() | |
| void | addSignalDescription(const QCanSignalDescription &description) |
| void | clearSignalDescriptions() |
| QString | comment() const |
| bool | isValid() const |
| QString | name() const |
| void | setComment(const QString &text) |
| void | setName(const QString &name) |
| void | setSignalDescriptions(const QList<QCanSignalDescription> &descriptions) |
| void | setSize(quint8 size) |
| void | setTransmitter(const QString &transmitter) |
| void | setUniqueId(QtCanBus::UniqueId id) |
| QCanSignalDescription | signalDescriptionForName(const QString &name) const |
| QList<QCanSignalDescription> | signalDescriptions() const |
| quint8 | size() const |
| QString | transmitter() const |
| QtCanBus::UniqueId | uniqueId() const |
| QCanMessageDescription & | operator=(QCanMessageDescription &&other) |
| QCanMessageDescription & | operator=(const QCanMessageDescription &other) |
詳細説明
CANメッセージは、基本的にQCanBusFrame 。 CANメッセージの記述には、以下のものが含まれる：
- メッセージID。
- メッセージ名。
- メッセージの長さ（バイト）。
- メッセージのソース（送信機）。
- メッセージ内のシグナルの説明
QCanMessageDescriptionクラスは、これらすべてのパラメータを制御するメソッドを提供します。
メッセージID
メッセージIDは一意の識別子であり、入力されたQCanBusFrame をデコードする際や、提供されたデータに基づいてQCanBusFrame をエンコードする際に、適切なメッセージ記述を選択するために使用されます。
一意識別子記述の詳細については、QCanUniqueIdDescription のドキュメントを参照。
シグナル記述
シグナルの説明は、QCanSignalDescription クラスで表されます。QCanMessageDescriptionクラスは、メッセージに属するシグナルのリストのみを提供します。
QCanSignalDescription およびQCanUniqueIdDescriptionも参照してください 。
メンバ関数 説明
QCanMessageDescription::QCanMessageDescription()
空のメッセージ記述を作成します。
QCanMessageDescription::QCanMessageDescription(const QCanMessageDescription &other)
other からコピーした値でメッセージ記述を作成します。
[noexcept] QCanMessageDescription::QCanMessageDescription(QCanMessageDescription &&other)
other から移動してメッセージ記述を作成します。
注意: 移動元の QCanMessageDescription オブジェクトは、破棄または代入のみが可能です。デストラクタや代入演算子以外の関数を呼び出した場合の効果は未定義です。
[noexcept] QCanMessageDescription::~QCanMessageDescription()
このメッセージ記述を破棄します。
void QCanMessageDescription::addSignalDescription(const QCanSignalDescription &description)
このメッセージ記述に新しいシグナル記述description を追加します。
メッセージ記述に同じ名前のシグナルの記述が既にある場合、上書きされます。
signalDescriptions()、signalDescriptionForName()、setSignalDescriptions()、clearSignalDescriptions()も参照してください 。
void QCanMessageDescription::clearSignalDescriptions()
このメッセージのすべてのシグナル記述を消去します。
signalDescriptions()、signalDescriptionForName()、addSignalDescription()、setSignalDescriptions() も参照して ください。
QString QCanMessageDescription::comment() const
メッセージのコメントを返します。
このパラメータは追加説明のためだけに導入されました。メッセージのエンコード中やデコード中には使用されません。
setComment()も参照 。
bool QCanMessageDescription::isValid() const
メッセージ記述が有効な場合はtrue を、そうでない場合はfalse を返す。
有効なメッセージ記述には、少なくとも1つのシグナル記述が必要です。すべてのシグナル記述も有効でなければならない。
signalDescriptions() およびQCanSignalDescription::isValid()も参照 。
QString QCanMessageDescription::name() const
CANメッセージの名前を返す。
このパラメータは追加記述のためだけに導入されている。メッセージのエンコード中やデコード中には使用されない。
setName()も参照してください 。
void QCanMessageDescription::setComment(const QString &text)
メッセージのコメントをtext に設定する。
このパラメータは、補足説明のためだけに導入された。メッセージのエンコード中やデコード中には使用されません。
comment()も参照 。
void QCanMessageDescription::setName(const QString &name)
CAN メッセージの名前をname に設定します。
このパラメータは、補足説明のためだけに導入された。メッセージのエンコード中やデコード中には使用されません。
name()も参照 。
void QCanMessageDescription::setSignalDescriptions(const QList<QCanSignalDescription> &descriptions)
このメッセージ記述に属するシグナルの記述をdescriptions に設定する。
注意: メッセージ記述には、一意なシグナル名を持つシグナルの記述が必要です。そのため、descriptions のリストに重複した名前のエントリがある場合、最後のエントリだけが追加されます。
signalDescriptions()、signalDescriptionForName()、addSignalDescription()、clearSignalDescriptions()も参照 。
void QCanMessageDescription::setSize(quint8 size)
CAN メッセージのサイズをバイト単位でsize に設定する。
size() も参照 。
void QCanMessageDescription::setTransmitter(const QString &transmitter)
メッセージの送信ノードをtransmitter に設定します。
このパラメータは、補足説明のためだけに導入されています。メッセージのエンコード中やデコード中には使用されません。
transmitter()も参照してください 。
void QCanMessageDescription::setUniqueId(QtCanBus::UniqueId id)
CAN メッセージの一意な識別子をid に設定します。
一意識別子についての詳細はMessage ID のセクションを参照。
uniqueId() も参照 。
QCanSignalDescription QCanMessageDescription::signalDescriptionForName(const QString &name) const
name という名前のシグナルの説明を返します。
メッセージ記述にそのようなシグナル記述がない場合、デフォルトで構成されたQCanSignalDescription オブジェクトが返されます。
signalDescriptions()、addSignalDescription()、setSignalDescriptions() およびclearSignalDescriptions()も参照 。
QList<QCanSignalDescription> QCanMessageDescription::signalDescriptions() const
このメッセージ記述に属するシグナル記述のリストを返します。
signalDescriptionForName()、addSignalDescription()、setSignalDescriptions()、clearSignalDescriptions() も参照 。
quint8 QCanMessageDescription::size() const
CAN メッセージのサイズをバイト単位で返します。
setSize()も参照 。
QString QCanMessageDescription::transmitter() const
メッセージの送信ノードを返す。
このパラメータは、補足説明のためだけに導入されています。メッセージのエンコード中やデコード中には使用されない。
setTransmitter() も参照 。
QtCanBus::UniqueId QCanMessageDescription::uniqueId() const
CAN メッセージの一意な識別子を返します。
一意識別子についての詳細はMessage ID のセクションを参照。
setUniqueId()も参照 。
[noexcept] QCanMessageDescription &QCanMessageDescription::operator=(QCanMessageDescription &&other)
Move-other の値をこのメッセージ記述に代入する。
注意: 移動されたQCanMessageDescription オブジェクトは、破棄または代入のみ可能です。デストラクタまたは代入演算子の 1 つ以外の関数を呼び出した場合の効果は未定義です。
QCanMessageDescription &QCanMessageDescription::operator=(const QCanMessageDescription &other)
other の値をこのメッセージ記述に代入します。
本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
