QScxmlEvent Class
QScxmlEventクラスは、Qt SCXML ステートマシンのイベントです。詳細...
| ヘッダー | #include <QScxmlEvent> |
| CMake： | find_package(Qt6 REQUIRED COMPONENTS Scxml)target_link_libraries(mytarget PRIVATE Qt6::Scxml) |
| qmake： | QT += scxml |
パブリックタイプ
| enum | EventType { PlatformEvent, InternalEvent, ExternalEvent } |
プロパティ
|
|
パブリック機能
| QScxmlEvent() | |
| QScxmlEvent(const QScxmlEvent &other) | |
| ~QScxmlEvent() | |
| void | clear() |
| QVariant | data() const |
| int | delay() const |
| QString | errorMessage() const |
| QScxmlEvent::EventType | eventType() const |
| QString | invokeId() const |
| bool | isErrorEvent() const |
| QString | name() const |
| QString | origin() const |
| QString | originType() const |
| QString | scxmlType() const |
| QString | sendId() const |
| void | setData(const QVariant &data) |
| void | setDelay(int delayInMiliSecs) |
| void | setErrorMessage(const QString &message) |
| void | setEventType(const QScxmlEvent::EventType &type) |
| void | setInvokeId(const QString &invokeid) |
| void | setName(const QString &name) |
| void | setOrigin(const QString &origin) |
| void | setOriginType(const QString &origintype) |
| void | setSendId(const QString &sendid) |
| QScxmlEvent & | operator=(const QScxmlEvent &other) |
詳細説明
SCXMLイベントはトランジションを駆動します。ほとんどのイベントは、アプリケーションの<raise> と<send> エレメントを使用することで生成されます。ステートマシンはエラーなどの必須イベントを自動的に生成します。
詳細はSCXML仕様 - 5.10.1 イベントの内部構造を参照してください。Qt SCXML API が仕様とどのように異なるかについての詳細はSCXML Compliance を参照してください。
QScxmlStateMachineも参照して ください。
メンバ型ドキュメント
enum QScxmlEvent::EventType
この列挙型は SCXML イベントのタイプを指定します：
| 定数 | 値 | 説明 |
|---|---|---|
QScxmlEvent::PlatformEvent | 0 | ステートマシンが内部的に生成するイベント。例えば、エラー。 |
QScxmlEvent::InternalEvent | 1 | <raise> 要素によって生成されるイベント。 |
QScxmlEvent::ExternalEvent | 2 | <send> 要素によって生成されるイベント。 |
プロパティー ドキュメント
data : QVariant
このプロパティは、送信者によって含まれるデータを保持する。
<send> 要素の中に<param> 要素が使われている場合、データはQVariantMap を含み、キーはname属性で、値はexpr属性かlocation属性から取られます。
<content> 要素が使われる場合、<content> 要素のexpr属性の値か、<content> 要素の子データのどちらかを持つ単一の項目がデータに含まれます。
アクセス関数：
delay : int
このプロパティは、<send> 要素を処理した後、イベントが配信されるまでの遅延をミリ秒単位で保持する。
アクセス関数：
[read-only] errorEvent : const bool
このプロパティは、イベントがエラーを表すかどうかを保持する。
アクセス関数：
| bool | isErrorEvent() const |
errorMessage : QString
このプロパティは、エラーイベントのエラーメッセージ、または空のQString を保持する。
アクセス関数：
| QString | errorMessage() const |
| void | setErrorMessage(const QString &message) |
eventType : EventType
このプロパティは、イベントのタイプを保持する。
アクセス関数です：
| QScxmlEvent::EventType | eventType() const |
| void | setEventType(const QScxmlEvent::EventType &type) |
invokeId : QString
このプロパティは、イベントがステートマシンによって生成された場合、呼び出されたステートマシンの ID を保持する。
アクセス関数：
| QString | invokeId() const |
| void | setInvokeId(const QString &invokeid) |
name : QString
このプロパティはイベントの名前を保持する。
イベントが SCXML ドキュメント内で生成される場合、このプロパティは<raise> または<send> 要素内で指定されたevent属性の値を保持します。
イベントが C++ コード内で生成され、QScxmlStateMachine にサブミットされた場合、このプロパティの値は SCXML ドキュメント内の<transition> 要素内で指定されたevent属性の値と照合されます。
アクセス関数：
origin : QString
このプロパティは SCXML イベントの起点を示す URI を保持する。
この origin は<send> 要素のtarget属性に相当します。
アクセス関数：
originType : QString
このプロパティは SCXML イベントのオリジンタイプを保持する。
オリジンタイプは<send> 要素のtype属性と等価です。
アクセス関数：
| QString | originType() const |
| void | setOriginType(const QString &origintype) |
[read-only] scxmlType : const QString
このプロパティは、イベントタイプを保持する。
アクセス関数です：
| QString | scxmlType() const |
sendId : QString
このプロパティは、イベントの ID を保持する。
このIDは、<cancel> 要素によって、キャンセルされるイベントを識別するために使用される。
注： <send> 要素でid属性が指定されていない場合、ステートマシンは一意の ID を生成する。生成されたIDは、このプロパティを通じてアクセスできる。
アクセス関数：
メンバ関数ドキュメント
QScxmlEvent::QScxmlEvent()
新しい外部 SCXML イベントを作成します。
QScxmlEvent::QScxmlEvent(const QScxmlEvent &other)
other のコピーを作成する。
[noexcept] QScxmlEvent::~QScxmlEvent()
SCXML イベントを破棄します。
[invokable] void QScxmlEvent::clear()
イベントの内容をクリアします。
注意： この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。
QVariant QScxmlEvent::data() const
送信者が含むデータを返す。
注： プロパティ・データ用のゲッター関数。
setData()も参照してください 。
int QScxmlEvent::delay() const
<send> 要素を処理した後、このイベントが配信されるまでの遅延をミリ秒単位で返す。
注: プロパティ delay のゲッター関数です。
setDelay()も参照 。
QString QScxmlEvent::errorMessage() const
これがエラー・イベントの場合、エラー・メッセージを返す。そうでない場合は、空のQString を返します。
注： errorMessage プロパティのゲッター関数です。
setErrorMessage()も参照してください 。
QScxmlEvent::EventType QScxmlEvent::eventType() const
このイベントのタイプを返す。
注： プロパティ eventType のゲッター関数。
setEventType() およびQScxmlEvent::EventTypeも参照のこと 。
QString QScxmlEvent::invokeId() const
このイベントが呼び出されたステートマシンによって生成された場合、<invoke> 要素の ID を返す。そうでない場合は、空の値を返します。
注: プロパティ invokeId のゲッター関数です。
setInvokeId()も参照してください 。
bool QScxmlEvent::isErrorEvent() const
これがエラーイベントの場合はtrue を、そうでない場合はfalse を返す。
注: プロパティのゲッター関数errorEvent 。
QString QScxmlEvent::name() const
イベント名を返す。
注： プロパティ名のゲッター関数。
setName()も参照してください 。
QString QScxmlEvent::origin() const
SCXML イベントの起点を指す URI を返します。
注意: プロパティ origin のゲッター関数です。
setOrigin()も参照 。
QString QScxmlEvent::originType() const
SCXML イベントのオリジンタイプを返します。
注意: originType プロパティのゲッター関数です。
setOriginType()も参照 。
QString QScxmlEvent::scxmlType() const
イベントタイプを返す。
注： プロパティ scxmlType のゲッター関数です。
QString QScxmlEvent::sendId() const
イベントのIDを返す。
注： プロパティ sendId のゲッター関数です。
setSendId()も参照してください 。
void QScxmlEvent::setData(const QVariant &data)
ペイロードデータをdata に設定する。
注: プロパティのセッター関数data 。
QScxmlEvent::dataも参照してください 。
void QScxmlEvent::setDelay(int delayInMiliSecs)
遅延時間をミリ秒単位でdelayInMiliSecs の値として設定します。
注： delay プロパティのセッター関数。
QScxmlEvent::delayも参照 。
void QScxmlEvent::setErrorMessage(const QString &message)
これがエラーイベントの場合、エラーメッセージとしてmessage が設定される。
注: プロパティerrorMessage のセッター関数です。
errorMessage()も参照してください 。
void QScxmlEvent::setEventType(const QScxmlEvent::EventType &type)
イベントタイプをtype に設定する。
注: プロパティのセッター関数eventType 。
QScxmlEvent::eventType およびQScxmlEvent::EventTypeも参照してください 。
void QScxmlEvent::setInvokeId(const QString &invokeid)
呼び出されたステートマシンの ID をinvokeid に設定する。
注: プロパティのセッター関数invokeId 。
void QScxmlEvent::setName(const QString &name)
イベント名をname に設定する。
注： プロパティname に対するセッター関数。
name()も参照 。
void QScxmlEvent::setOrigin(const QString &origin)
SCXML イベントのオリジンをorigin に設定します。
注意: プロパティのセッター関数origin 。
QScxmlEvent::originも参照してください 。
void QScxmlEvent::setOriginType(const QString &origintype)
SCXML イベントのオリジンタイプをorigintype に設定します。
注意: プロパティのセッター関数originType 。
QScxmlEvent::originTypeも参照してください 。
void QScxmlEvent::setSendId(const QString &sendid)
このイベントの IDsendid を設定する。
注: プロパティsendId のセッター関数です。
sendId()も参照 。
QScxmlEvent &QScxmlEvent::operator=(const QScxmlEvent &other)
この SCXML イベントにother を割り当て、この SCXML イベントへの参照を返します。
© 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.
