jp.go.aist.rtm.RTC.jfsm

クラス Machine<T extends StateDef,EP>

java.lang.Object

jp.go.aist.rtm.RTC.jfsm.machine.MachineBase

jp.go.aist.rtm.RTC.jfsm.Machine<T,EP>

型パラメータ:

T - ユーザー定義の最上位状態クラス。

EP - イベントプロトコルとなるインターフェース。

public class Machine<T extends StateDef,EP>
extends MachineBase

状態遷移マシンの実装クラス。アプリケーションに対するAPIを提供する。 アプリケーションはMachineのインスタンスを生成し、実際の状態遷移を実行する。 アプリケーションはMachineのインスタンスに対し、イベントの発生、 現在の状態の取得、データの取得などができる。

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
(package private) class	Machine.MyHandler

フィールドのサマリー

クラスから継承されたフィールド jp.go.aist.rtm.RTC.jfsm.machine.MachineBase

currentState, rtcout, topState

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
Machine(java.lang.Class<T> topState, java.lang.Class<EP> eventProtocolInterface, java.lang.Object data) 状態遷移マシンを初期化する。
Machine(java.lang.Class<T> topState, java.lang.Class<EP> eventProtocolInterface, State state, java.lang.Object data) 最初の状態を指定して状態遷移マシンを初期化する。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
EP	current() イベントを発生させるためのエンドポイントを取得する。
boolean	isCurrent(java.lang.Class<? extends T> stateClass) 現在の状態を調べる。
boolean	isCurrentDirect(java.lang.Class<? extends T> stateClass) 現在の状態を調べる。

クラスから継承されたメソッド jp.go.aist.rtm.RTC.jfsm.machine.MachineBase

addDeferredEvent, clearHistory, clearHistoryDeep, data, dispatch, getInfo, performPending, setInfo, setPendingState, setState, setState, setState, shutdown

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

Machine

public Machine(java.lang.Class<T> topState,
               java.lang.Class<EP> eventProtocolInterface,
               java.lang.Object data)

状態遷移マシンを初期化する。

パラメータ:

topState - ユーザー定義の最上位状態クラス。

eventProtocolInterface - ベントプロトコルとなるインターフェース。

data - 最上位状態クラスが初期状態で持つデータ。ない場合はnullを指定する。

Machine

public Machine(java.lang.Class<T> topState,
               java.lang.Class<EP> eventProtocolInterface,
               State state,
               java.lang.Object data)

最初の状態を指定して状態遷移マシンを初期化する。

パラメータ:

topState - ユーザー定義の最上位状態クラス。

eventProtocolInterface - ベントプロトコルとなるインターフェース。

state - 開始時の状態。

data - 最上位状態クラスが初期状態で持つデータ。ない場合はnullを指定する。

メソッドの詳細

isCurrent

public boolean isCurrent(java.lang.Class<? extends T> stateClass)

現在の状態を調べる。

パラメータ:

stateClass - ここで指定した状態かどうかを調べる。

戻り値:

true - 現在stateClassかそのサブ状態。 false - それ以外。

isCurrentDirect

public boolean isCurrentDirect(java.lang.Class<? extends T> stateClass)

現在の状態を調べる。

パラメータ:

stateClass - ここで指定した状態かどうかを調べる。

戻り値:

true - 現在stateClassの状態(サブ状態は含まない)。 false - それ以外

current

public EP current()

イベントを発生させるためのエンドポイントを取得する。 イベントハンドラをメソッド呼び出しの形で以下のように記述できる。 machine.current().eventHandler(param) エンドポイントは java.lang.reflect.Proxy のインスタンスとなっている。

戻り値:

イベントハンドラの呼び出しエンドポイント。