jp.go.aist.rtm.RTC

Class FsmProfileListener

java.lang.Object

jp.go.aist.rtm.RTC.FsmProfileListener

All Implemented Interfaces:

java.util.Observer

public abstract class FsmProfileListener
extends java.lang.Object
implements java.util.Observer

FsmProfileListener class

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

 Class MyListeneri extends public FsmProfileListener {
   public String m_name;
   public MyListener(final String name){
       m_namei = name;
   }

   public void operator()(final FsmProfile fsmprof) {
     System.out.println("Listner name:  " + m_name);
   };
 };
 

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

 protected ReturnCode_t onInitialize() {
     addFsmProfileListener(SET_FSM_PROFILE,
                           new MyListener("prof listener"));
    :
 };
 

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

• - SET_FSM_PROFILE : Setting FSM Profile
• - GET_FSM_PROFILE : Getting FSM Profile
• - ADD_FSM_STATE : A State added to the FSM
• - REMOVE_FSM_STATE : A State removed from FSM
• - ADD_FSM_TRANSITION : A transition added to the FSM
• - REMOVE_FSM_TRANSITION : A transition removed from FSM
• - BIND_FSM_EVENT : An event bounded to the FSM
• - UNBIND_FSM_EVENT : An event unbounded to the FSM

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 addFsmProfileListener()/removeFsmProfileListener() functions

Constructor Summary

Constructors

Constructor and Description
FsmProfileListener()

Method Summary

Modifier and Type	Method and Description
abstract void	operator(FsmProfile fsmprof) Virtual Callback function
void	update(java.util.Observable o, java.lang.Object obj)

Methods inherited from class java.lang.Object

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

Constructor Detail

FsmProfileListener

public FsmProfileListener()

Method Detail

update

public void update(java.util.Observable o,
                   java.lang.Object obj)

Specified by:

update in interface java.util.Observer

operator

public abstract void operator(FsmProfile fsmprof)

Virtual Callback function

This is a the Callback function for FsmProfileListener.