OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext クラス

[詳解]

OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext の継承関係図

クラス
class	WorkerThreadCtrl

公開メンバ関数
def	__init__ (self)
def	exit (self, Task=OpenRTM_aist.Task)
def	init (self, props)
def	svc (self)
def	open (self, *args)
def	close (self, flags)
def	is_running (self)
def	start (self)
def	stop (self)
def	get_rate (self)
def	set_rate (self, rate)
def	activate_component (self, comp)
def	deactivate_component (self, comp)
def	reset_component (self, comp)
def	get_component_state (self, comp)
def	get_kind (self)
def	add_component (self, comp)
def	remove_component (self, comp)
def	get_profile (self)
基底クラス OpenRTM_aist.ExecutionContextBase.ExecutionContextBase に属する継承公開メンバ関数
def	init (self, props)
def	exit (self)
def	bindComponent (self, rtc)
def	isRunning (self)
def	start (self)
def	stop (self)
def	getRate (self)
def	setRate (self, rate)
def	addComponent (self, comp)
def	removeComponent (self, comp)
def	activateComponent (self, comp)
def	deactivateComponent (self, comp)
def	resetComponent (self, comp)
def	getComponentState (self, comp)
def	getKind (self)
def	getProfile (self)
def	setObjRef (self, ec_ptr)
def	getObjRef (self)
def	getKindString (self, kind)
def	setKind (self, kind)
def	setOwner (self, comp)
def	getOwner (self)
def	getComponentList (self)
def	setProperties (self, props)
def	getProperties (self)
def	isAllCurrentState (self, state)
def	setExecutionRate (self, props)
def	setTransitionMode (self, props, key, flag=False)
def	setTimeout (self, props, key, timevalue=0.0)

詳解

PeriodicExecutionContext クラス

Periodic Sampled Data Processing(周期実行用)ExecutionContextクラス。

から

0.4.0

構築子と解体子

__init__()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.__init__

(

self

)

コンストラクタ

コンストラクタ 設定された値をプロファイルに設定する。

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

OpenRTM_aist.EventDrivenExecutionContext.EventDrivenExecutionContext, OpenRTM_aist.MultilayerCompositeEC.MultilayerCompositeECで再実装されています。

メソッド詳解

activate_component()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.activate_component	(		self,
			comp
	)

RTコンポーネントをアクティブ化する

Inactive 状態にあるRTコンポーネントをActive に遷移させ、アクティブ化する。 この操作が呼ばれた結果、 on_activate が呼び出される。 指定したRTコンポーネントが参加者リストに含まれない場合は、 BAD_PARAMETER が返される。 指定したRTコンポーネントの状態が Inactive 以外の場合は、 PRECONDITION_NOT_MET が返される。

引数

self
comp	アクティブ化対象RTコンポーネント

戻り値

ReturnCode_t 型のリターンコード

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

add_component()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.add_component	(		self,
			comp
	)

RTコンポーネントを追加する

指定したRTコンポーネントを参加者リストに追加する。 追加されたRTコンポーネントは attach_context が呼ばれ、Inactive 状態に遷移 する。 指定されたRTコンポーネントがnullの場合は、BAD_PARAMETER が返される。 指定されたRTコンポーネントが DataFlowComponent 以外の場合は、 BAD_PARAMETER が返される。

引数

self
comp	追加対象RTコンポーネント

戻り値

ReturnCode_t 型のリターンコード

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

close()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.close	(		self,
			flags
	)

ExecutionContext 用のスレッド実行関数

ExecutionContext 用のスレッド終了時に呼ばれる。 コンポーネントオブジェクトの非アクティブ化、マネージャへの通知を行う。 これは ACE_Task サービスクラスメソッドのオーバーライド。

引数

self
flags	終了処理フラグ

戻り値

終了処理結果

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

deactivate_component()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.deactivate_component	(		self,
			comp
	)

RTコンポーネントを非アクティブ化する

Inactive 状態にあるRTコンポーネントを非アクティブ化し、 Inactive に遷移させる。 この操作が呼ばれた結果、 on_deactivate が呼び出される。 指定したRTコンポーネントが参加者リストに含まれない場合は、 BAD_PARAMETER が返される。 指定したRTコンポーネントの状態が Active 以外の場合は、 PRECONDITION_NOT_MET が返される。

引数

self
comp	非アクティブ化対象RTコンポーネント

