FsmStructureListener クラス [詳解]

#include <FsmActionListener.h>

公開メンバ関数
virtual	~FsmStructureListener ()
	デストラクタ

virtual void	operator() (::RTC::FsmStructure &pprof)=0
	仮想コールバック関数

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

詳解

FsmStructureListener クラス

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

class MyListener
  : public FsmStructureListener
{
  std::string m_name;
public:
  MyListener(const char* name) : m_name(name) {}
  virtual ~MyListener() {}
  virtual void operator()(::RTC::FsmStructure& pprof)
  {
    std::cout << "Listner name:  " m_name << std::endl;
  };
};

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

RTC::ReturnCode_t ConsoleIn::onInitialize()
{
    addFsmStructureListener(FsmStructureListenerType::SET_FSM_STRUCTURE,
                            new MyListener("set structure listener"),
                            true);
   :

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

SET_FSM_STRUCTURE: FSM構造の設定
GET_FSM_STRUCTURE: FSM構造の取得

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

構築子と解体子

◆ ~FsmStructureListener()

virtual RTC::FsmStructureListener::~FsmStructureListener ( )

virtual

デストラクタ

関数詳解

◆ operator()()

virtual void RTC::FsmStructureListener::operator() ( ::RTC::FsmStructure & pprof )

pure virtual

仮想コールバック関数

FsmStructureListener のコールバック関数

◆ toString()

static const char * RTC::FsmStructureListener::toString ( FsmStructureListenerType type )

inlinestatic

FsmStructureListenerType を文字列に変換

FsmStructureListenerType を文字列に変換する

引数

type	変換対象 FsmStructureListenerType

戻り値: 文字列変換結果

参照先 RTC::FSM_STRUCTURE_LISTENER_NUM.

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

FsmActionListener.h

公開メンバ関数

静的公開メンバ関数

詳解

構築子と解体子

◆ ~FsmStructureListener()

関数詳解

◆ operator()()

◆ toString()