OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite クラス

[詳解]

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite の継承関係図

公開メンバ関数
def	__init__ (self, manager)
def	__del__ (self)
def	shutdown (self)
def	onInitialize (self)
def	onActivated (self, exec_handle)
def	activateChildComp (self, rtobj)
def	onDeactivated (self, exec_handle)
def	deactivateChildComp (self, rtobj)
def	onReset (self, exec_handle)
def	resetChildComp (self, rtobj)
def	onFinalize (self)
基底クラス OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase に属する継承公開メンバ関数
def	__init__ (self, manager=None, orb=None, poa=None)
def	init (self)
def	on_execute (self, ec_id)
def	on_state_update (self, ec_id)
def	on_rate_changed (self, ec_id)
基底クラス OpenRTM_aist.RTObject.RTObject_impl に属する継承公開メンバ関数
def	__init__ (self, manager=None, orb=None, poa=None)
def	__del__ (self)
def	onInitialize (self)
def	onFinalize (self)
def	onStartup (self, ec_id)
def	onShutdown (self, ec_id)
def	onActivated (self, ec_id)
def	onDeactivated (self, ec_id)
def	onExecute (self, ec_id)
def	onAborting (self, ec_id)
def	onError (self, ec_id)
def	onReset (self, ec_id)
def	onStateUpdate (self, ec_id)
def	onRateChanged (self, ec_id)
def	onAction (self, ec_id)
def	initialize (self)
def	finalize (self)
def	exit (self)
def	is_alive (self, exec_context)
def	get_context (self, ec_id)
def	get_owned_contexts (self)
def	get_participating_contexts (self)
def	get_component_profile (self)
def	get_ports (self)
def	attach_context (self, exec_context)
def	detach_context (self, ec_id)
def	on_initialize (self)
def	on_finalize (self)
def	on_startup (self, ec_id)
def	on_shutdown (self, ec_id)
def	on_activated (self, ec_id)
def	on_deactivated (self, ec_id)
def	on_aborting (self, ec_id)
def	on_error (self, ec_id)
def	on_reset (self, ec_id)
def	get_owned_organizations (self)
def	get_sdo_id (self)
def	get_sdo_type (self)
def	get_device_profile (self)
def	get_service_profiles (self)
def	get_service_profile (self, _id)
def	get_sdo_service (self, _id)
def	get_configuration (self)
def	get_monitoring (self)
def	get_organizations (self)
def	get_status_list (self)
def	get_status (self, name)
def	getInstanceName (self)
def	setInstanceName (self, instance_name)
def	getTypeName (self)
def	getDescription (self)
def	getVersion (self)
def	getVendor (self)
def	getCategory (self)
def	getNamingNames (self)
def	setObjRef (self, rtobj)
def	getObjRef (self)
def	setProperties (self, prop)
def	getProperties (self)
def	bindParameter (self, param_name, var, def_val, trans=None)
def	getConfigService (self)
def	updateParameters (self, config_set)
def	registerPort (self, port)
def	registerInPort (self, name, inport)
def	registerOutPort (self, name, outport)
def	removeInPort (self, port)
def	removeOutPort (self, port)
def	deletePort (self, port)
def	deletePortByName (self, port_name)
def	getExecutionContext (self, ec_id)
def	getExecutionRate (self, ec_id)
def	setExecutionRate (self, ec_id, rate)
def	isOwnExecutionContext (self, ec_id)
def	deactivate (self, ec_id)
def	activate (self, ec_id)
def	reset (self, ec_id)
def	addSdoServiceProvider (self, prof, provider)
def	removeSdoServiceProvider (self, id)
def	addSdoServiceConsumer (self, prof)
def	removeSdoServiceConsumer (self, id)
def	removeSdoServiceConsumerStartThread (self, id)
def	readAll (self)
def	writeAll (self)
def	setReadAll (self, read=True, completion=False)
def	setWriteAll (self, write=True, completion=False)
def	finalizePorts (self)
def	addPreComponentActionListener (self, listener_type, memfunc)
def	removePreComponentActionListener (self, listener_type, listener)
def	addPostComponentActionListener (self, listener_type, memfunc)
def	removePostComponentActionListener (self, listener_type, listener)
def	addPortActionListener (self, listener_type, memfunc)
def	removePortActionListener (self, listener_type, listener)
def	addExecutionContextActionListener (self, listener_type, memfunc)
def	removeExecutionContextActionListener (self, listener_type, listener)
def	addPortConnectListener (self, listener_type, memfunc)
def	removePortConnectListener (self, listener_type, listener)
def	addPortConnectRetListener (self, listener_type, memfunc)
def	removePortConnectRetListener (self, listener_type, listener)
def	addConfigurationParamListener (self, type, memfunc)
def	removeConfigurationParamListener (self, type, listener)
def	addConfigurationSetListener (self, listener_type, memfunc)
def	removeConfigurationSetListener (self, type, listener)
def	addConfigurationSetNameListener (self, type, memfunc)
def	removeConfigurationSetNameListener (self, type, listener)
def	addPreFsmActionListener (self, listener_type, memfunc)
def	removePreFsmActionListener (self, listener_type, listener)
def	addPostFsmActionListener (self, listener_type, memfunc)
def	removePostFsmActionListener (self, listener_type, listener)
def	addFsmProfileListener (self, listener_type, memfunc)
def	removeFsmProfileListener (self, listener_type, listener)
def	addFsmStructureListener (self, listener_type, memfunc)
def	removeFsmStructureListener (self, listener_type, listener)
def	shutdown (self)
def	getPrivateContextOptions (self, ec_args)
	getting individual EC options from RTC's configuration file [詳解]