戻り値

ReturnCode_t 型のリターンコード

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

exit()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.exit	(		self,
			Task = OpenRTM_aist.Task
	)

終了関数

引数

self
Task

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

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

get_component_state()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_component_state	(		self,
			comp
	)

RTコンポーネントの状態を取得する

指定したRTコンポーネントの状態(LifeCycleState)を取得する。 指定したRTコンポーネントが参加者リストに含まれない場合は、 CREATED_STATE が返される。

引数

self
comp	状態取得対象RTコンポーネント

戻り値

現在の状態(LifeCycleState)

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

get_kind()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_kind

(

self

)

ExecutionKind を取得する

本 ExecutionContext の ExecutionKind を取得する

引数

self

戻り値

ExecutionKind

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

get_profile()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_profile

(

self

)

ExecutionContextProfile を取得する

本 ExecutionContext のプロファイルを取得する。

引数

self

戻り値

ExecutionContextProfile

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

get_rate()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_rate

(

self

)

ExecutionContext の実行周期(Hz)を取得する

Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を取得する。

引数

self

戻り値

処理周期(単位:Hz)

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

init()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.init	(		self,
			props
	)

初期化関数

引数

self
props	プロパティ

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

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

is_running()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.is_running

(

self

)

ExecutionContext 実行状態確認関数

この操作は ExecutionContext が Runnning 状態の場合に true を返す。 Executioncontext が Running の間、当該 Executioncontext に参加している 全てのアクティブRTコンポーネントが、 ExecutionContext の実行種類に応じて 実行される。

引数

self

戻り値

状態確認関数(動作中:true、停止中:false)

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

open()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.open	(		self,
		*	args
	)

ExecutionContext用アクティビティスレッドを生成する

int PeriodicExecutionContext::open(void *args)

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

remove_component()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.remove_component	(		self,
			comp
	)

RTコンポーネントを参加者リストから削除する

指定したRTコンポーネントを参加者リストから削除する。 削除されたRTコンポーネントは detach_context が呼ばれる。 指定されたRTコンポーネントが参加者リストに登録されていない場合は、 BAD_PARAMETER が返される。

引数

self
comp	削除対象RTコンポーネント

戻り値

ReturnCode_t 型のリターンコード

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

reset_component()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.reset_component	(		self,
			comp
	)

RTコンポーネントをリセットする

Error 状態のRTコンポーネントの復帰を試みる。 この操作が呼ばれた結果、 on_reset が呼び出される。 指定したRTコンポーネントが参加者リストに含まれない場合は、 BAD_PARAMETER が返される。 指定したRTコンポーネントの状態が Error 以外の場合は、 PRECONDITION_NOT_MET が返される。

引数

self
comp	リセット対象RTコンポーネント

戻り値

ReturnCode_t 型のリターンコード

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

set_rate()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.set_rate	(		self,
			rate
	)

ExecutionContext の実行周期(Hz)を設定する

Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を設定する。 実行周期の変更は、 DataFlowComponentAction の on_rate_changed によって 各RTコンポーネントに伝達される。

引数

self
rate	処理周期(単位:Hz)

戻り値

ReturnCode_t 型のリターンコード

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

start()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.start

(

self

)

ExecutionContext の実行を開始

ExecutionContext の実行状態を Runnning とするためのリクエストを発行する。 ExecutionContext の状態が遷移すると ComponentAction::on_startup が 呼び出される。 参加しているRTコンポーネントが、初期化されるまで ExecutionContext を開始 することはできない。 ExecutionContext は複数回開始/停止を繰り返すことができる。

引数

self

戻り値

ReturnCode_t 型のリターンコード

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

stop()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.stop

(

self

)

ExecutionContext の実行を停止

ExecutionContext の状態を Stopped とするためのリクエストを発行する。 遷移が発生した場合は、 ComponentAction::on_shutdown が呼び出される。 参加しているRTコンポーネントが終了する前に ExecutionContext を停止する 必要がある。 ExecutionContext は複数回開始/停止を繰り返すことができる。

引数

self

戻り値

ReturnCode_t 型のリターンコード

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

svc()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.svc

(

self

)

コンポーネントのアクティビティスレッド関数

コンポーネントの内部アクティビティスレッドの実行関数。 ACE_Task サービスクラスメソッドのオーバーライド。

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

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

---

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

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