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 からコピーされた値を使用して、メッセージの説明を作成します。
[constexpr noexcept default] QCanMessageDescription::QCanMessageDescription(QCanMessageDescription &&other)
other から移動して、メッセージの説明を作成します。
注: 移動元の QCanMessageDescriptionオブジェクトは 、破棄するか、または代入を行うことしかできません。デストラクタや代入演算子以外の関数を呼び出した場合、その挙動は未定義となります。
[constexpr noexcept default] 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)
other の値を、このメッセージ記述に「移動代入」します。
注: 移動元のQCanMessageDescription オブジェクトは 、破棄されるか、代入されることしかできません。デストラクタまたは代入演算子のいずれか以外の関数を呼び出した場合、その挙動は未定義となります。
QCanMessageDescription &QCanMessageDescription::operator=(const QCanMessageDescription &other)
other の値を、このメッセージの説明に割り当てます。
© 2026 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.