OpenRTM-aist 2.0.2
読み取り中…
検索中…
一致する文字列を見つけられません
公開メンバ関数 | 全メンバ一覧
RTC::PortAdmin クラス

PortAdmin クラス [詳解]

#include <PortAdmin.h>

公開メンバ関数

 PortAdmin (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa)
 コンストラクタ
 
virtual ~PortAdmin ()
 デストラクタ
 
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

構築子と解体子

◆ PortAdmin()

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

コンストラクタ

コンストラクタ

引数
orbORB
poaPOA

◆ ~PortAdmin()

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

デストラクタ

デストラクタ

関数詳解

◆ activatePorts()

void RTC::PortAdmin::activatePorts ( )

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

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

◆ addPort() [1/2]

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

Port を登録する

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

引数
portPort サーバント
戻り値
登録結果(登録成功:true，登録失敗:false)

◆ addPort() [2/2]

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

Port を登録する

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

引数
portPort サーバント
戻り値
登録結果(登録成功:true，登録失敗:false)

◆ deactivatePorts()

void RTC::PortAdmin::deactivatePorts ( )

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

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

◆ deletePort() [1/2]

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

Port の登録を解除する

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

引数
portPort サーバント

◆ deletePort() [2/2]

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

Port の登録を解除する

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

引数
portPort サーバント

◆ deletePortByName()

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

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

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

引数
port_namePort の名前

◆ finalizePorts()

void RTC::PortAdmin::finalizePorts ( )

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

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

◆ getPort()

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

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

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

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

◆ getPortProfileList()

PortProfileList RTC::PortAdmin::getPortProfileList ( ) const

PorProfile リストの取得

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

戻り値
PortProfile リスト

◆ getPortRef()

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

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

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

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

◆ getPortServiceList()

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

Port リストの取得

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

戻り値
Port リスト

◆ registerPort() [1/2]

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

Port を登録する

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

引数
portPort サーバント

◆ registerPort() [2/2]

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

Port を登録する

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

引数
portPort サーバント

◆ removePort() [1/2]

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

Port の登録を解除する

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

引数
portPort サーバント
戻り値
削除結果(削除成功:true，削除失敗:false)

◆ removePort() [2/2]

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

Port の登録を解除する

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

引数
portPort サーバント
戻り値
削除結果(削除成功:true，削除失敗:false)
このクラス詳解は次のファイルから抽出されました:
構築: doxygen 1.11.0