FsmStructureListener class. More...

#include <FsmActionListener.h>

Public Member Functions
virtual	~FsmStructureListener ()
	Destructor .

virtual void	operator() (::RTC::FsmStructure &pprof)=0
	Virtual Callback function.

Static Public Member Functions
static const char *	toString (FsmStructureListenerType type)
	Convert FsmStructureListenerType into the string.

Detailed Description

FsmStructureListener class.

FsmStructureListener class is a base class for the listener objects which realize callback to hook FSM structure profile related actions. To hook execution just before a FSM action, the callback object should be defined as follows, and set to RTObject through appropriate callback set function.

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;
  };
};

The listener class defined above is set to RTObject as follows.

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

The first argument "SET_FSM_STRUCTURE" specifies callback hook point, and the following values are available. Not all the callback points are implemented. It depends on the FSM implementations.

SET_FSM_STRUCTURE: Setting FSM structure
GET_FSM_STRUCTURE: Getting FSM structure

The second argument is a pointers to the listener object. The third argument is a flag for automatic object destruction. When "true" is given to the third argument, the given object in second argument is automatically destructed with RTObject. In the "false " case, the ownership of the object is left in the caller side, and then destruction of the object must be done by users' responsibility.

It is good for setting "true" as third argument, if the listener object life span is equals to the RTObject's life cycle. On the otehr hand, if callbacks are required to set/unset depending on its situation, the third argument could be "false". In that case, listener objects pointers must be stored to member variables, and set/unset of the listener objects shoud be paerformed throguh RTObject_impl::addFsmStructureListener()/removeFsmStructureListener() functions.

Constructor & Destructor Documentation

◆ ~FsmStructureListener()

virtual RTC::FsmStructureListener::~FsmStructureListener ( )

virtual

Destructor .

Member Function Documentation

◆ operator()()

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

pure virtual

Virtual Callback function.

This is a the Callback function for FsmStructureListener

◆ toString()

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

inlinestatic

Convert FsmStructureListenerType into the string.

Parameters

type	The target FsmStructureListenerType for transformation

Returns: Trnasformation result of string representation

References RTC::FSM_STRUCTURE_LISTENER_NUM.

The documentation for this class was generated from the following file:

FsmActionListener.h