OpenRTM_aist.PortAdmin.PortAdmin クラス

[詳解]

クラス
class	comp_op
class	del_port
class	find_port
class	find_port_name

公開メンバ関数
	__init__ (self, orb, poa)
	getPortServiceList (self)
	getPortProfileList (self)
	getPortRef (self, port_name)
	getPort (self, port_name)
	registerPort (self, port)
	deletePort (self, port)
	deletePortByName (self, port_name)
	activatePorts (self)
	deactivatePorts (self)
	finalizePorts (self)

詳解

PortAdmin クラス

各種 Port の管理を行うクラス。 Port の登録/登録解除など各種管理操作を実行するとともに、登録されている Port の管理を行うクラス。

から

0.4.0

構築子と解体子

__init__()

OpenRTM_aist.PortAdmin.PortAdmin.__init__	(		self,
			orb,
			poa )

コンストラクタ

コンストラクタ

引数

self
orb	ORB
poa	POA

メソッド詳解

activatePorts()

OpenRTM_aist.PortAdmin.PortAdmin.activatePorts

(

self

)

全ての Port のインターフェースを activates する void PortAdmin.activatePorts()

deactivatePorts()

OpenRTM_aist.PortAdmin.PortAdmin.deactivatePorts

(

self

)

全ての Port のインターフェースを deactivates する void PortAdmin.deactivatePorts()

deletePort()

OpenRTM_aist.PortAdmin.PortAdmin.deletePort	(		self,
			port )

Port の登録を解除する

引数 port で指定された Port の登録を解除する。 削除時に Port は deactivate され、PortのProfileのリファレンスには、 nil値が代入される。

引数

self
port	Port サーバント

deletePortByName()

OpenRTM_aist.PortAdmin.PortAdmin.deletePortByName	(		self,
			port_name )

名称指定によりPort の登録を解除する

引数で指定された名前を持つ Port の登録を削除する。 削除時に Port は deactivate され、PortのProfileのリファレンスには、 nil値が代入される。

引数

self
port_name	Port の名前

finalizePorts()

OpenRTM_aist.PortAdmin.PortAdmin.finalizePorts

(

self

)

全ての Port をdeactivateし登録を削除する

登録されている全てのPortに対して、サーバントのdeactivateを行い、 登録リストから削除する。

引数

self

getPort()

OpenRTM_aist.PortAdmin.PortAdmin.getPort	(		self,
			port_name )

Port のサーバントのポインタの取得

port_name で指定した Port のサーバントのポインタを返す。 port_name で指定する Port はあらかじめ registerPort() で登録されてい なければならない。

引数

self
port_name	参照を返すPortの名前

戻り値

PortBase* Portサーバント基底クラスのポインタ

getPortProfileList()

OpenRTM_aist.PortAdmin.PortAdmin.getPortProfileList

(

self

)

PorProfile リストの取得

addPort() により登録された Port の Profile リストを取得する。

戻り値

PortProfile リスト

getPortRef()

OpenRTM_aist.PortAdmin.PortAdmin.getPortRef	(		self,
			port_name )

Port のオブジェクト参照の取得

port_name で指定した Port のオブジェクト参照を返す。 port_name で指定する Port はあらかじめ registerPort() で登録されてい なければならない。

引数

self
port_name	参照を返すPortの名前

戻り値

Port_ptr Portのオブジェクト参照

getPortServiceList()

OpenRTM_aist.PortAdmin.PortAdmin.getPortServiceList

(

self

)

Port リストの取得

registerPort() により登録された Port の リストを取得する。

引数

self

戻り値

Port リスト

registerPort()

OpenRTM_aist.PortAdmin.PortAdmin.registerPort	(		self,
			port )

Port を登録する

引数 port で指定された Port のサーバントを登録する。 登録された Port のサーバントはコンストラクタで与えられたPOA 上で activate され、そのオブジェクト参照はPortのProfileにセットされる。

引数

self
port	Port サーバント

void registerPort(PortBase& port);

---

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

• PortAdmin.py