QScxmlStateMachine Class

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

[invokable] QStringList QScxmlStateMachine::activeStateNames(bool compress = true) const

アクティブなすべての状態の名前の一覧を取得します。

状態がアクティブな場合、定義上、そのすべての親状態もアクティブとなります。compress がtrue （デフォルト）の場合、親状態は除外され、リーフ状態のみが返されます。false の場合、アクティブな状態の完全なリストが返されます。

[invokable] void QScxmlStateMachine::cancelDelayedEvent(const QString &sendId)

指定されたsendId を持つ遅延イベントをキャンセルします。

scxmlEventSpec で指定されたイベントから、functor への、指定されたtype による接続を作成します。 は、ファンクタ、またはオプションのcontext オブジェクトのメンバ関数である場合があります。

レシーバーのfunctor は、QScxmlEvent をパラメータとして受け取る必要があります。

SCXML ドキュメントのイベント仕様とは対照的に、ここでの `scxmlEventSpec ` にはスペースを使用することはできません。異なるプレフィックスを持つ複数のイベントに接続するには、connectToEvent() を複数回呼び出す必要があります。

接続へのハンドルを返します。このハンドルは、後で接続を切断するために使用できます。

QMetaObject::Connection QScxmlStateMachine::connectToEvent(const QString &scxmlEventSpec, const QObject *receiver, const char *method, Qt::ConnectionType type = Qt::AutoConnection)

scxmlEventSpec で指定されたイベントから、指定されたtype への接続を、receiver オブジェクト内のmethod に対して作成します。レシーバーのmethod は、QScxmlEvent をパラメータとして受け取ることができます。例：

void mySlot(const QScxmlEvent &event);

SCXMLドキュメント内のイベント仕様とは異なり、ここでのscxmlEventSpec にはスペースを含めることはできません。異なるプレフィックスを持つ複数のイベントに接続するには、connectToEvent()を複数回呼び出す必要があります。

接続へのハンドルを返します。このハンドルは、後で接続を切断するために使用できます。

指定されたtype を、scxmlStateName で指定された状態からfunctor へと接続します。 は、ファンクター、あるいはオプションのcontext オブジェクトのメンバ関数である場合があります。

レシーバーのfunctor は、接続された状態がアクティブになったか非アクティブになったかを示すブール値の引数を受け取る必要があります。

接続へのハンドルを返します。このハンドルは、後で接続を切断するために使用できます。

QMetaObject::Connection QScxmlStateMachine::connectToState(const QString &scxmlStateName, const QObject *receiver, const char *method, Qt::ConnectionType type = Qt::AutoConnection)

指定されたtype から、scxmlStateName で識別される状態を経由して、receiver オブジェクト内のmethod への接続を作成します。レシーバーのmethod は、接続された状態がアクティブになったか非アクティブになったかを示すブール値の引数を受け取ることができます。例：

void mySlot(bool active);

接続へのハンドルを返します。このハンドルは、後で接続を切断するために使用できます。

QScxmlDataModel *QScxmlStateMachine::dataModel() const

ステートマシンで使用されているデータモデルを返します。

関連項目： setDataModel()。

[signal] void QScxmlStateMachine::finished()

このシグナルは、ステートマシンが最上位の最終状態に達したときに発信されます。

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

[static] QScxmlStateMachine *QScxmlStateMachine::fromData(QIODevice *data, const QString &fileName = QString())

data で指定されたQIODevice から読み込んで、ステートマシンを作成します。

このメソッドは常にステートマシンを返します。SCXMLファイル（fileName ）の読み込み中にエラーが発生した場合、ステートマシンを起動することはできません。エラーは、parseErrors() メソッドを呼び出すことで取得できます。

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

[static] QScxmlStateMachine *QScxmlStateMachine::fromFile(const QString &fileName)

fileName で指定されたSCXMLファイルからステートマシンを作成します。

