OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker クラス

公開メンバ関数
def	__init__ (self)
	デフォルトコンストラクタ [詳解]
def	__del__ (self)
	デストラクタ [詳解]
def	isRunning (self)
	ExecutionContext 実行状態確認関数 [詳解]
def	start (self)
	ExecutionContext の実行を開始 [詳解]
def	stop (self)
	ExecutionContext の実行を停止 [詳解]
def	activateComponent (self, comp, rtobj)
	RTコンポーネントをアクティブ化する [詳解]
def	deactivateComponent (self, comp, rtobj)
	RTコンポーネントを非アクティブ化する [詳解]
def	resetComponent (self, comp, rtobj)
	RTコンポーネントをリセットする [詳解]
def	getComponentState (self, comp)
	RTコンポーネントの状態を取得する [詳解]
def	addComponent (self, comp)
	RTコンポーネントを追加する [詳解]
def	bindComponent (self, rtc)
	コンポーネントをバインドする。 [詳解]
def	removeComponent (self, comp)
	RTコンポーネントを参加者リストから削除する [詳解]

詳解

構築子と解体子

def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.__init__

(

self

)

デフォルトコンストラクタ

デフォルトコンストラクタ プロファイルに以下の項目を設定する。

• kind : PERIODIC
• rate : 0.0

def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.__del__

(

self

)

デストラクタ

デストラクタ

メソッド詳解

def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.activateComponent	(		self,
			comp,
			rtobj
	)

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

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

引数

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

戻り値

ReturnCode_t 型のリターンコード

RTC::ReturnCode_t activateComponent(RTC::LightweightRTObject_ptr comp, RTObjectStateMachine*& rtobj);

def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.addComponent	(		self,
			comp
	)

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

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

引数

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

戻り値

ReturnCode_t 型のリターンコード

RTC::ReturnCode_t addComponent(RTC::LightweightRTObject_ptr comp);

def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.bindComponent	(		self,
			rtc
	)

コンポーネントをバインドする。

コンポーネントをバインドする。

引数

rtc

RTコンポーネント

戻り値

ReturnCode_t 型のリターンコード RTC::ReturnCode_t bindComponent(RTC::RTObject_impl* rtc);

def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.deactivateComponent	(		self,
			comp,
			rtobj
	)

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

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

引数

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

戻り値

ReturnCode_t 型のリターンコード

RTC::ReturnCode_t deactivateComponent(RTC::LightweightRTObject_ptr comp, RTObjectStateMachine*& rtobj);

def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.getComponentState	(		self,
			comp
	)

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

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

引数

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

戻り値

現在の状態(LifeCycleState)

RTC::LifeCycleState getComponentState(RTC::LightweightRTObject_ptr comp);

def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.isRunning

(

self

)

ExecutionContext 実行状態確認関数

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

戻り値

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

bool isRunning(void);

def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.removeComponent	(		self,
			comp
	)

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

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

引数

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

戻り値

ReturnCode_t 型のリターンコード

RTC::ReturnCode_t removeComponent(RTC::LightweightRTObject_ptr comp);

def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.resetComponent	(		self,
			comp,
			rtobj
	)

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

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

引数

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

戻り値

ReturnCode_t 型のリターンコード

RTC::ReturnCode_t resetComponent(RTC::LightweightRTObject_ptr com, RTObjectStateMachine*& rtobj);

def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.start

(

self

)

ExecutionContext の実行を開始

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

戻り値

ReturnCode_t 型のリターンコード

RTC::ReturnCode_t start(void);

def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.stop

(

self

)

ExecutionContext の実行を停止

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

戻り値

ReturnCode_t 型のリターンコード

RTC::ReturnCode_t stop(void);

---

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

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