クラス CorbaPort

RT コンポーネント CORBA provider/consumer 用 Port [詳細]


Public メソッド

def __init__
 コンストラクタ
def registerProvider
 Provider を登録する
def registerConsumer
 Consumer を登録する
def publishInterfaces
 Interface 情報を公開する
def subscribeInterfaces
 Interface に接続する
def unsubscribeInterfaces
 Interface への接続を解除する

データ構造

class  Consumer
 Consumer の情報を格納する構造体 [詳細]
class  subscribe
 ConnectorProfile と Consuemr の比較をしオブジェクト参照を セットするための Functor [詳細]
class  unsubscribe
 Consumer のオブジェクトを解放するための Functor [詳細]


説明

RT コンポーネント CORBA provider/consumer 用 Port

CorbaPort は RT コンポーネントにおいて、ユーザ定義の CORBA オブジェクト サービスおよびコンシューマを提供する Port 実装である。

RT コンポーネントは、Port を介してユーザが定義した CORBA サービスを提供 することができ、これを RT Service (Provider) と呼ぶ。 また、他の RT コンポーネントのサービスを利用するための CORBA オブジェクト のプレースホルダを提供することができ、これを RT Service Consumer と呼ぶ。

CorbaPort は任意の数の Provider および Consumer を管理することができ、 Port 同士を接続する際に対応する Provider と Consumer を適切に関連付ける ことができる。

CorbaPort は通常以下のように利用される。

 # CORBAポートの初期化
 self._myServicePort = OpenRTM.CorbaPort("MyService")

 // Provider側
 # この Port が提供する Serivce Provider の初期化
 self._mpros = MyServiceSVC_impl()
 # Service Provider を Port に登録
 self._myServicePort.registerProvider("myservice0", "MyService", self._mpros)

 // Consumer側
 # この Port が提供する Serivce Consumer の初期化
 self._mycons = OpenRTM.CorbaConsumer(interfaceType=_GlobalIDL.MyService)
 # Service Consumer を Port に登録
 self._myServicePort.registerConsumer("myservice0", "MyService", self._mycons)

 # CORBAポートへの登録
 self.registerPort(self._myServicePort)

 // connect が行われた後
 self.my_cons._ptr().your_service_function(); // YourService の関数をコール

 // connect された 別のコンポーネントにおいて
 self.m_cons1._ptr().my_service_function(); // MyService の関数をコール
 

このように、提供したい Service Provider を registerProvider() で登録 することにより、他のコンポーネントから利用可能にし、他方、 利用したい Service ConsumerregisterConsumer() で登録することにより 他のコンポーネントの Service をコンポーネント内で利用可能にすることが できる。

から:
0.4.0

CorbaPort.py126 行で定義されています。


関数

def __init__ (   self,
  name 
)

コンストラクタ

引数:
self 
name Port の名前

CorbaPort.py146 行で定義されています。

def registerProvider (   self,
  instance_name,
  type_name,
  provider 
)

Provider を登録する

この Port において提供したいサーバントをこの Port に対して登録する。 サーバントは、引数で与えられる instance_name, type_name を、 サーバント自身のインスタンス名およびタイプ名として、サーバントに 関連付けられる。

引数:
self 
instance_name サーバントのインスタンス名
type_name サーバントのタイプ名
provider CORBA サーバント
戻り値:
既に同名の instance_name が登録されていれば false を返す。

CorbaPort.py187 行で定義されています。

def registerConsumer (   self,
  instance_name,
  type_name,
  consumer 
)

Consumer を登録する

この Port が要求するサービスのプレースホルダであるコンシューマ (Consumer) を登録する。 Consumer が関連付けられるサービスのインスタンス名およびタイプ名として、 引数に instance_name, type_name および Consumer 自身を与えることにより、 内部でこれらが関連付けられる。 Port 間の接続 (connect) 時 には、同一の instance_name, type_name を持つ サービスが他の Port から提供 (Provide) されている場合、そのサービスの オブジェクト参照が自動的に Consumer にセットされる。

引数:
self 
instance_name Consumer が要求するサービスのインスタンス名
type_name Consumer が要求するサービスのタイプ名
consumer CORBA サービスコンシューマ
戻り値:
既に同名の instance_name が登録されていれば false を返す。

CorbaPort.py241 行で定義されています。

def publishInterfaces (   self,
  connector_profile 
)

Interface 情報を公開する

この Portが所有する Provider に関する情報を ConnectorProfile::properties に代入する。 代入する情報は、NVListの name と value として以下のものが格納される。

ここで、

  PortInterfaceProfile
  {
    instance_name = "PA10_0";
    type_name     = "Manipulator";
    polarity      = PROVIDED;
  }

ならば、

 NameValue = { "port.Manipulator.PA10_0": <Object reference>=""> }
 

といった値が ConnectorProfile::properties に格納され、他のポートに対して 伝達される。他の Port でこのインターフェースを使用する Consumer が 存在すれば、ConnectorProfile からこのキーからオブジェクトリファレンスを 取得し何らかの形で使用される。

引数:
self 
connector_profile コネクタプロファイル
戻り値:
ReturnCode_t 型のリターンコード

CorbaPort.py299 行で定義されています。

def subscribeInterfaces (   self,
  connector_profile 
)

Interface に接続する

この Portが所有する Consumer に適合する Provider に関する情報を ConnectorProfile::properties から抽出し Consumer にオブジェクト参照 をセットする。

今、Consumer が

  PortInterfaceProfile
  {
    instance_name = "PA10_0";
    type_name     = "Manipulator";
    polarity      = REQUIRED;
  }
 
として登録されていれば、他の Port の
  PortInterfaceProfile
  {
    instance_name = "PA10_0";
    type_name     = "Manipulator";
    polarity      = PROVIDED;
  }
 
として登録されている Serivce Provider のオブジェクト参照を探し、 Consumer にセットする。 実際には、ConnectorProfileproperties に
 NameValue = { "port.Manipulator.PA10_0": <Object reference>=""> }
 
として登録されている NameValue を探し、そのオブジェクト参照を Consumer にセットする。

引数:
self 
connector_profile コネクタプロファイル
戻り値:
ReturnCode_t 型のリターンコード

CorbaPort.py351 行で定義されています。

def unsubscribeInterfaces (   self,
  connector_profile 
)

Interface への接続を解除する

与えられた ConnectorProfile に関連する Consumer にセットされた すべての Object を解放し接続を解除する。

引数:
self 
connector_profile コネクタプロファイル

CorbaPort.py373 行で定義されています。


OpenRTMに対してMon Mar 17 15:11:07 2008に生成されました。  doxygen 1.5.4