OpenRTM-aist-Python 1.1.2
クラス | 公開メンバ関数 | 全メンバ一覧
OpenRTM_aist.PortAdmin.PortAdmin クラス

PortAdmin クラス [詳解]

クラス

class  comp_op
 Port 管理用内部クラス [詳解]
 
class  del_port
 Port削除用ファンクタ [詳解]
 
class  find_port
 
class  find_port_name
 Port 検索用ファンクタ [詳解]
 

公開メンバ関数

def __init__ (self, orb, poa)
 コンストラクタ [詳解]
 
def getPortServiceList (self)
 Port リストの取得 [詳解]
 
def getPortProfileList (self)
 PorProfile リストの取得 [詳解]
 
def getPortRef (self, port_name)
 Port のオブジェクト参照の取得 [詳解]
 
def getPort (self, port_name)
 Port のサーバントのポインタの取得 [詳解]
 
def registerPort (self, port)
 Port を登録する [詳解]
 
def deletePort (self, port)
 Port の登録を解除する [詳解]
 
def deletePortByName (self, port_name)
 名称指定によりPort の登録を解除する [詳解]
 
def activatePorts (self)
 全ての Port のインターフェースを activates する void PortAdmin::activatePorts()
 
def deactivatePorts (self)
 全ての Port のインターフェースを deactivates する void PortAdmin::deactivatePorts()
 
def finalizePorts (self)
 全ての Port をdeactivateし登録を削除する [詳解]
 

詳解

PortAdmin クラス

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

から
0.4.0

構築子と解体子

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

コンストラクタ

コンストラクタ

引数
self
orbORB
poaPOA

メソッド詳解

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

Port の登録を解除する

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

引数
self
portPort サーバント
def OpenRTM_aist.PortAdmin.PortAdmin.deletePortByName (   self,
  port_name 
)

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

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

引数
self
port_namePort の名前
def OpenRTM_aist.PortAdmin.PortAdmin.finalizePorts (   self)

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

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

引数
self
def OpenRTM_aist.PortAdmin.PortAdmin.getPort (   self,
  port_name 
)

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

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

引数
self
port_name参照を返すPortの名前
戻り値
PortBase* Portサーバント基底クラスのポインタ
def OpenRTM_aist.PortAdmin.PortAdmin.getPortProfileList (   self)

PorProfile リストの取得

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

戻り値
PortProfile リスト
def OpenRTM_aist.PortAdmin.PortAdmin.getPortRef (   self,
  port_name 
)

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

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

引数
self
port_name参照を返すPortの名前
戻り値
Port_ptr Portのオブジェクト参照
def OpenRTM_aist.PortAdmin.PortAdmin.getPortServiceList (   self)

Port リストの取得

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

引数
self
戻り値
Port リスト
def OpenRTM_aist.PortAdmin.PortAdmin.registerPort (   self,
  port 
)

Port を登録する

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

引数
self
portPort サーバント

void registerPort(PortBase& port);


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