OutPortDSConsumer

java.lang.Object
- jp.go.aist.rtm.RTC.port.CorbaConsumerBase
- - jp.go.aist.rtm.RTC.port.CorbaConsumer<DataPullService>
  - - jp.go.aist.rtm.RTC.port.OutPortDSConsumer

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

ObjectCreator<OutPortConsumer>, ObjectDestructor, OutPortConsumer
```
public class OutPortDSConsumer
extends CorbaConsumer<DataPullService>
implements OutPortConsumer, ObjectCreator<OutPortConsumer>, ObjectDestructor
```
OutPortDSConsumer クラス
データ転送に CORBA の RTC::DataPullSerivce インターフェースを利用した、pull 型データフロー型を実現する OutPort コンシューマクラス。

フィールドのサマリー
- クラスから継承されたフィールド jp.go.aist.rtm.RTC.port.CorbaConsumer
  m_sev, m_var
- クラスから継承されたフィールド jp.go.aist.rtm.RTC.port.CorbaConsumerBase
  m_objref

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

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

OutPortDSConsumer()
コンストラクタ

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

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected ReturnCode`	`convertReturn(PortStatus status)` リターンコード変換 (DataPortStatus -> BufferStatus)
`OutPortConsumer`	`creator_()` OutPortDSConsumer を生成する
`void`	`destructor_(java.lang.Object obj)` Object を破棄する
`ReturnCode`	`get(org.omg.CORBA.portable.OutputStream data)` データを読み出す設定されたデータを読み出す。
`void`	`init(Properties prop)` 設定初期化 {@.ja OutPortConsumerの各種設定を行う。
`static void`	`OutPortDSConsumerInit()` モジュール初期化関数 OutPortDSConsumer のファクトリを登録する初期化関数。
`ReturnCode`	`pull(org.omg.CORBA.portable.OutputStream data)`
`void`	`setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)` バッファをセットする {@.ja OutPortConsumerがデータを取り出すバッファをセットする。
`void`	`setConnector(InPortConnector connector)` Connectorを設定する。
`void`	`setListener(ConnectorBase.ConnectorInfo info, ConnectorListeners listeners)` リスナを設定する。
`boolean`	`subscribeInterface(NVListHolder properties)` データ受信通知への登録指定されたプロパティに基づいて、データ受信通知の受け取りに登録する。
`void`	`unsubscribeInterface(NVListHolder properties)` データ受信通知からの登録解除データ受信通知の受け取りから登録を解除する。

クラスから継承されたメソッド jp.go.aist.rtm.RTC.port.CorbaConsumer
_ptr, releaseObject, setObject

クラスから継承されたメソッド jp.go.aist.rtm.RTC.port.CorbaConsumerBase
getObject

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

- コンストラクタの詳細
  - OutPortDSConsumer
```
public OutPortDSConsumer()
```
    コンストラクタ
- メソッドの詳細
  - init
```
public void init(Properties prop)
```
    設定初期化
    OutPortConsumerの各種設定を行う。実装クラスでは、与えられた Propertiesから必要な情報を取得して各種設定を行う。この init() 関数は、OutPortProvider生成直後および、接続時にそれぞれ呼ばれる可能性がある。したがって、この関数は複数回呼ばれることを想定して記述されるべきである。
    
    定義:
    
    init インタフェース内 OutPortConsumer
    
    パラメータ:
    
    prop - 設定情報
  - setBuffer
```
public void setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
```
    バッファをセットする
    OutPortConsumerがデータを取り出すバッファをセットする。すでにセットされたバッファがある場合、以前のバッファへのポインタに対して上書きされる。 OutPortProviderはバッファの所有権を仮定していないので、バッファの削除はユーザの責任で行わなければならない。
    
    定義:
    
    setBuffer インタフェース内 OutPortConsumer
    
    パラメータ:
    
    buffer - OutPortProviderがデータを取り出すバッファへのポインタ
  - setListener
```
public void setListener(ConnectorBase.ConnectorInfo info,
                        ConnectorListeners listeners)
```
    リスナを設定する。
    InPort はデータ送信処理における各種イベントに対して特定のリスナオブジェクトをコールするコールバック機構を提供する。詳細は ConnectorListener.h の ConnectorDataListener, ConnectorListener 等を参照のこと。OutPortDSProvider では、以下のコールバックが提供される。
    1. - ON_BUFFER_WRITE
    2. - ON_BUFFER_FULL
    3. - ON_RECEIVED
    4. - ON_RECEIVER_FULL
    5. - ON_SENDER_EMPTY
    6. - ON_SENDER_TIMEOUT
    7. - ON_SENDER_ERROR
    定義:
    
    setListener インタフェース内 OutPortConsumer
    
    パラメータ:
    
    info - 接続情報
    
    listeners - リスナオブジェクト
  - get
```
public ReturnCode get(org.omg.CORBA.portable.OutputStream data)
```
    データを読み出す
    設定されたデータを読み出す。
    
    定義:
    
    get インタフェース内 OutPortConsumer
    
    パラメータ:
    
    data - 読み出したデータを受け取るオブジェクト
    
    戻り値:
    
    データ読み出し処理結果(読み出し成功:true、読み出し失敗:false)
  - pull
```
public ReturnCode pull(org.omg.CORBA.portable.OutputStream data)
```
  - 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)
```
    リターンコード変換 (DataPortStatus -> BufferStatus)
    
    パラメータ:
    
    status - PortStatus
    
    戻り値:
    
    ReturnCode
  - creator_
```
public OutPortConsumer creator_()
```
    OutPortDSConsumer を生成する
    
    定義:
    
    creator_ インタフェース内 ObjectCreator<OutPortConsumer>
    
    戻り値:
    
    生成されたOutPortConsumer
  - destructor_
```
public void destructor_(java.lang.Object obj)
```
    Object を破棄する
    
    定義:
    
    destructor_ インタフェース内 ObjectDestructor
    
    パラメータ:
    
    obj - 破棄するインタスタンス
  - OutPortDSConsumerInit
```
public static void OutPortDSConsumerInit()
```
    モジュール初期化関数
    OutPortDSConsumer のファクトリを登録する初期化関数。
  - setConnector
```
public void setConnector(InPortConnector connector)
```
    Connectorを設定する。
    
    定義:
    
    setConnector インタフェース内 OutPortConsumer
    
    パラメータ:
    
    connector - InPortConnector

クラス OutPortDSConsumer

フィールドのサマリー

クラスから継承されたフィールド jp.go.aist.rtm.RTC.port.CorbaConsumer

クラスから継承されたフィールド jp.go.aist.rtm.RTC.port.CorbaConsumerBase

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

メソッドのサマリー

クラスから継承されたメソッド jp.go.aist.rtm.RTC.port.CorbaConsumer

クラスから継承されたメソッド jp.go.aist.rtm.RTC.port.CorbaConsumerBase

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

コンストラクタの詳細

OutPortDSConsumer

メソッドの詳細

init

setBuffer

setListener

get

pull

subscribeInterface

unsubscribeInterface

convertReturn

creator_

destructor_

OutPortDSConsumerInit

setConnector