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

[詳解]

OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer の継承関係図
OpenRTM_aist.OutPortConsumer.OutPortConsumer OpenRTM_aist.CorbaConsumer.CorbaConsumer OpenRTM_aist.DataPortStatus.DataPortStatus OpenRTM_aist.CorbaConsumer.CorbaConsumerBase OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer OpenRTM_aist.OutPortSHMConsumer.OutPortSHMConsumer

公開メンバ関数

 __init__ (self)
 
 __del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer)
 
 init (self, prop)
 
 setBuffer (self, buffer)
 
 get (self)
 
 subscribeInterface (self, properties)
 
 unsubscribeInterface (self, properties)
 
 convertReturn (self, status, data)
 
 onBufferWrite (self, data)
 Connector data listener functions
 
 onSenderEmpty (self)
 Connector listener functions
 
- 基底クラス 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)
 

詳解

OutPortCorbaCdrConsumer クラス


通信手段に CORBA を利用した出力ポートコンシューマの実装クラス。


引数

  

    
DataType本ポートにて扱うデータ型

  

  




から
1.0.0


構築子と解体子



◆ __init__()






      

        

          OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.__init__ 
          (
                    self)
          
        

      







コンストラクタ


コンストラクタ


引数

  

    
buffer本ポートに割り当てるバッファ

  

  





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



OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer, OpenRTM_aist.OutPortSHMConsumer.OutPortSHMConsumerで再実装されています。








◆ __del__()






      

        

          OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.__del__ 
          (
                    self, 
        

        

          
          
                    CorbaConsumer = OpenRTM_aist.CorbaConsumer )
        

      







デストラクタ


デストラクタ



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



OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer, OpenRTM_aist.OutPortSHMConsumer.OutPortSHMConsumerで再実装されています。







メソッド詳解



◆ convertReturn()






      

        

          OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.convertReturn 
          (
                    self, 
        

        

          
          
                    status, 
        

        

          
          
                    data )
        

      







リターンコード変換 (DataPortStatus -> BufferStatus) 


ReturnCode convertReturn(.OpenRTM.PortStatus status,
                          const cdrMemoryStream& data) 








◆ get()






      

        

          OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.get 
          (
                    self)
          
        

      







データを読み出す


設定されたデータを読み出す。


引数

  

    
data読み出したデータを受け取るオブジェクト

  

  




戻り値
データ読み出し処理結果(読み出し成功:true、読み出し失敗:false)


virtual ReturnCode get(cdrMemoryStream& data); 



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



OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer, OpenRTM_aist.OutPortSHMConsumer.OutPortSHMConsumerで再実装されています。








◆ init()






      

        

          OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.init 
          (
                    self, 
        

        

          
          
                    prop )
        

      







設定初期化


OutPortConsumerの各種設定を行う。実装クラスでは、与えられた Propertiesから必要な情報を取得して各種設定を行う。この init() 関 数は、OutPortProvider生成直後および、接続時にそれぞれ呼ばれる可 能性がある。したがって、この関数は複数回呼ばれることを想定して記 述されるべきである。


引数

  

    
prop設定情報

  

  




virtual void init(coil.Properties& prop); 



OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer, OpenRTM_aist.OutPortSHMConsumer.OutPortSHMConsumerで再実装されています。








◆ onBufferWrite()






      

        

          OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.onBufferWrite 
          (
                    self, 
        

        

          
          
                    data )
        

      





Connector data listener functions 


inline void onBufferWrite(const cdrMemoryStream& data) 








◆ onSenderEmpty()






      

        

          OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.onSenderEmpty 
          (
                    self)
          
        

      





Connector listener functions 


inline void onSenderEmpty() 








◆ setBuffer()






      

        

          OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.setBuffer 
          (
                    self, 
        

        

          
          
                    buffer )
        

      







バッファをセットする


OutPortConsumerがデータを取り出すバッファをセットする。 すでにセットされたバッファがある場合、以前のバッファへの ポインタに対して上書きされる。 OutPortProviderはバッファの所有権を仮定していないので、 バッファの削除はユーザの責任で行わなければならない。


引数

  

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

  

  




virtual void setBuffer(CdrBufferBase* buffer); 



OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumerで再実装されています。








◆ subscribeInterface()






      

        

          OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.subscribeInterface 
          (
                    self, 
        

        

          
          
                    properties )
        

      







データ受信通知への登録


指定されたプロパティに基づいて、データ受信通知の受け取りに登録する。


引数

  

    
properties登録情報

  

  




戻り値
登録処理結果(登録成功:true、登録失敗:false)


virtual bool subscribeInterface(const SDOPackage.NVList& properties); 








◆ unsubscribeInterface()






      

        

          OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.unsubscribeInterface 
          (
                    self, 
        

        

          
          
                    properties )
        

      







データ受信通知からの登録解除


データ受信通知の受け取りから登録を解除する。


引数

  

    
properties登録解除情報

  

  




virtual void unsubscribeInterface(const SDOPackage.NVList& properties); 







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





構築: doxygen 1.11.0