def	getGlobalContextOptions (self, global_ec_props)
	getting global EC options from rtc.conf [詳解]
def	getContextOptions (self, ec_args)
	getting EC options [詳解]
def	findExistingEC (self, ec_arg)
	fiding existing EC from the factory [詳解]
def	createContexts (self, ec_args)
	creating, initializing and binding context [詳解]
def	setINSObjRef (self, obj)
	omniINSPOAから取得したオブジェクトを登録 [詳解]

詳解

PeriodicECSharedComposite クラス

データフロー型RTComponentの基底クラス。 各種データフロー型RTComponentを実装する場合は、本クラスを継承する形で実装 する。

から

0.4.0

構築子と解体子

__init__()

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.__init__	(		self,
			manager
	)

コンストラクタ

コンストラクタ

引数

manager

マネージャオブジェクト

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

__del__()

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.__del__

(

self

)

デストラクタ

デストラクタ

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

メソッド詳解

activateChildComp()

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.activateChildComp	(		self,
			rtobj
	)

RTCをアクティブ化する 複合コンポーネントの場合は子コンポーネントをアクティブ化する

引数

self
rtobj	RTC

deactivateChildComp()

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.deactivateChildComp	(		self,
			rtobj
	)

RTCを非アクティブ化する 複合コンポーネントの場合は子コンポーネントを非アクティブ化する

引数

self
rtobj	RTC

onActivated()

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onActivated	(		self,
			exec_handle
	)

活性化処理用コールバック関数

ComponentAction::on_activated が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の活性化処理は、本関数をオーバーライドして実装する 必要がある。

引数

exec_handle

参加している ExecutionContext の ID

戻り値

ReturnCode_t 型のリターンコード

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

onDeactivated()

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onDeactivated	(		self,
			exec_handle
	)

非活性化処理用コールバック関数

ComponentAction::on_deactivated が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の非活性化処理は、本関数をオーバーライドして実装する 必要がある。

引数

exec_handle

参加している ExecutionContext の ID

戻り値

ReturnCode_t 型のリターンコード

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

onFinalize()

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onFinalize

(

self

)

[ComponentAction CORBA interface] RTC の終了

RTC が破棄される。 RTC 固有の終了処理はここで実行する。 このオペレーション呼び出しの結果として onFinalize() コールバック関数が 呼び出される。

戻り値

ReturnCode_t 型のリターンコード

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

onInitialize()

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onInitialize

(

self

)

初期化

データフロー型 RTComponent の初期化を実行する。 実際の初期化処理は、各具象クラス内に記述する。

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

onReset()

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onReset	(		self,
			exec_handle
	)

リセット処理用コールバック関数

ComponentAction::on_reset が呼ばれた際に実行されるコールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際のリセット処理は、本関数をオーバーライドして実装する 必要がある。

引数

exec_handle

参加している ExecutionContext の ID

戻り値

ReturnCode_t 型のリターンコード

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

resetChildComp()

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.resetChildComp	(		self,
			rtobj
	)

RTCをリセットする 複合コンポーネントの場合は子コンポーネントをリセットする

引数

self
rtobj	RTC

shutdown()

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.shutdown

(

self

)

終了関数 オーガナイズオブジェクトを非アクティブにする

引数

self

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

---

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

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