RTC::PreFsmActionListener クラス

PreFsmActionListener クラス [詳解]

#include <FsmActionListener.h>

公開メンバ関数
virtual	~PreFsmActionListener ()
	デストラクタ
virtual void	operator() (const char *)=0
	仮想コールバック関数

静的公開メンバ関数
static const char *	toString (PreFsmActionListenerType type)
	PreFsmActionListenerType を文字列に変換

詳解

PreFsmActionListener クラス

PreFsmActionListener クラスは、Fsmのアクションに関するコールバック を実現するリスナーオブジェクトの基底クラスである。FSMのアクション の直前の動作をフックしたい場合、以下の例のように、このクラスを継承 したコールバックオブジェクトを定義し、適切なコールバック設定関数か らRTObjectに対してコールバックオブジェクトをセットする必要がある。

class MyListener
  : public PreFsmActionListener
{
  std::string m_name;
public:
  MyListener(const char* name) : m_name(name) {}
  virtual ~MyListener() {}

  virtual void operator()(const char* state_name)
  {
    std::cout << "Listner name:  " m_name << std::endl;
    std::cout << "Current state: " state_name << std::endl;
  };
};

このようにして定義されたリスナクラスは、以下のようにRTObjectに対し て、セットされる。

RTC::ReturnCode_t ConsoleIn::onInitialize()
{
    addPreFsmActionListener(PreFsmActionListenerType::PRE_ON_STATE_CHANGE,
                            new MyListener("init listener"),
                            true);
   :

第1引数の "PRE_ON_STATE_CHANGE" は、コールバックをフックするポイン トであり、以下の値を取ることが可能である。なお、すべてのコールバッ クポイントが実装されているとは限らず、これらが呼び出されるかどうか は、FSMの実装に依存する。

• PRE_ON_INIT: init 直前
• PRE_ON_ENTRY: entry 直前
• PRE_ON_DO: do 直前
• PRE_ON_EXIT: exit 直前
• PRE_ON_STATE_CHANGE: 状態遷移直前

第2引数はリスナオブジェクトのポインタである。第3引数はオブジェクト 自動削除フラグであり、true の場合は、RTObject削除時に自動的にリス ナオブジェクトが削除される。falseの場合は、オブジェクトの所有権は 呼び出し側に残り、削除は呼び出し側の責任で行わなければならない。 RTObject のライフサイクル中にコールバックが必要ならば上記のような 呼び出し方で第3引数を true としておくとよい。逆に、コールバックを 状況等に応じてセットしたりアンセットしたりする必要がある場合は falseとして置き、リスナオブジェクトのポインタをメンバ変数などに保 持しておき、 RTObject_impl::addPreFsmActionListener()/removePreFsmActionListener() により、セットとアンセットを管理するといった使い方も可能である。

構築子と解体子

~PreFsmActionListener()

virtual RTC::PreFsmActionListener::~PreFsmActionListener ( )

virtual

デストラクタ

関数詳解

operator()()

virtual void RTC::PreFsmActionListener::operator() ( const char * )

pure virtual

仮想コールバック関数

PreFsmActionListener のコールバック関数

toString()

static const char * RTC::PreFsmActionListener::toString ( PreFsmActionListenerType type )

inlinestatic

PreFsmActionListenerType を文字列に変換

PreFsmActionListenerType を文字列に変換する

引数

type	変換対象 PreFsmActionListenerType

戻り値

文字列変換結果

参照先 RTC::PRE_FSM_ACTION_LISTENER_NUM.

---

このクラス詳解は次のファイルから抽出されました:

• FsmActionListener.h