QScxmlStateMachine Class

メンバ関数ドキュメント

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

レシーバのfunctor はパラメータとしてQScxmlEvent を取らなければならない。

SCXML ドキュメントのイベント指定とは対照的に、scxmlEventSpec では空白は許されない。異なる接頭辞を持つ複数のイベントに接続するためには、connectToEvent() を複数回呼び出す必要があります。

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

scxmlStateName で指定された状態からfunctor への、与えられたtype の接続を作成する。 は、ファンクタまたはオプションのcontext オブジェクトのメンバ関数であることができる。

レシーバのfunctor は、接続された状態がアクティブになったか非アクティブになったかを示す boolean 引数を取らなければならない。

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

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

すべてのアクティブな状態の状態名のリストを取得する。

ある状態がアクティブであるとき、定義上、その親状態はすべてアクティブである。compress がtrue (デフォルト) の場合、親状態はフィルタリングされ、リーフ状態のみが返されます。これがfalse の場合、アクティブな状態の完全なリストが返される。

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

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

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

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

void mySlot(const QScxmlEvent &event);

SCXML ドキュメントのイベント指定とは対照的に、scxmlEventSpec ではスペースは使用できません。異なる接頭辞を持つ複数のイベントに接続するには、 connectToEvent() を複数回呼び出す必要があります。

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

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

scxmlStateName で特定される状態からreceiver オブジェクトのmethod への、与えられたtype の接続を作成する。レシーバの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

IDstateIndex を持つ状態がアクティブであればtrue を返す。

このメソッドは SCXML ステートマシンのコンパイルされた表現のインターフェイスの一部です。SCXML ドキュメントからコンパイルされたステートマシンの内部でのみ使用する必要があります。

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

このステートマシンがtarget へのメッセージをディスパッチできる場合、true を返す。

有効なターゲットは以下の通り：

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

bool QScxmlStateMachine::isRunning() const

ステートマシンが実行中であればtrue を、そうでなければfalse を返す。

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

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

<log> label は タグの<log> label属性の値です。 は タグのmsg <log> expr属性の値です。expr属性がない場合は、NULL文字列が返されます。

[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 がまだ削除されていない場合、与えられたmethod をreceiver で呼び出すファンクタを返す。与えられた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)

ブール値の引数を受け入れ、与えられたmethod をQMetaObject::invokeMethod() を使ってreceiver に呼び出すファンクタを返す。その引数がfalse で、receiver がまだ削除されていない場合。

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 がまだ削除されていない場合、与えられたmethod をreceiver で呼び出すファンクタを返す。与えられた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 をペイロードデータとする外部イ ベントを作成し、送信するためのユーティリティメソッド。