OpenRTM-aist-Python 2.0.2
OpenRTM_aist.InPortSHMConsumer.InPortSHMConsumer クラス

[詳解]

OpenRTM_aist.InPortSHMConsumer.InPortSHMConsumer の継承関係図
OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer OpenRTM_aist.InPortConsumer.InPortConsumer OpenRTM_aist.CorbaConsumer.CorbaConsumer OpenRTM_aist.DataPortStatus.DataPortStatus OpenRTM_aist.CorbaConsumer.CorbaConsumerBase

公開メンバ関数

 __init__ (self)
 
 __del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer)
 
 init (self, prop)
 
 setObject (self, obj)
 
 put (self, data)
 
- 基底クラス OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer に属する継承公開メンバ関数
 publishInterfaceProfile (self, properties)
 
 subscribeInterface (self, properties)
 
 unsubscribeInterface (self, properties)
 
 subscribeFromIor (self, properties)
 
 subscribeFromRef (self, properties)
 
 unsubscribeFromIor (self, properties)
 
 unsubscribeFromRef (self, properties)
 
 convertReturnCode (self, ret)
 
- 基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数
 toString (status)
 
- 基底クラス OpenRTM_aist.CorbaConsumer.CorbaConsumer に属する継承公開メンバ関数
 equal (self, consumer)
 
 releaseObject (self)
 
- 基底クラス OpenRTM_aist.CorbaConsumer.CorbaConsumerBase に属する継承公開メンバ関数
 getObject (self)
 

その他の継承メンバ

- 基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承静的公開変数類
int PORT_OK = 0
 brief DataPortStatus リターンコード
 
- 基底クラス OpenRTM_aist.CorbaConsumer.CorbaConsumer に属する継承限定公開メンバ関数
 _ptr (self, get_ref=False)
 

詳解

InPortSHMConsumer クラス

通信手段に 共有メモリ を利用した入力ポートコンシューマの実装クラス。

構築子と解体子

◆ __init__()

OpenRTM_aist.InPortSHMConsumer.InPortSHMConsumer.__init__ ( self)

コンストラクタ

コンストラクタ

引数
self

OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumerを再実装しています。

◆ __del__()

OpenRTM_aist.InPortSHMConsumer.InPortSHMConsumer.__del__ ( self,
CorbaConsumer = OpenRTM_aist.CorbaConsumer )

デストラクタ

デストラクタ

引数
self
CorbaConsumer

OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumerを再実装しています。

メソッド詳解

◆ init()

OpenRTM_aist.InPortSHMConsumer.InPortSHMConsumer.init ( self,
prop )

設定初期化

InPortConsumerの各種設定を行う プロバイダでコネクタプロファイルに共有メモリの空間名を保存するため、init関数で共有メモリの初期化を行う

引数
self
propコネクタプロパティ

virtual void init(coil.Properties& prop);

OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumerを再実装しています。

◆ put()

OpenRTM_aist.InPortSHMConsumer.InPortSHMConsumer.put ( self,
data )

接続先へのデータ送信

接続先のポートへデータを送信する

データのサイズは共有メモリも先頭8byteから取得する データは共有メモリに書き込む

引数
self
data送信するデータ
戻り値
リターンコード

virtual ReturnCode put(const cdrMemoryStream& data);

OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumerを再実装しています。

◆ setObject()

OpenRTM_aist.InPortSHMConsumer.InPortSHMConsumer.setObject ( self,
obj )

オブジェクトをセットする

ConsumerBase のオーバーライド。CORBA.Object_var にオブジェクトをセット するとともに、パラメータの型で narrow したオブジェクトを保持する。

引数
self
objCORBA Objecct
戻り値
オブジェクト設定結果 設定対象オブジェクトが null の場合は false が返ってくる

OpenRTM_aist.CorbaConsumer.CorbaConsumerを再実装しています。


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