OpenRTM-aist-Python 1.1.2
Classes | Public Member Functions | List of all members
OpenRTM_aist.PeriodicTask.PeriodicTask Class Reference
Inheritance diagram for OpenRTM_aist.PeriodicTask.PeriodicTask:
OpenRTM_aist.Task.Task OpenRTM_aist.PeriodicTaskFactory.PeriodicTaskFactory

Classes

class  alive_t
 
class  statistics_t
 
class  suspend_t
 

Public Member Functions

def __init__
 ctor
 
def __del__
 dtor
 
def activate
 Starting the task. More...
 
def finalize
 Finalizing the task. More...
 
def suspend
 Suspending the task. More...
 
def resume
 Resuming the suspended task. More...
 
def signal
 Executing the suspended task one tick. More...
 
def setTask
 Setting task execution function. More...
 
def setPeriod
 Setting task execution period. More...
 
def executionMeasure
 virtual void executionMeasure(bool value);
 
def executionMeasureCount
 virtual void executionMeasureCount(int n);
 
def periodicMeasure
 virtual void periodicMeasure(bool value);
 
def periodicMeasureCount
 virtual void periodicMeasureCount(int n);
 
def getExecStat
 virtual TimeMeasure::Statistics getExecStat();
 
def getPeriodStat
 virtual TimeMeasure::Statistics getPeriodStat();
 
def svc
 virtual int svc();
 
def sleep
 virtual void sleep();
 
def updateExecStat
 virtual void updateExecStat();
 
def updatePeriodStat
 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)

Finalizing the task.

Finalizing the task running.

virtual void finalize();

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
periodExecution 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
funcSet int (*)() type function pointer

virtual bool setTask(TaskFuncBase* func, bool delete_in_dtor = true);

def OpenRTM_aist.PeriodicTask.PeriodicTask.signal (   self)

Executing the suspended task one tick.

Executing the suspended task one tick

virtual void signal();

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: