このページでは

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準拠」を参照してください。

「QScxmlStateMachine」も参照してください 。

メンバ型のドキュメント

enum QScxmlEvent::EventType

この列挙型は、SCXML イベントのタイプを指定します:

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

プロパティのドキュメント

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 : 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> 要素内で指定されたイベント属性の値が格納されます。

イベントが 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 型は、<send> 要素のtype属性と同等です。

アクセス関数:

QString originType() const
void setOriginType(const QString &origintype)

[read-only] scxmlType : 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

送信者が含めたデータを返します。

注: プロパティ dataのゲッター 関数です。

関連項目: 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

イベントの名前を返します。

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

関連項目: setName()。

QString QScxmlEvent::origin() const

SCXMLイベントの発生元を指すURIを返します。

注: プロパティ `origin`のゲッター 関数です。

関連項目: setOrigin()。

QString QScxmlEvent::originType() const

SCXMLイベントのoriginTypeを返します。

注: プロパティ 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)

このイベントの ID「sendid 」を設定します。

注: プロパティsendId のセッター 関数です。

sendId()も参照してください 。

QScxmlEvent &QScxmlEvent::operator=(const QScxmlEvent &other)

このSCXMLイベントにother を割り当て、このSCXMLイベントへの参照を返します。

© 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.