PortAdmin クラス [詳解]

#include <PortAdmin.h>

公開メンバ関数
	PortAdmin (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa)
	コンストラクタ [詳解]

virtual	~PortAdmin (void)
	デストラクタ [詳解]

PortServiceList *	getPortServiceList () const
	Port リストの取得 [詳解]

PortProfileList	getPortProfileList () const
	PorProfile リストの取得 [詳解]

PortService_ptr	getPortRef (const char *port_name) const
	Port のオブジェクト参照の取得 [詳解]

PortBase *	getPort (const char *port_name) const
	Port のサーバントのポインタの取得 [詳解]

bool	addPort (PortBase &port)
	Port を登録する [詳解]

bool	addPort (PortService_ptr port)
	Port を登録する [詳解]

void	registerPort (PortBase &port)
	Port を登録する [詳解]

void	registerPort (PortService_ptr port)
	Port を登録する [詳解]

bool	removePort (PortBase &port)
	Port の登録を解除する [詳解]

bool	removePort (PortService_ptr port)
	Port の登録を解除する [詳解]

void	deletePort (PortBase &port)
	Port の登録を解除する [詳解]

void	deletePort (PortService_ptr port)
	Port の登録を解除する [詳解]

void	deletePortByName (const char *port_name)
	名称指定によりPort の登録を解除する [詳解]

void	activatePorts ()
	全ての Port のインターフェースを activates する [詳解]

void	deactivatePorts ()
	全ての Port のインターフェースを deactivates する [詳解]

void	finalizePorts ()
	全ての Port をdeactivateし登録を削除する [詳解]

詳解

PortAdmin クラス

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

から: 0.4.0

構築子と解体子

RTC::PortAdmin::PortAdmin	(	CORBA::ORB_ptr	orb,
		PortableServer::POA_ptr	poa
	)

コンストラクタ

引数

orb	ORB
poa	POA

virtual RTC::PortAdmin::~PortAdmin ( void )

inlinevirtual

デストラクタ

参照先 activatePorts(), addPort(), deactivatePorts(), deletePort(), deletePortByName(), finalizePorts(), getPort(), RTC::PortBase::getPortProfile(), getPortProfileList(), getPortRef(), getPortServiceList(), CORBA_SeqUtil::push_back(), registerPort(), removePort().

関数詳解

void RTC::PortAdmin::activatePorts ( )

全ての Port のインターフェースを activates する

登録されている全ての Port のインターフェースに対して、 activate する。この関数は、ComponentAction の on_activate() 内で呼ばれる。

参照元 ~PortAdmin().

bool RTC::PortAdmin::addPort ( PortBase & port )

Port を登録する

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

引数

port	Port サーバント

戻り値: 登録結果(登録成功:true，登録失敗:false)

参照元 ~PortAdmin().

bool RTC::PortAdmin::addPort ( PortService_ptr port )

Port を登録する

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

引数

port	Port サーバント

戻り値: 登録結果(登録成功:true，登録失敗:false)

void RTC::PortAdmin::deactivatePorts ( )

全ての Port のインターフェースを deactivates する

登録されている全ての Port のインターフェースに対して、 deactivate する。この関数は、ComponentAction の on_deactivate() 内で呼ばれる。

参照元 ~PortAdmin().

void RTC::PortAdmin::deletePort ( PortBase & port )

Port の登録を解除する

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

引数

port	Port サーバント

参照元 ~PortAdmin().

void RTC::PortAdmin::deletePort ( PortService_ptr port )

Port の登録を解除する

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

引数

port	Port サーバント

void RTC::PortAdmin::deletePortByName ( const char * port_name )

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

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

引数

port_name Port の名前

参照元 ~PortAdmin().

void RTC::PortAdmin::finalizePorts ( )

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

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

参照元 ~PortAdmin().

PortBase* RTC::PortAdmin::getPort ( const char * port_name ) const

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

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

引数

port_name 参照を返すPortの名前

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

参照元 ~PortAdmin().

PortProfileList RTC::PortAdmin::getPortProfileList ( ) const

PorProfile リストの取得

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

戻り値: PortProfile リスト

参照元 ~PortAdmin().

PortService_ptr RTC::PortAdmin::getPortRef ( const char * port_name ) const

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

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

引数

port_name 参照を返すPortの名前

戻り値: PortService_ptr Portのオブジェクト参照

参照元 ~PortAdmin().

PortServiceList* RTC::PortAdmin::getPortServiceList ( ) const

Port リストの取得

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

戻り値: Port リスト

参照元 ~PortAdmin().

void RTC::PortAdmin::registerPort ( PortBase & port )

Port を登録する

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

引数

port	Port サーバント

参照元 ~PortAdmin().

void RTC::PortAdmin::registerPort ( PortService_ptr port )

Port を登録する

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

引数

port	Port サーバント

bool RTC::PortAdmin::removePort ( PortBase & port )

Port の登録を解除する

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

引数

port	Port サーバント

戻り値: 削除結果(削除成功:true，削除失敗:false)

参照元 ~PortAdmin().

bool RTC::PortAdmin::removePort ( PortService_ptr port )

Port の登録を解除する

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

引数

port	Port サーバント

戻り値: 削除結果(削除成功:true，削除失敗:false)

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

PortAdmin.h

公開メンバ関数

詳解

構築子と解体子

関数詳解