Classes | |
| class | alive_t |
| class | statistics_t |
| class | suspend_t |
Public Member Functions | |
| def | __init__ (self) |
| def | __del__ (self, Task=OpenRTM_aist.Task) |
| def | activate (self) |
| def | finalize (self) |
| def | suspend (self) |
| def | resume (self) |
| def | signal (self) |
| def | setTask (self, func, delete_in_dtor=True) |
| def | setPeriod (self, period) |
| def | executionMeasure (self, value) |
| def | executionMeasureCount (self, n) |
| def | periodicMeasure (self, value) |
| def | periodicMeasureCount (self, n) |
| def | getExecStat (self) |
| def | getPeriodStat (self) |
Detailed Description
Constructor & Destructor Documentation
◆ __init__()
| def OpenRTM_aist.PeriodicTask.PeriodicTask.__init__ | ( | self | ) |
ctor
Reimplemented from OpenRTM_aist.Task.Task.
◆ __del__()
| def OpenRTM_aist.PeriodicTask.PeriodicTask.__del__ | ( | self, | |
Task = OpenRTM_aist.Task |
|||
| ) |
dtor
Reimplemented from OpenRTM_aist.Task.Task.
Reimplemented in OpenRTM_aist.PeriodicTaskFactory.PeriodicTaskFactory.
Member Function Documentation
◆ activate()
| 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();
Reimplemented from OpenRTM_aist.Task.Task.
◆ executionMeasure()
| def OpenRTM_aist.PeriodicTask.PeriodicTask.executionMeasure | ( | self, | |
| value | |||
| ) |
virtual void executionMeasure(bool value);
◆ executionMeasureCount()
| def OpenRTM_aist.PeriodicTask.PeriodicTask.executionMeasureCount | ( | self, | |
| n | |||
| ) |
virtual void executionMeasureCount(int n);
◆ finalize()
| def OpenRTM_aist.PeriodicTask.PeriodicTask.finalize | ( | self | ) |
Finalizing the task
Finalizing the task running.
virtual void finalize();
Reimplemented from OpenRTM_aist.Task.Task.
◆ getExecStat()
| def OpenRTM_aist.PeriodicTask.PeriodicTask.getExecStat | ( | self | ) |
virtual TimeMeasure::Statistics getExecStat();
◆ getPeriodStat()
| def OpenRTM_aist.PeriodicTask.PeriodicTask.getPeriodStat | ( | self | ) |
virtual TimeMeasure::Statistics getPeriodStat();
◆ periodicMeasure()
| def OpenRTM_aist.PeriodicTask.PeriodicTask.periodicMeasure | ( | self, | |
| value | |||
| ) |
virtual void periodicMeasure(bool value);
◆ periodicMeasureCount()
| def OpenRTM_aist.PeriodicTask.PeriodicTask.periodicMeasureCount | ( | self, | |
| n | |||
| ) |
virtual void periodicMeasureCount(int n);
◆ resume()
| def OpenRTM_aist.PeriodicTask.PeriodicTask.resume | ( | self | ) |
Resuming the suspended task
Resuming the suspended task
virtual int resume(void);
Reimplemented from OpenRTM_aist.Task.Task.
◆ setPeriod()
| 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);
◆ setTask()
| 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);
◆ signal()
| def OpenRTM_aist.PeriodicTask.PeriodicTask.signal | ( | self | ) |
◆ suspend()
| def OpenRTM_aist.PeriodicTask.PeriodicTask.suspend | ( | self | ) |
Suspending the task
Suspending the task running.
virtual int suspend(void);
Reimplemented from OpenRTM_aist.Task.Task.
The documentation for this class was generated from the following file:
- C:/docs/OpenRTM-aist-Python/OpenRTM_aist/PeriodicTask.py
