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

[詳解]

OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer の継承関係図
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)
 
 setBuffer (self, buffer)
 
 put (self, data)
 
 isWritable (self, retry=False)
 
- 基底クラス 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)
 
 setObject (self, obj)
 
 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)
 

詳解

InPortCSPConsumer クラス

CSPモデルのチャネルを模擬した入力ポートプロバイダーの実装クラス。

構築子と解体子

◆ __init__()

OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer.__init__ ( self)

コンストラクタ

コンストラクタ Interface Typeにはshared_memoryを指定する 共有メモリの空間名はUUIDで作成し、コネクタプロファイルのdataport.shared_memory.addressに保存する

self

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

◆ __del__()

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

デストラクタ

デストラクタ

引数
self

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

メソッド詳解

◆ init()

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

設定初期化

InPortConsumerの各種設定を行う

virtual void init(coil.Properties& prop);

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

◆ isWritable()

OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer.isWritable ( self,
retry = False )

書き込み可能かを接続先のProviderに確認

引数
self
retryTrue:再検索、False:通常の書き込み確認
戻り値
True:書き込み可能、False:書き込み不可

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

◆ put()

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

バッファにデータを書き込む

引数
self
data書込対象データ
戻り値
リターンコード PORT_OK:正常完了 PORT_ERROR:バッファ書き込みエラー、通常は発生しない SEND_FULL:バッファがフル SEND_TIMEOUT:書き込みタイムアウト UNKNOWN_ERROR:その他のエラー CONNECTION_LOST:通信エラー

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

◆ setBuffer()

OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer.setBuffer ( self,
buffer )

バッファをセットする

引数
bufferOutPortProviderがデータを取り出すバッファへのポインタ

virtual void setBuffer(CdrBufferBase* buffer);


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