OutPortDirectConsumer

java.lang.Object
- jp.go.aist.rtm.RTC.port.OutPortDirectConsumer

すべての実装されたインタフェース:

ObjectCreator<OutPortConsumer>, ObjectDestructor, OutPortConsumer
```
public class OutPortDirectConsumer
extends java.lang.Object
implements OutPortConsumer, ObjectCreator<OutPortConsumer>, ObjectDestructor
```
OutPortDirectConsumer クラス
データ転送に CORBA の OpenRTM::OutPortCdr インターフェースを利用した、push 型データフロー型を実現する OutPort コンシューマクラス。

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

OutPortDirectConsumer()
コンストラクタ

コンストラクタ
コンストラクタと説明
`OutPortDirectConsumer()` コンストラクタ

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected ReturnCode`	`convertReturn(PortStatus status)` PortStatusをReturnCodeに変換する。
`OutPortConsumer`	`creator_()` OutPortDirectConsumer を生成する
`void`	`destructor_(java.lang.Object obj)` Object を破棄する
`ReturnCode`	`get(org.omg.CORBA.portable.OutputStream data)` Pure virtual function to receive data.
`void`	`init(Properties prop)` 設定初期化 {@.ja OutPortConsumerの各種設定を行う。
`static void`	`OutPortDirectConsumerInit()` モジュール初期化関数 OutPortDirectConsumer のファクトリを登録する初期化関数。
`void`	`publishInterfaceProfile(NVListHolder properties)` InterfaceProfile情報を公開する {@.ja InterfaceProfile情報を公開する。
`ReturnCode`	`put(org.omg.CORBA.portable.OutputStream data)` 接続先へのデータ送信 {@.ja 接続先のポートへデータを送信するための純粋仮想関数。
`void`	`setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)` Setting outside buffer's pointer A pointer to a buffer from which OutPortProvider retrieve data.
`void`	`setConnector(InPortConnector connector)` Connectorを設定する。
`void`	`setListener(ConnectorBase.ConnectorInfo info, ConnectorListeners listeners)`
`boolean`	`subscribeInterface(NVListHolder properties)` データ送信通知への登録指定されたプロパティに基づいて、データ送出通知の受け取りに登録する。
`void`	`unsubscribeInterface(NVListHolder properties)` データ送信通知からの登録解除データ送出通知の受け取りから登録を解除する。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - OutPortDirectConsumer
```
public OutPortDirectConsumer()
```
    コンストラクタ
- メソッドの詳細
  - init
```
public void init(Properties prop)
```
    設定初期化
    OutPortConsumerの各種設定を行う。実装クラスでは、与えられた Propertiesから必要な情報を取得して各種設定を行う。この init() 関数は、OutPortProvider生成直後および、接続時にそれぞれ呼ばれる可能性がある。したがって、この関数は複数回呼ばれることを想定して記述されるべきである。
    
    定義:
    
    init インタフェース内 OutPortConsumer
    
    パラメータ:
    
    prop - 設定情報
  - put
```
public ReturnCode put(org.omg.CORBA.portable.OutputStream data)
```
    接続先へのデータ送信
    接続先のポートへデータを送信するための純粋仮想関数。この関数は、以下のリターンコードを返す。
    - - PORT_OK: 正常終了。
    - - PORT_ERROR: データ送信の過程で何らかのエラーが発生した。
    - - SEND_FULL: データを送信したが、相手側バッファがフルだった。
    - - SEND_TIMEOUT:データを送信したが、相手側バッファがタイムアウトした。
    - - UNKNOWN_ERROR:原因不明のエラー
    パラメータ:
    
    data - 送信するデータ
    
    戻り値:
    
    リターンコード
  - publishInterfaceProfile
```
public void publishInterfaceProfile(NVListHolder properties)
```
    InterfaceProfile情報を公開する
    InterfaceProfile情報を公開する。引数で指定するプロパティ情報内の NameValue オブジェクトの dataport.interface_type 値を調べ、当該ポートに設定されているインターフェースタイプと一致する場合のみ情報を取得する。
    
    パラメータ:
    
    properties - InterfaceProfile情報を受け取るプロパティ
  - subscribeInterface
```
public boolean subscribeInterface(NVListHolder properties)
```
    データ送信通知への登録
    指定されたプロパティに基づいて、データ送出通知の受け取りに登録する。
    
    定義:
    
    subscribeInterface インタフェース内 OutPortConsumer
    
    パラメータ:
    
    properties - 登録情報
    
    戻り値:
    
    登録処理結果(登録成功:true、登録失敗:false)
  - unsubscribeInterface
```
public void unsubscribeInterface(NVListHolder properties)
```
    データ送信通知からの登録解除
    データ送出通知の受け取りから登録を解除する。
    
    定義:
    
    unsubscribeInterface インタフェース内 OutPortConsumer
    
    パラメータ:
    
    properties - 登録解除情報
  - convertReturn
```
protected ReturnCode convertReturn(PortStatus status)
```
    PortStatusをReturnCodeに変換する。
    
    パラメータ:
    
    status - PortStatus
    
    戻り値:
    
    ReturnCode
  - creator_
```
public OutPortConsumer creator_()
```
    OutPortDirectConsumer を生成する
    
    定義:
    
    creator_ インタフェース内 ObjectCreator<OutPortConsumer>
    
    戻り値:
    
    生成されたOutPortConsumer
  - destructor_
```
public void destructor_(java.lang.Object obj)
```
    Object を破棄する
    
    定義:
    
    destructor_ インタフェース内 ObjectDestructor
    
    パラメータ:
    
    obj - 破棄するインタスタンス
  - OutPortDirectConsumerInit
```
public static void OutPortDirectConsumerInit()
```
    モジュール初期化関数
    OutPortDirectConsumer のファクトリを登録する初期化関数。
  - setConnector
```
public void setConnector(InPortConnector connector)
```
    Connectorを設定する。
    
    定義:
    
    setConnector インタフェース内 OutPortConsumer
    
    パラメータ:
    
    connector - InPortConnector
  - setListener
```
public void setListener(ConnectorBase.ConnectorInfo info,
                        ConnectorListeners listeners)
```
    定義:
    
    setListener インタフェース内 OutPortConsumer
  - get
```
public ReturnCode get(org.omg.CORBA.portable.OutputStream data)
```
    インタフェースからコピーされた説明: OutPortConsumer
    
    Pure virtual function to receive data.
    
    定義:
    
    get インタフェース内 OutPortConsumer
    
    戻り値:
    
    PORT_OK BUFFER_TIMEOUT RECV_EMPTY CONNECTION_LOST PORT_ERROR UNKNOWN_ERROR
  - setBuffer
```
public void setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
```
    インタフェースからコピーされた説明: OutPortConsumer
    
    Setting outside buffer's pointer
    
    A pointer to a buffer from which OutPortProvider retrieve data. If already buffer is set, previous buffer's pointer will be overwritten by the given pointer to a buffer. Since OutPortProvider does not assume ownership of the buffer pointer, destructor of the buffer should be done by user.
    
    定義:
    
    setBuffer インタフェース内 OutPortConsumer
    
    パラメータ:
    
    buffer - A pointer to a data buffer to be used by OutPortProvider

クラス OutPortDirectConsumer

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

OutPortDirectConsumer

メソッドの詳細

init

put

publishInterfaceProfile

subscribeInterface

unsubscribeInterface

convertReturn

creator_

destructor_

OutPortDirectConsumerInit

setConnector

setListener

get

setBuffer