Back to Qt.io
Contact Us Blog Download Qt

QScxmlEvent Class

QScxmlEvent クラスは、Qt SCXML ステートマシンのイベントです。詳細...

Header: #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 Specification - 5.10.1 The Internal Structure of Events を参照してください。Qt SCXML API と仕様の違いについてはSCXML Compliance を参照してください。

QScxmlStateMachineも参照して ください。

メンバ型のドキュメント

enum QScxmlEvent::EventType

この enum 型は SCXML イベントの型を指定します：

定数値説明
QScxmlEvent::PlatformEvent0ステートマシンが内部的に生成するイベント。例えば、エラー。
QScxmlEvent::InternalEvent1<raise> 要素によって生成されるイベント。
QScxmlEvent::ExternalEvent2<send> 要素によって生成されるイベント。

プロパティ Documentation

data : QVariant

このプロパティは、送信者によって含まれるデータを保持する。

<send> 要素の中で<param> 要素が使われている場合、データにはQVariantMap が含まれ、キーはname属性、値はexpr属性またはlocation属性から取られます。

<content> 要素が使われる場合、<content> 要素のexpr属性の値か、<content> 要素の子データのどちらかを持つ単一の項目がデータに含まれます。

アクセス関数：

QVariant data() const
void setData(const QVariant &data)

delay : int

このプロパティは、<send> 要素の処理後にイベントを配信するまでの遅延をミリ秒単位で保持する。

アクセス関数：

int delay() const
void setDelay(int delayInMiliSecs)

[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

アクセス関数：このプロパティは、イベントのタイプを保持する。

アクセス関数：

QString invokeId() const
void setInvokeId(const QString &invokeid)

name : QString

このプロパティはイベントの名前を保持します。

イベントが SCXML ドキュメント内で生成された場合、このプロパティは<raise> または<send> 要素内で指定されたevent属性の値を保持します。

イベントが C++ コード内で生成され、QScxmlStateMachine にサブミットされた場合、このプロパティの値は SCXML ドキュメント内の<transition> 要素内で指定されたevent属性の値と照合されます。

アクセス関数：

QString name() const
void setName(const QString &name)

origin : QString

このプロパティは SCXML イベントの起点を指す URI を保持する。

この origin は<send> 要素のtarget属性に相当する。

アクセス関数：

QString origin() const
void setOrigin(const QString &origin)

originType : QString

このプロパティは、SCXML イベントの起点のタイプを保持する。

origin type は<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は、このプロパティを通じてアクセスできる。

アクセス関数：

QString sendId() const
void setSendId(const QString &sendid)

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

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> 要素を処理した後、このイベントが配信されるまでの遅延時間をミリ秒単位で返す。

備考： プロパティ遅延のゲッター関数。

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

イベント名を返す。

注釈 : プロパティ name のゲッター関数。

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 。

QScxmlEvent::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 イベントへの参照を返します。

本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。