OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase クラス

[詳解]

OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase の継承関係図

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

詳解

DataFlowComponentBase クラス

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

から

0.4.0

構築子と解体子

__init__()

OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.__init__	(		self,
			manager = None,
			orb = None,
			poa = None )

コンストラクタ

コンストラクタ

引数

self
manager	マネージャオブジェクト

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

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

メソッド詳解

init()

OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.init

(

self

)

初期化(サブクラス実装用)

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

引数

self

on_execute()

OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.on_execute	(		self,
			ec_id )

[DataFlowComponentAction CORBA interface] RTC の定常処理(第一周期)

以下の状態が保持されている場合に、設定された周期で定期的に呼び出される。

• RTC は Alive 状態である。
• 指定された ExecutionContext が Running 状態である。 本オペレーションは、Two-Pass Execution の第一周期で実行される。 このオペレーション呼び出しの結果として onExecute() コールバック関数が呼び 出される。

制約

• 指定された ExecutionContext の ExecutionKind は、 PERIODIC でなければな らない

引数

self
ec_id	定常処理対象 ExecutionContext の ID

戻り値

ReturnCode_t 型のリターンコード

on_rate_changed()

OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.on_rate_changed	(		self,
			ec_id )

[DataFlowComponentAction CORBA interface] 実行周期変更通知

本オペレーションは、ExecutionContext の実行周期が変更されたことを通知する 際に呼び出される。 このオペレーション呼び出しの結果として onRateChanged() コールバック関数が 呼び出される。

制約

• 指定された ExecutionContext の ExecutionKind は、 PERIODIC でなければな らない

引数

self
ec_id	定常処理対象 ExecutionContext の ID

戻り値

ReturnCode_t 型のリターンコード

on_state_update()

OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.on_state_update	(		self,
			ec_id )

[DataFlowComponentAction CORBA interface] RTC の定常処理(第二周期)

以下の状態が保持されている場合に、設定された周期で定期的に呼び出される。

• RTC は Alive 状態である。
• 指定された ExecutionContext が Running 状態である。 本オペレーションは、Two-Pass Execution の第二周期で実行される。 このオペレーション呼び出しの結果として onStateUpdate() コールバック関数が 呼び出される。

制約

• 指定された ExecutionContext の ExecutionKind は、 PERIODIC でなければな らない

引数

self
ec_id	定常処理対象 ExecutionContext の ID

戻り値

ReturnCode_t 型のリターンコード

---

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

• DataFlowComponentBase.py