OpenRTM_aist.PeriodicTask.PeriodicTask クラス

OpenRTM_aist.PeriodicTask.PeriodicTask の継承関係図

クラス
class	alive_t
class	statistics_t
class	suspend_t

公開メンバ関数
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)

詳解

構築子と解体子

__init__()

def OpenRTM_aist.PeriodicTask.PeriodicTask.__init__

(

self

)

ctor

OpenRTM_aist.Task.Taskを再実装しています。

__del__()

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

dtor

OpenRTM_aist.Task.Taskを再実装しています。

OpenRTM_aist.PeriodicTaskFactory.PeriodicTaskFactoryで再実装されています。

メソッド詳解

activate()

def OpenRTM_aist.PeriodicTask.PeriodicTask.activate

(

self

)

タスク実行を開始する

タスクの実行を開始するためにスレッドをスタートさせる。 タスクが 正常に開始された場合は true が返り、すでにタスクが開始済み、また は実行するタスクが設定されていなければ false を返す。

戻り値

true: 正常開始、false: スレッド済みかタスクが未設定である。

virtual void activate();

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

)

タスク実行を終了する

実行中のタスクを終了する。

virtual void finalize();

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

)

中断されているタスクを再開する

中断されているタスクを再開する

virtual int resume(void);

OpenRTM_aist.Task.Taskを再実装しています。

setPeriod()

def OpenRTM_aist.PeriodicTask.PeriodicTask.setPeriod	(		self,
			period
	)

タスク実行周期をセットする

引数

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
	)

タスク実行関数をセットする

引数

func	int (*)() 型の関数ポインタ

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

signal()

def OpenRTM_aist.PeriodicTask.PeriodicTask.signal

(

self

)

中断されているタスクを1周期だけ実行する

中断されているタスクを1周期だけ実行する

virtual void signal();

suspend()

def OpenRTM_aist.PeriodicTask.PeriodicTask.suspend

(

self

)

タスク実行を中断する

実行中のタスクを中断する。

virtual int suspend(void);

OpenRTM_aist.Task.Taskを再実装しています。

---

このクラス詳解は次のファイルから抽出されました:

• C:/docs/OpenRTM-aist-Python/OpenRTM_aist/PeriodicTask.py