OpenRTM_aist.PeriodicTask.PeriodicTask Class Reference

Inheritance diagram for OpenRTM_aist.PeriodicTask.PeriodicTask:

List of all members.

Classes
class	alive_t
class	statistics_t
class	suspend_t
Public Member Functions
def	__del__
	dtor
def	__init__
	ctor
def	activate
	Starting the task.
def	executionMeasure
	virtual void executionMeasure(bool value);
def	executionMeasureCount
	virtual void executionMeasureCount(int n);
def	finalize
	Finalizing the task.
def	getExecStat
	virtual TimeMeasure::Statistics getExecStat();
def	getPeriodStat
	virtual TimeMeasure::Statistics getPeriodStat();
def	periodicMeasure
	virtual void periodicMeasure(bool value);
def	periodicMeasureCount
	virtual void periodicMeasureCount(int n);
def	resume
	Resuming the suspended task.
def	setPeriod
	Setting task execution period.
def	setTask
	Setting task execution function.
def	signal
	Executing the suspended task one tick.
def	sleep
	virtual void sleep();
def	suspend
	Suspending the task.
def	svc
	virtual int svc();
def	updateExecStat
	virtual void updateExecStat();
def	updatePeriodStat
	virtual void updatePeriodStat();
Private Attributes
	_alive
	_deleteInDtor
	_execCount
	_execCountMax
	_execMeasure
	_execStat
	_execTime
	_func
	_nowait
	_period
	_periodCount
	_periodCountMax
	_periodMeasure
	_periodStat
	_periodTime
	_suspend

---

Detailed Description

Definition at line 46 of file PeriodicTask.py.

---

Constructor & Destructor Documentation

def OpenRTM_aist.PeriodicTask.PeriodicTask.__init__

(

self

)

ctor

Reimplemented from OpenRTM_aist.Task.Task.

Reimplemented in OpenRTM_aist.PeriodicTaskFactory.PeriodicTaskFactory.

Definition at line 57 of file PeriodicTask.py.

def OpenRTM_aist.PeriodicTask.PeriodicTask.__del__	(		self,
			Task = OpenRTM_aist.Task
	)

dtor

Definition at line 90 of file PeriodicTask.py.

---

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

Reimplemented from OpenRTM_aist.Task.Task.

Definition at line 120 of file PeriodicTask.py.

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

virtual void executionMeasure(bool value);

Definition at line 284 of file PeriodicTask.py.

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

virtual void executionMeasureCount(int n);

Definition at line 297 of file PeriodicTask.py.

def OpenRTM_aist.PeriodicTask.PeriodicTask.finalize

(

self

)

Finalizing the task.

Finalizing the task running.

virtual void finalize();

Reimplemented from OpenRTM_aist.Task.Task.

Definition at line 147 of file PeriodicTask.py.

def OpenRTM_aist.PeriodicTask.PeriodicTask.getExecStat

(

self

)

virtual TimeMeasure::Statistics getExecStat();

Definition at line 335 of file PeriodicTask.py.

def OpenRTM_aist.PeriodicTask.PeriodicTask.getPeriodStat

(

self

)

virtual TimeMeasure::Statistics getPeriodStat();

Definition at line 348 of file PeriodicTask.py.

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

virtual void periodicMeasure(bool value);

Definition at line 310 of file PeriodicTask.py.

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

virtual void periodicMeasureCount(int n);

Definition at line 322 of file PeriodicTask.py.

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.

Definition at line 193 of file PeriodicTask.py.

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

Definition at line 262 of file PeriodicTask.py.

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

Definition at line 238 of file PeriodicTask.py.

def OpenRTM_aist.PeriodicTask.PeriodicTask.signal

(

self

)

Executing the suspended task one tick.

Executing the suspended task one tick

virtual void signal();

Definition at line 217 of file PeriodicTask.py.

def OpenRTM_aist.PeriodicTask.PeriodicTask.sleep

(

self

)

virtual void sleep();

Definition at line 391 of file PeriodicTask.py.

def OpenRTM_aist.PeriodicTask.PeriodicTask.suspend

(

self

)

Suspending the task.

Suspending the task running.

virtual int suspend(void);

Reimplemented from OpenRTM_aist.Task.Task.

Definition at line 172 of file PeriodicTask.py.

def OpenRTM_aist.PeriodicTask.PeriodicTask.svc

(

self

)

virtual int svc();

Reimplemented from OpenRTM_aist.Task.Task.

Definition at line 354 of file PeriodicTask.py.

def OpenRTM_aist.PeriodicTask.PeriodicTask.updateExecStat

(

self

)

virtual void updateExecStat();

Definition at line 405 of file PeriodicTask.py.

def OpenRTM_aist.PeriodicTask.PeriodicTask.updatePeriodStat

(

self

)

virtual void updatePeriodStat();

Definition at line 416 of file PeriodicTask.py.

---

Member Data Documentation

OpenRTM_aist::PeriodicTask.PeriodicTask::_alive [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_deleteInDtor [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_execCount [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_execCountMax [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_execMeasure [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_execStat [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_execTime [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_func [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_nowait [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_period [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_periodCount [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_periodCountMax [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_periodMeasure [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_periodStat [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_periodTime [private]

Definition at line 57 of file PeriodicTask.py.

OpenRTM_aist::PeriodicTask.PeriodicTask::_suspend [private]

Definition at line 57 of file PeriodicTask.py.

---

The documentation for this class was generated from the following file:

• PeriodicTask.py