クラス RTC::PortAdmin

PortAdmin クラス [詳細]

#include <PortAdmin.h>

すべてのメンバ一覧

Public メソッド

 PortAdmin (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa)
 コンストラクタ
virtual ~PortAdmin ()
 デストラクタ
PortList * getPortList () const
 Port リストの取得
PortProfileList getPortProfileList () const
 PorProfile リストの取得
Port_ptr getPortRef (const char *port_name) const
 Port のオブジェクト参照の取得
PortBasegetPort (const char *port_name) const
 Port のサーバントのポインタの取得
void registerPort (PortBase &port)
 Port を登録する
void deletePort (PortBase &port)
 Port の登録を解除する
void deletePortByName (const char *port_name)
 名称指定によりPort の登録を解除する
void finalizePorts ()
 全ての Port をdeactivateし登録を削除する

構成

class  comp_op
class  port_prof_collect


説明

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 (  )  [inline, virtual]

デストラクタ

デストラクタ


関数

PortList* RTC::PortAdmin::getPortList (  )  const

Port リストの取得

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

戻り値:
Port リスト

PortProfileList RTC::PortAdmin::getPortProfileList (  )  const

PorProfile リストの取得

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

戻り値:
PortProfile リスト

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

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

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

引数:
port_name 参照を返すPortの名前
戻り値:
Port_ptr Portのオブジェクト参照

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

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

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

引数:
port_name 参照を返すPortの名前
戻り値:
PortBase* Portサーバント基底クラスのポインタ

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

Port を登録する

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

引数:
port Port サーバント

void RTC::PortAdmin::deletePort ( PortBase 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 の名前

void RTC::PortAdmin::finalizePorts (  ) 

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

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


OpenRTMに対してWed May 21 05:17:25 2008に生成されました。  doxygen 1.5.3