OpenRTM-aist-Python 2.0.2
公開メンバ関数 | 全メンバ一覧
OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector クラス
OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector の継承関係図
OpenRTM_aist.InPortConnector.InPortConnector OpenRTM_aist.ConnectorBase.ConnectorBase OpenRTM_aist.DataPortStatus.DataPortStatus

公開メンバ関数

 __init__ (self, info, provider, listeners, buffer=None)
 
 __del__ (self)
 
 readBuff (self)
 
 read (self, data=None)
 
 disconnect (self)
 
 activate (self)
 
 deactivate (self)
 
 createBuffer (self, profile)
 
 write (self, data)
 
 onConnect (self)
 
 onDisconnect (self)
 
 setConsumer (self, consumer)
 
 deserializeData (self, cdr)
 
 unsubscribeInterface (self, prop)
 
- 基底クラス OpenRTM_aist.InPortConnector.InPortConnector に属する継承公開メンバ関数
 profile (self)
 
 id (self)
 
 name (self)
 
 getBuffer (self)
 
- 基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数
 toString (status)
 

その他の継承メンバ

- 基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承静的公開変数類
int PORT_OK = 0
 brief DataPortStatus リターンコード
 

詳解

 
構築子と解体子



◆ __init__()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.__init__ 
          (
                    self, 
        

        

          
          
                    info, 
        

        

          
          
                    provider, 
        

        

          
          
                    listeners, 
        

        

          
          
                    buffer = None )
        

      







コンストラクタ


引数

  

    
infoConnectorInfo 

    
providerInPortProvider 

    
listenersConnectorListeners 型のリスナオブジェクトリスト 

    
bufferCdrBufferBase 型のバッファ

  

  




@elsek


Constructor


引数

  

    
infoConnectorInfo 

    
providerInPortProvider 

    
listenersConnectorListeners type lsitener object list 

    
bufferCdrBufferBase type buffer

  

  





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








◆ __del__()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.__del__ 
          (
                    self)
          
        

      







デストラクタ


disconnect() が呼ばれ、consumer, publisher, buffer が解体・削除される。



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







メソッド詳解



◆ activate()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.activate 
          (
                    self)
          
        

      







アクティブ化


このコネクタをアクティブ化する


virtual void activate(){}; // do nothing 



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








◆ createBuffer()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.createBuffer 
          (
                    self, 
        

        

          
          
                    profile )
        

      







Bufferの生成


与えられた接続情報に基づきバッファを生成する。


引数

  

    
info接続情報 

  

  




戻り値
バッファへのポインタ


virtual CdrBufferBase* createBuffer(Profile& profile); 








◆ deactivate()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.deactivate 
          (
                    self)
          
        

      







非アクティブ化


このコネクタを非アクティブ化する


virtual void deactivate(){}; // do nothing 



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








◆ deserializeData()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.deserializeData 
          (
                    self, 
        

        

          
          
                    cdr )
        

      







データの復号化 
引数

  

    
self

    
cdr復号化前のデータ 

  

  




戻り値
ret, data ret：リターンコード PORT_OK：正常完了 PRECONDITION_NOT_MET：サポートされていないエンディアン SERIALIZE_ERROR：復号化処理でエラー PRECONDITION_NOT_MET：その他のエラー data：復号化後のデータ  








◆ disconnect()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.disconnect 
          (
                    self)
          
        

      







接続解除


consumer, publisher, buffer が解体・削除される。


戻り値
PORT_OK


virtual ReturnCode disconnect(); 



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








◆ onConnect()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.onConnect 
          (
                    self)
          
        

      







接続確立時にコールバックを呼ぶ  void onConnect() 








◆ onDisconnect()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.onDisconnect 
          (
                    self)
          
        

      







接続切断時にコールバックを呼ぶ  void onDisconnect() 








◆ read()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.read 
          (
                    self, 
        

        

          
          
                    data = None )
        

      







データの読み出し


バッファからデータを読み出す。正常に読み出せた場合、戻り値は PORT_OK となり、data に読み出されたデータが格納される。それ以外 の場合には、エラー値として BUFFER_EMPTY, TIMEOUT, PRECONDITION_NOT_MET, PORT_ERROR が返される。


戻り値
PORT_OK 正常終了 BUFFER_EMPTY バッファは空である TIMEOUT タイムアウトした PRECONDITION_NOT_MET 事前条件を満たさない PORT_ERROR その他のエラー


virtual ReturnCode read(cdrMemoryStream& data); 



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








◆ readBuff()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.readBuff 
          (
                    self)
          
        

      







バッファからデータを読み出す。 read関数と違い、アンマーシャリングを実行しない


引数

  

    
self

  

  




戻り値
リターンコード


引数

  

    
self

  

  




戻り値








◆ setConsumer()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.setConsumer 
          (
                    self, 
        

        

          
          
                    consumer )
        

      







コンシューマの設定  



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








◆ unsubscribeInterface()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.unsubscribeInterface 
          (
                    self, 
        

        

          
          
                    prop )
        

      







コンシューマのインターフェースの登録を取り消す 
引数

  

    
propコネクタプロファイルのプロパティ  

  

  





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








◆ write()






      

        

          OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.write 
          (
                    self, 
        

        

          
          
                    data )
        

      







データの書き出し


バッファにデータを書き出す。正常に書き出せた場合、戻り値は BUFFER_OK となる。それ以外の場合には、エラー値として BUFFER_FULL,TIMEOUT PRECONDITION_NOT_MET, BUFFER_ERROR が返される。


戻り値
BUFFER_OK 正常終了 BUFFER_FULL バッファはいっぱいである TIMEOUT タイムアウトした PRECONDITION_NOT_MET 事前条件を満たさない BUFFER_ERROR その他のエラー


ReturnCode write(const OpenRTM.CdrData& data); 



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







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





構築: doxygen 1.11.0