QCanMessageDescription Class
QCanMessageDescriptionクラスは、CANメッセージを処理し、アプリケーション定義のフォーマットで表現するルールを記述します。詳細...
ヘッダー | #include <QCanMessageDescription> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS SerialBus) target_link_libraries(mytarget PRIVATE Qt6::SerialBus) |
qmake: | QT += serialbus |
以来: | Qt 6.5 |
ステータス | 予備 |
このクラスは開発中であり、変更される可能性があります。
パブリック関数
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 オブジェクトは、破棄または代入しかできません。デストラクタや代入演算子以外の関数を呼び出した場合の効果は未定義です。
QCanMessageDescription &QCanMessageDescription::operator=(const QCanMessageDescription &other)
other の値をこのメッセージの説明に割り当てる。
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.