このメソッドは常にステートマシンを返します。SCXML ファイルの読み取り中にエラーが発生した場合、ステートマシンを起動することはできません。エラーは、parseErrors() メソッドを呼び出すことで取得できます。

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

[slot] bool QScxmlStateMachine::init()

ステートマシンを初期化します。

ステートマシンの初期化は、QScxmlDataModel::setup()の呼び出し、<data> 要素の初期値の設定、および<scxml> タグ内の<script> タグの実行で構成されます。初期データ値はinitialValues プロパティから取得されます。

解析エラーが発生した場合、または初期化手順のいずれかが失敗した場合は、false を返します。それ以外の場合は、true を返します。

[invokable] bool QScxmlStateMachine::isActive(const QString &scxmlStateName) const

scxmlStateName で指定された状態がアクティブな場合は `true ` を返し、それ以外の場合は `false ` を返します。

[protected] bool QScxmlStateMachine::isActive(int stateIndex) const

IDがstateIndex の状態がアクティブな場合、true を返します。

このメソッドは、SCXML ステートマシンのコンパイル済み表現に対するインターフェースの一部です。これは内部的に、および SCXML ドキュメントからコンパイルされたステートマシンでのみ使用されるべきです。

[invokable] bool QScxmlStateMachine::isDispatchableTarget(const QString &target) const

このステートマシンによって、target 宛てのメッセージを配信できる場合、true を返します。

有効なターゲットは次のとおりです：

• #_parent 現在のステートマシンが<invoke>
• #_internal 現在のステートマシン
• #_scxml_sessionidの場合、sessionid は現在のステートマシンのセッション ID です
• #_servicename、ここでservicename は、このステートマシンによって<invoke> で起動されたサービスの ID または名前です

bool QScxmlStateMachine::isRunning() const

ステートマシンが実行中の場合は `true ` を返し、それ以外の場合は `false ` を返します。

setRunning() およびrunningChanged()も参照してください 。

[signal] void QScxmlStateMachine::log(const QString &label, const QString &msg)

このシグナルは、SCXML内で<log> タグが使用されている場合に発生します。label は、<log> タグのlabel属性の値です。msg は、<log> タグのexpr属性の評価結果の値です。expr属性が存在しない場合は、空文字列が返されます。

[static] template <typename Functor> std::function<void (bool)> QScxmlStateMachine::onEntry(Functor functor)

ブール値の引数を受け取り、その引数がtrue の場合に、指定されたfunctor を呼び出すファンクタを返します。指定されたfunctor は、いかなる引数も受け入れてはなりません。

これは、状態に入ったときにのみ実行されるべきconnectToState()のハンドラをラップするのに役立ちます。

[static] std::function<void (bool)> QScxmlStateMachine::onEntry(const QObject *receiver, const char *method)

ブール値の引数を受け取り、その引数がtrue であり、かつreceiver がまだ削除されていない場合、QMetaObject::invokeMethod() を使用してreceiver 上の指定されたmethod を呼び出すファンクタを返します。

指定されたmethod は、いかなる引数も受け付けてはなりません。method は、SIGNAL() やSLOT() で囲まれていない、単純なメソッド名です。

これは、状態に入ったときにのみ実行されるべきconnectToState()のハンドラをラップするのに役立ちます。

[static] template <typename PointerToMemberFunction> std::function<void (bool)> QScxmlStateMachine::onEntry(const typename QtPrivate::FunctionPointer<PointerToMemberFunction>::Object *receiver, PointerToMemberFunction method)

ブール値の引数を受け取り、その引数がtrue であり、かつreceiver がまだ削除されていない場合に、receiver に対して指定されたmethod を呼び出すファンクタを返します。指定されたmethod は、いかなる引数も受け入れてはなりません。

これは、状態に入ったときにのみ実行されるべきconnectToState()のハンドラをラップするのに役立ちます。

[static] template <typename Functor> std::function<void (bool)> QScxmlStateMachine::onExit(Functor functor)

ブール値の引数を受け取り、その引数がfalse の場合に指定されたfunctor を呼び出すファンクタを返します。指定されたfunctor は、いかなる引数も受け入れてはなりません。

