OpenRTM_aist.PeriodicTask.PeriodicTask Class Reference

More...

Inheritance diagram for OpenRTM_aist.PeriodicTask.PeriodicTask:

Classes
class	alive_t
class	statistics_t
class	suspend_t

Public Member Functions
	__init__ (self)
	__del__ (self, Task=OpenRTM_aist.Task)
	activate (self)
	finalize (self)
	suspend (self)
	resume (self)
	signal (self)
	setTask (self, func, delete_in_dtor=True)
	setPeriod (self, period)
	executionMeasure (self, value)
	executionMeasureCount (self, n)
	periodicMeasure (self, value)
	periodicMeasureCount (self, n)
	getExecStat (self)
	getPeriodStat (self)

Detailed Description

Constructor & Destructor Documentation

__init__()

OpenRTM_aist.PeriodicTask.PeriodicTask.__init__

(

self

)

ctor

Reimplemented from OpenRTM_aist.Task.Task.

__del__()

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()

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()

OpenRTM_aist.PeriodicTask.PeriodicTask.executionMeasure	(		self,
			value )

virtual void executionMeasure(bool value);

executionMeasureCount()

OpenRTM_aist.PeriodicTask.PeriodicTask.executionMeasureCount	(		self,
			n )

virtual void executionMeasureCount(int n);

finalize()

OpenRTM_aist.PeriodicTask.PeriodicTask.finalize

(

self

)

Finalizing the task

Finalizing the task running.

virtual void finalize();

Reimplemented from OpenRTM_aist.Task.Task.

getExecStat()

OpenRTM_aist.PeriodicTask.PeriodicTask.getExecStat

(

self

)

virtual TimeMeasure.Statistics getExecStat();

getPeriodStat()

OpenRTM_aist.PeriodicTask.PeriodicTask.getPeriodStat

(

self

)

virtual TimeMeasure.Statistics getPeriodStat();

periodicMeasure()

OpenRTM_aist.PeriodicTask.PeriodicTask.periodicMeasure	(		self,
			value )

virtual void periodicMeasure(bool value);

periodicMeasureCount()

OpenRTM_aist.PeriodicTask.PeriodicTask.periodicMeasureCount	(		self,
			n )

virtual void periodicMeasureCount(int n);

resume()

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()

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()

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()

OpenRTM_aist.PeriodicTask.PeriodicTask.signal

(

self

)

Executing the suspended task one tick

Executing the suspended task one tick

virtual void signal();

suspend()

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:

• PeriodicTask.py