OpenRTM-aist-Python 1.2.1
|
Classes | |
class | Task |
Public Member Functions | |
def | __init__ (self, interval) |
Constructor. More... | |
def | __del__ (self) |
Destructor. More... | |
def | run (self) |
Thread execution function for Timer. More... | |
def | stop (self) |
Stop Timer task. More... | |
def | invoke (self) |
Invoke Timer task. More... | |
def | registerListener (self, listener, tm) |
Register listener. More... | |
def | registerListenerObj (self, obj, cbf, tm) |
Register listener. More... | |
def | registerListenerFunc (self, cbf, tm) |
Register listener. More... | |
def | unregisterListener (self, id) |
Unregister listener. More... | |
Timer class.
Invoke the callback function of registered listener periodically at the set cycle.
def OpenRTM_aist.Timer.Timer.__init__ | ( | self, | |
interval | |||
) |
Constructor.
Constructor
interval | The interval of timer |
def OpenRTM_aist.Timer.Timer.__del__ | ( | self | ) |
Destructor.
Destructor
def OpenRTM_aist.Timer.Timer.invoke | ( | self | ) |
Invoke Timer task.
Subtract the interval of timer from the waiting time for invocation of each registered listener. If the listener whose waiting time reached 0 exists, invoke the callback function.
def OpenRTM_aist.Timer.Timer.registerListener | ( | self, | |
listener, | |||
tm | |||
) |
Register listener.
Register the listener of callback function invoked from this Timer by specifying the interval. If the same listener has already been regiseterd, the value specified the invocation interval of listener will be updated.
listener | Listener for the registration |
tm | The invocation interval of listener |
ListenerId registerListener(ListenerBase* listener, TimeValue tm);
def OpenRTM_aist.Timer.Timer.registerListenerFunc | ( | self, | |
cbf, | |||
tm | |||
) |
Register listener.
Register listener by specifying the method for callback and the invocation interval.
cbf | Target method for callback |
tm | The invocation interval of listener |
ListenerId registerListenerFunc(void (*cbf)(), TimeValue tm)
def OpenRTM_aist.Timer.Timer.registerListenerObj | ( | self, | |
obj, | |||
cbf, | |||
tm | |||
) |
Register listener.
Register listener by specifying the object for callback, the method for callback and the invocation interval.
obj | Target object for callback |
cbf | Target method for callback |
tm | The invocation interval of listener |
template <class listenerclass>=""> ListenerId registerListenerObj(ListenerClass* obj, void (ListenerClass::*cbf)(), TimeValue tm)
def OpenRTM_aist.Timer.Timer.run | ( | self | ) |
def OpenRTM_aist.Timer.Timer.unregisterListener | ( | self, | |
id | |||
) |
Unregister listener.
Unregister the listener specified by ID. If the listener specified by ID is not registerd, false will be returned.
id | ID of the unregisterd listener |
bool unregisterListener(ListenerId id);