これは、状態を離れるときにのみ実行されるべきconnectToState()のハンドラをラップするのに役立ちます。

[static] std::function<void (bool)> QScxmlStateMachine::onExit(const QObject *receiver, const char *method)

ブール値の引数を受け取り、その引数がfalse であり、かつreceiver がまだ削除されていない場合、QMetaObject::invokeMethod() を使用してreceiver 上の指定されたmethod を呼び出すファンクタを返します。

指定されたmethod は、いかなる引数も受け入れてはなりません。method は、SIGNAL(...)やSLOT(...)で囲まれていない、単純なメソッド名です。

これは、状態を離れるときにのみ実行されるべきconnectToState() のハンドラをラップするのに役立ちます。

[static] template <typename PointerToMemberFunction> std::function<void (bool)> QScxmlStateMachine::onExit(const typename QtPrivate::FunctionPointer<PointerToMemberFunction>::Object *receiver, PointerToMemberFunction method)

ブール型の引数を受け取り、その引数がfalse の場合に、かつreceiver がまだ削除されていない場合に、receiver に対して指定されたmethod を呼び出すファンクタを返します。指定されたmethod は、いかなる引数も受け入れてはなりません。

これは、状態から離れるときにのみ実行されるべきconnectToState()のハンドラをラップするのに役立ちます。

[signal] void QScxmlStateMachine::reachedStableState()

このシグナルは、マクロステップの終了時にイベントキューが空になった場合、または最終状態に到達した場合に発信されます。

[signal] void QScxmlStateMachine::runningChanged(bool running)

このシグナルは、running プロパティが、引数として `running ` を指定して変更されたときに発生します。

void QScxmlStateMachine::setDataModel(QScxmlDataModel *model)

このステートマシンのデータモデルを「model 」に設定します。ステートマシンとモデルは1対1の関係にあります。モデルを一度設定すると、それ以降は変更できません。このメソッドを使用してモデルを設定しようとしても、それ以降は無視されます。

関連項目： dataModel()。

void QScxmlStateMachine::setRunning(bool running)

running がtrue の場合、ステートマシンを開始し、それ以外の場合は停止します。

関連項目： start()、stop()、isRunning()、およびrunningChanged()も参照してください 。

[slot] void QScxmlStateMachine::start()

このステートマシンを起動します。最終的なトップレベルの状態に入ると、このマシンは `finished()` シグナルを発信します。

関連項目: runningChanged()、setRunning()、stop()、およびfinished()。

[invokable] QStringList QScxmlStateMachine::stateNames(bool compress = true) const

すべての州の州名のリストを取得します。

compress がtrue （デフォルト）の場合、子状態を含む状態は除外され、リーフ状態のみが返されます。false の場合、すべての状態の完全なリストが返されます。

返されるリストには、ネストされたステートマシンに含まれるステートは含まれません。

[slot] void QScxmlStateMachine::stop()

このステートマシンを停止します。マシンはこれ以降、いかなる状態遷移も実行しなくなります。そのrunning プロパティはfalse に設定されます。

runningChanged()、start()、およびsetRunning()も参照してください 。

[invokable] void QScxmlStateMachine::submitEvent(QScxmlEvent *event)

SCXMLイベント「event 」を、そのイベントの優先度に応じて、内部または外部のイベントキューに送信します。

遅延が設定されている場合、タイムアウトが経過した後にイベントが配信キューに入れられます。ステートマシンは `event ` の所有権を取得し、処理後にこれを削除します。

[invokable] void QScxmlStateMachine::submitEvent(const QString &eventName)

指定されたeventName を名前として、外部イベントを作成・送信するためのユーティリティメソッドです。

[invokable] void QScxmlStateMachine::submitEvent(const QString &eventName, const QVariant &data)

指定されたeventName を名前、data をペイロードデータとして、外部イベントを作成・送信するためのユーティリティメソッドです。