Inheritance diagram for OpenRTM_aist.PeriodicTask.PeriodicTask:
Classes | |
| class | alive_t |
| class | statistics_t |
| class | suspend_t |
Public Member Functions | |
| def | __init__ (self) |
| ctor | |
| def | __del__ (self, Task=OpenRTM_aist.Task) |
| dtor | |
| def | activate (self) |
| Starting the task. More... | |
| def | finalize (self) |
| Finalizing the task. More... | |
| def | suspend (self) |
| Suspending the task. More... | |
| def | resume (self) |
| Resuming the suspended task. More... | |
| def | signal (self) |
| Executing the suspended task one tick. More... | |
| def | setTask (self, func, delete_in_dtor=True) |
| Setting task execution function. More... | |
| def | setPeriod (self, period) |
| Setting task execution period. More... | |
| def | executionMeasure (self, value) |
| virtual void executionMeasure(bool value); | |
| def | executionMeasureCount (self, n) |
| virtual void executionMeasureCount(int n); | |
| def | periodicMeasure (self, value) |
| virtual void periodicMeasure(bool value); | |
| def | periodicMeasureCount (self, n) |
| virtual void periodicMeasureCount(int n); | |
| def | getExecStat (self) |
| virtual TimeMeasure::Statistics getExecStat(); | |
| def | getPeriodStat (self) |
| virtual TimeMeasure::Statistics getPeriodStat(); | |
| def | svc (self) |
| virtual int svc(); | |
| def | sleep (self) |
| virtual void sleep(); | |
| def | updateExecStat (self) |
| virtual void updateExecStat(); | |
| def | updatePeriodStat (self) |
| virtual void updatePeriodStat(); | |
Detailed Description
Member Function Documentation
| def OpenRTM_aist.PeriodicTask.PeriodicTask.activate | ( | self | ) |
Starting the task.
Starting a thread to execute a task. If the task/thread is started properly, it will return 'TRUE'. if the task/thread are already started or task function object is not set, 'FALSE' will be returned.
- Returns
- true: normal start, false: already started or task is not set
virtual void activate();
| def OpenRTM_aist.PeriodicTask.PeriodicTask.finalize | ( | self | ) |
| def OpenRTM_aist.PeriodicTask.PeriodicTask.resume | ( | self | ) |
Resuming the suspended task.
Resuming the suspended task
virtual int resume(void);
| def OpenRTM_aist.PeriodicTask.PeriodicTask.setPeriod | ( | self, | |
| period | |||
| ) |
Setting task execution period.
- Parameters
-
period Execution period [sec]
virtual void setPeriod(double period); virtual void setPeriod(TimeValue& period);
| def OpenRTM_aist.PeriodicTask.PeriodicTask.setTask | ( | self, | |
| func, | |||
delete_in_dtor = True |
|||
| ) |
Setting task execution function.
- Parameters
-
func Set int (*)() type function pointer
virtual bool setTask(TaskFuncBase* func, bool delete_in_dtor = true);
| def OpenRTM_aist.PeriodicTask.PeriodicTask.signal | ( | self | ) |
| def OpenRTM_aist.PeriodicTask.PeriodicTask.suspend | ( | self | ) |
Suspending the task.
Suspending the task running.
virtual int suspend(void);
The documentation for this class was generated from the following file:
- /tmp/workspace/03_openrtm-python-build-tags/OpenRTM_aist/PeriodicTask.py
