OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext クラス

PeriodicExecutionContext クラス [詳解]

OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext の継承関係図

クラス
class	WorkerThreadCtrl
	worker 用状態変数クラス [詳解]

公開メンバ関数
def	__init__ (self)
	コンストラクタ [詳解]
def	svc (self)
	コンポーネントのアクティビティスレッド関数 [詳解]
def	open (self, args)
	ExecutionContext用アクティビティスレッドを生成するint PeriodicExecutionContext::open(void *args)
def	close (self, flags)
	ExecutionContext 用のスレッド実行関数 [詳解]
def	is_running (self)
	ExecutionContext 実行状態確認関数 [詳解]
def	start (self)
	ExecutionContext の実行を開始 [詳解]
def	stop (self)
	ExecutionContext の実行を停止 [詳解]
def	get_rate (self)
	ExecutionContext の実行周期(Hz)を取得する [詳解]
def	set_rate (self, rate)
	ExecutionContext の実行周期(Hz)を設定する [詳解]
def	activate_component (self, comp)
	RTコンポーネントをアクティブ化する [詳解]
def	deactivate_component (self, comp)
	RTコンポーネントを非アクティブ化する [詳解]
def	reset_component (self, comp)
	RTコンポーネントをリセットする [詳解]
def	get_component_state (self, comp)
	RTコンポーネントの状態を取得する [詳解]
def	get_kind (self)
	ExecutionKind を取得する [詳解]
def	add_component (self, comp)
	RTコンポーネントを追加する [詳解]
def	remove_component (self, comp)
	RTコンポーネントを参加者リストから削除する [詳解]
def	get_profile (self)
	ExecutionContextProfile を取得する [詳解]
基底クラス OpenRTM_aist.ExecutionContextBase.ExecutionContextBase に属する継承公開メンバ関数
def	init (self, props)
	ExecutionContextの初期化処理 [詳解]
def	bindComponent (self, rtc)
	ExecutionContextの処理を進める(サブクラス実装用) [詳解]
def	isRunning (self)
	ExecutionContext 実行状態確認関数 CORBA::Boolean ExecutionContextBase::isRunning()
def	start (self)
	ExecutionContext の実行を開始 RTC::ReturnCode_t ExecutionContextBase::start()
def	stop (self)
	ExecutionContext の実行を停止 RTC::ReturnCode_t ExecutionContextBase::stop()
def	getRate (self)
	ExecutionContext の実行周期(Hz)を取得する [詳解]
def	setRate (self, rate)
	ExecutionContext の実行周期(Hz)を設定する [詳解]
def	addComponent (self, comp)
	RTコンポーネントを追加する RTC::ReturnCode_t ExecutionContextBase:: addComponent(RTC::LightweightRTObject_ptr comp)
def	removeComponent (self, comp)
	RTコンポーネントを参加者リストから削除する RTC::ReturnCode_t ExecutionContextBase:: removeComponent(RTC::LightweightRTObject_ptr comp)
def	activateComponent (self, comp)
	RTコンポーネントをアクティブ化する RTC::ReturnCode_t ExecutionContextBase:: activateComponent(RTC::LightweightRTObject_ptr comp)
def	deactivateComponent (self, comp)
	RTコンポーネントを非アクティブ化する RTC::ReturnCode_t ExecutionContextBase:: deactivateComponent(RTC::LightweightRTObject_ptr comp)
def	resetComponent (self, comp)
	RTコンポーネントをリセットする RTC::ReturnCode_t ExecutionContextBase:: resetComponent(RTC::LightweightRTObject_ptr comp)
def	getComponentState (self, comp)
	RTコンポーネントの状態を取得する [詳解]
def	getKind (self)
	ExecutionKind を取得する [詳解]
def	getProfile (self)
	Profileを取得する [詳解]
def	setObjRef (self, ec_ptr)
	CORBA オブジェクト参照の取得 [詳解]
def	getObjRef (self)
	CORBA オブジェクト参照の取得 [詳解]
def	getKindString (self, kind)
	ExecutionKind を文字列化する [詳解]
def	setKind (self, kind)
	ExecutionKind を設定する [詳解]
def	setOwner (self, comp)
	Ownerコンポーネントをセットする。 [詳解]
def	getOwner (self)
	Ownerコンポーネントの参照を取得する [詳解]
def	getComponentList (self)
	RTコンポーネントの参加者リストを取得する [詳解]
def	setProperties (self, props)
	Propertiesをセットする [詳解]
def	getProperties (self)
	Propertiesを取得する [詳解]
def	getProfile (self)
	Profileを取得する [詳解]
def	setExecutionRate (self, props)
	Propertiesから実行コンテキストをセットする bool ExecutionContextBase::setExecutionRate(coil::Properties& props)
def	setTransitionMode (self, props, key, flag)
	Propertiesから状態遷移モードをセットする bool ExecutionContextBase:: setTransitionMode(coil::Properties& props, const char* key, bool& flag)
def	setTimeout (self, props, key, timevalue)
	Propertiesから状態遷移Timeoutをセットする bool ExecutionContextBase:: setTimeout(coil::Properties& props, const char* key, coil::TimeValue& timevalue)

詳解

PeriodicExecutionContext クラス

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

から

0.4.0

構築子と解体子

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.__init__

(

self

)

コンストラクタ

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

メソッド詳解

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 型のリターンコード

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 型のリターンコード

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

ExecutionContext 用のスレッド実行関数

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

引数

self
flags	終了処理フラグ

戻り値

終了処理結果

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 型のリターンコード

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

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

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

引数

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

戻り値

現在の状態(LifeCycleState)

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_kind

(

self

)

ExecutionKind を取得する

本 ExecutionContext の ExecutionKind を取得する

引数

self

戻り値

ExecutionKind

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_profile

(

self

)

ExecutionContextProfile を取得する

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

引数

self

戻り値

ExecutionContextProfile

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_rate

(

self

)

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

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

引数

self

戻り値

処理周期(単位:Hz)

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.is_running

(

self

)

ExecutionContext 実行状態確認関数

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

引数

self

戻り値

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

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

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

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

引数

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

戻り値

ReturnCode_t 型のリターンコード

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 型のリターンコード

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

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

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

引数

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

戻り値

ReturnCode_t 型のリターンコード

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.start

(

self

)

ExecutionContext の実行を開始

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

引数

self

戻り値

ReturnCode_t 型のリターンコード

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.stop

(

self

)

ExecutionContext の実行を停止

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

引数

self

戻り値

ReturnCode_t 型のリターンコード

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.svc

(

self

)

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

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

---

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

• /tmp/workspace/03_openrtm-python-build-tags/OpenRTM_aist/PeriodicExecutionContext.py