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

[詳解]

OpenRTM_aist.InPortDSConsumer.InPortDSConsumer の継承関係図
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)
 
 put (self, data)
 
 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)
 

詳解

InPortDSConsumer クラス


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


引数

  

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

  

  




から
1.2.0


構築子と解体子



◆ __init__()






      

        

          OpenRTM_aist.InPortDSConsumer.InPortDSConsumer.__init__ 
          (
                    self)
          
        

      







コンストラクタ


コンストラクタ


引数

  

    
buffer当該コンシューマに割り当てるバッファオブジェクト

  

  





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








◆ __del__()






      

        

          OpenRTM_aist.InPortDSConsumer.InPortDSConsumer.__del__ 
          (
                    self, 
        

        

          
          
                    CorbaConsumer = OpenRTM_aist.CorbaConsumer )
        

      







デストラクタ


デストラクタ



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







メソッド詳解



◆ convertReturnCode()






      

        

          OpenRTM_aist.InPortDSConsumer.InPortDSConsumer.convertReturnCode 
          (
                    self, 
        

        

          
          
                    ret )
        

      







リターンコード変換 


ReturnCode convertReturnCode(OpenRTM.PortStatus ret) 








◆ init()






      

        

          OpenRTM_aist.InPortDSConsumer.InPortDSConsumer.init 
          (
                    self, 
        

        

          
          
                    prop )
        

      







設定初期化


InPortConsumerの各種設定を行う


virtual void init(coil.Properties& prop); 








◆ publishInterfaceProfile()






      

        

          OpenRTM_aist.InPortDSConsumer.InPortDSConsumer.publishInterfaceProfile 
          (
                    self, 
        

        

          
          
                    properties )
        

      







InterfaceProfile情報を公開する


InterfaceProfile情報を公開する。 引数で指定するプロパティ情報内の NameValue オブジェクトの dataport.interface_type 値を調べ、当該ポートに設定されている インターフェースタイプと一致する場合のみ情報を取得する。


引数

  

    
propertiesInterfaceProfile情報を受け取るプロパティ

  

  




virtual void publishInterfaceProfile(SDOPackage.NVList& properties); 








◆ put()






      

        

          OpenRTM_aist.InPortDSConsumer.InPortDSConsumer.put 
          (
                    self, 
        

        

          
          
                    data )
        

      







接続先へのデータ送信


接続先のポートへデータを送信するための純粋仮想関数。


この関数は、以下のリターンコードを返す。


    

  • PORT_OK: 正常終了。
    • 

  • PORT_ERROR: データ送信の過程で何らかのエラーが発生した。
    • 

  • SEND_FULL: データを送信したが、相手側バッファがフルだった。
    • 

  • SEND_TIMEOUT: データを送信したが、相手側バッファがタイムアウトした。
    • 

  • UNKNOWN_ERROR: 原因不明のエラー
    • 



引数

  

    
data送信するデータ 

  

  




戻り値
リターンコード


virtual ReturnCode put(const cdrMemoryStream& data); 



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








◆ subscribeFromIor()






      

        

          OpenRTM_aist.InPortDSConsumer.InPortDSConsumer.subscribeFromIor 
          (
                    self, 
        

        

          
          
                    properties )
        

      







IOR文字列からオブジェクト参照を取得する


戻り値
true: 正常取得, false: 取得失敗


bool subscribeFromIor(const SDOPackage.NVList& properties); 








◆ subscribeFromRef()






      

        

          OpenRTM_aist.InPortDSConsumer.InPortDSConsumer.subscribeFromRef 
          (
                    self, 
        

        

          
          
                    properties )
        

      







Anyから直接オブジェクト参照を取得する


戻り値
true: 正常取得, false: 取得失敗


bool subscribeFromRef(const SDOPackage.NVList& properties); 








◆ subscribeInterface()






      

        

          OpenRTM_aist.InPortDSConsumer.InPortDSConsumer.subscribeInterface 
          (
                    self, 
        

        

          
          
                    properties )
        

      







データ送信通知への登録


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


引数

  

    
properties登録情報

  

  




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


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








◆ unsubscribeFromIor()






      

        

          OpenRTM_aist.InPortDSConsumer.InPortDSConsumer.unsubscribeFromIor 
          (
                    self, 
        

        

          
          
                    properties )
        

      







接続解除(IOR版)


戻り値
true: 正常取得, false: 取得失敗


bool unsubscribeFromIor(const SDOPackage.NVList& properties); 








◆ unsubscribeFromRef()






      

        

          OpenRTM_aist.InPortDSConsumer.InPortDSConsumer.unsubscribeFromRef 
          (
                    self, 
        

        

          
          
                    properties )
        

      







接続解除(Object reference版)


戻り値
true: 正常取得, false: 取得失敗


bool unsubscribeFromRef(const SDOPackage.NVList& properties); 








◆ unsubscribeInterface()






      

        

          OpenRTM_aist.InPortDSConsumer.InPortDSConsumer.unsubscribeInterface 
          (
                    self, 
        

        

          
          
                    properties )
        

      







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


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


引数

  

    
properties登録解除情報

  

  




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







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





構築: doxygen 1.11.0