OutPortDSProvider

java.lang.Object
- org.omg.PortableServer.Servant
- - RTC.DataPullServicePOA
  - - jp.go.aist.rtm.RTC.port.OutPortDSProvider

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

ObjectCreator<OutPortProvider>, ObjectDestructor, OutPortProvider, org.omg.CORBA.portable.InvokeHandler, DataPullServiceOperations
```
public class OutPortDSProvider
extends DataPullServicePOA
implements OutPortProvider, ObjectCreator<OutPortProvider>, ObjectDestructor
```
OutPortDSProvider クラス
データ転送に CORBA の RTC::DataPullServicey インターフェースを利用した、pull 型データフロー型を実現する OutPort プロバイダクラス。

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

protected NVListHolder m_properties
接続プロフィールを保持するメンバ変数です。

フィールド
修飾子とタイプ	フィールドと説明
`protected NVListHolder`	`m_properties` 接続プロフィールを保持するメンバ変数です。

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

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

OutPortDSProvider()
コンストラクタ

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

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`DataPullService`	`_this()` 当該OpenRTM.PortSharedMemoryのCORBAオブジェクト参照を取得する。
`void`	`close_memory()`
`void`	`close_memory(boolean unlink)` マッピングした共有メモリをアンマップする
`protected PortStatus`	`convertReturn(ReturnCode status)` ReturnCodeをPortStatusに変換する。
`OutPortProvider`	`creator_()` OutPortDSProvider を生成する
`void`	`destructor_(java.lang.Object obj)` OutPortDSProvider を破棄する
`PortStatus`	`get(CdrDataHolder data)` [CORBA interface] バッファからデータを取得する設定された内部バッファからデータを取得する。
`void`	`init(Properties prop)` 設定初期化 {@.ja OutPortDSProvider の各種設定を行う。
`static void`	`OutPortDSProviderInit()` モジュール初期化関数 OutPortDSProvider のファクトリを登録する初期化関数。
`boolean`	`publishInterface(NVListHolder properties)` Interface情報を公開する {@.ja Interface情報を公開する。
`void`	`publishInterfaceProfile(NVListHolder properties)` InterfaceProfile情報を公開する {@.ja InterfaceProfile情報を公開する。
`PortStatus`	`pull(OctetSeqHolder data)`
`PortStatus`	`put()` データの送信を知らせる
`void`	`setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)` バッファをセットする {@.ja OutPortProvider がデータを取り出すバッファをセットする。
`void`	`setConnector(OutPortConnector connector)` Connectorを設定する。
`protected void`	`setDataFlowType(java.lang.String dataFlowType)` インタフェースプロフィールのデータフロータイプを設定する。
`protected void`	`setDataType(java.lang.String dataType)` インタフェースプロフィールのデータタイプを設定する。
`protected void`	`setInterfaceType(java.lang.String interfaceType)` インタフェースプロフィールのインタフェースタイプを設定する。
`void`	`setListener(ConnectorBase.ConnectorInfo info, ConnectorListeners listeners)` リスナを設定する。
`protected void`	`setPortType(java.lang.String portType)` インタフェースプロフィールのポートタイプを設定する。
`protected void`	`setSubscriptionType(java.lang.String subscriptionType)` インタフェースプロフィールのサブスクリプションタイプを設定する。

クラスから継承されたメソッド RTC.DataPullServicePOA
_all_interfaces, _invoke, _this

クラスから継承されたメソッド org.omg.PortableServer.Servant
_default_POA, _get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object

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

- フィールドの詳細
  - m_properties
```
protected NVListHolder m_properties
```
    接続プロフィールを保持するメンバ変数です。
- コンストラクタの詳細
  - OutPortDSProvider
```
public OutPortDSProvider()
```
    コンストラクタ
- メソッドの詳細
  - _this
```
public DataPullService _this()
```
    当該OpenRTM.PortSharedMemoryのCORBAオブジェクト参照を取得する。
    
    オーバーライド:
    
    _this クラス内 DataPullServicePOA
    
    戻り値:
    
    当該PortのCORBAオブジェクト参照
  - init
```
public void init(Properties prop)
```
    設定初期化
    OutPortDSProvider の各種設定を行う。与えられた Propertiesから必要な情報を取得して各種設定を行う。この init() 関数は、OutPortProvider生成直後および、接続時にそれぞれ呼ばれる可能性がある。したがって、この関数は複数回呼ばれることを想定して記述されるべきである。
    
    定義:
    
    init インタフェース内 OutPortProvider
    
    パラメータ:
    
    prop - 設定情報
  - setBuffer
```
public void setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
```
    バッファをセットする
    OutPortProvider がデータを取り出すバッファをセットする。すでにセットされたバッファがある場合、以前のバッファへのポインタに対して上書きされる。 OutPortProviderはバッファの所有権を仮定していないので、バッファの削除はユーザの責任で行わなければならない。
    
    定義:
    
    setBuffer インタフェース内 OutPortProvider
    
    パラメータ:
    
    buffer - OutPortProviderがデータを取り出すバッファへのポインタ
  - get
```
public PortStatus get(CdrDataHolder data)
```
    [CORBA interface] バッファからデータを取得する
    設定された内部バッファからデータを取得する。
    
    パラメータ:
    
    data - 取得データを格納するバッファ
    
    戻り値:
    
    ステータス
  - pull
```
public PortStatus pull(OctetSeqHolder data)
```
    定義:
    
    pull インタフェース内 DataPullServiceOperations
  - convertReturn
```
protected PortStatus convertReturn(ReturnCode status)
```
    ReturnCodeをPortStatusに変換する。
    
    パラメータ:
    
    status - ReturnCode
    
    戻り値:
    
    PortStatus
  - creator_
```
public OutPortProvider creator_()
```
    OutPortDSProvider を生成する
    
    定義:
    
    creator_ インタフェース内 ObjectCreator<OutPortProvider>
    
    戻り値:
    
    生成されたOutPortProvider
  - destructor_
```
public void destructor_(java.lang.Object obj)
```
    OutPortDSProvider を破棄する
    
    定義:
    
    destructor_ インタフェース内 ObjectDestructor
    
    パラメータ:
    
    obj - 破棄するインタスタンス
  - OutPortDSProviderInit
```
public static void OutPortDSProviderInit()
```
    モジュール初期化関数
    OutPortDSProvider のファクトリを登録する初期化関数。
  - publishInterfaceProfile
```
public void publishInterfaceProfile(NVListHolder properties)
```
    InterfaceProfile情報を公開する
    InterfaceProfile情報を公開する。引数で指定するプロパティ情報内の NameValue オブジェクトの dataport.interface_type 値を調べ、当該ポートに設定されているインターフェースタイプと一致する場合のみ情報を取得する。
    
    定義:
    
    publishInterfaceProfile インタフェース内 OutPortProvider
    
    パラメータ:
    
    properties - InterfaceProfile情報を受け取るプロパティ
  - publishInterface
```
public boolean publishInterface(NVListHolder properties)
```
    Interface情報を公開する
    Interface情報を公開する。引数で指定するプロパティ情報内の NameValue オブジェクトのdataport.interface_type 値を調べ、当該ポートに設定されていなければNameValue に情報を追加する。すでに同一インターフェースが登録済みの場合は何も行わない。
    
    定義:
    
    publishInterface インタフェース内 OutPortProvider
    
    パラメータ:
    
    properties - Interface情報を受け取るプロパティ
    
    戻り値:
    
    true: 正常終了
  - setConnector
```
public void setConnector(OutPortConnector connector)
```
    Connectorを設定する。
    OutPort は接続確立時に OutPortConnector オブジェクトを生成し、生成したオブジェクトのポインタと共にこの関数を呼び出す。所有権は OutPort が保持するので OutPortProvider は OutPortConnector を削除してはいけない。
    
    定義:
    
    setConnector インタフェース内 OutPortProvider
    
    パラメータ:
    
    connector - OutPortConnector
  - setPortType
```
protected void setPortType(java.lang.String portType)
```
    インタフェースプロフィールのポートタイプを設定する。
    
    パラメータ:
    
    portType - ポートタイプ
  - setDataType
```
protected void setDataType(java.lang.String dataType)
```
    インタフェースプロフィールのデータタイプを設定する。
    
    パラメータ:
    
    dataType - データタイプ
  - setInterfaceType
```
protected void setInterfaceType(java.lang.String interfaceType)
```
    インタフェースプロフィールのインタフェースタイプを設定する。
    
    パラメータ:
    
    interfaceType - インタフェースタイプ
  - setDataFlowType
```
protected void setDataFlowType(java.lang.String dataFlowType)
```
    インタフェースプロフィールのデータフロータイプを設定する。
    
    パラメータ:
    
    dataFlowType - データフロータイプ
  - setSubscriptionType
```
protected void setSubscriptionType(java.lang.String subscriptionType)
```
    インタフェースプロフィールのサブスクリプションタイプを設定する。
    
    パラメータ:
    
    subscriptionType - サブスクリプションタイプ
  - setListener
```
public void setListener(ConnectorBase.ConnectorInfo info,
                        ConnectorListeners listeners)
```
    リスナを設定する。
    OutPort はデータ送信処理における各種イベントに対して特定のリスナオブジェクトをコールするコールバック機構を提供する。詳細は ConnectorListener.h の ConnectorDataListener, ConnectorListener 等を参照のこと。OutPortDSProvider では、以下のコールバックが提供される。
    1. - ON_BUFFER_READ
    2. - ON_SEND
    3. - ON_BUFFER_EMPTY
    4. - ON_BUFFER_READ_TIMEOUT
    5. - ON_SENDER_EMPTY
    6. - ON_SENDER_TIMEOUT
    7. - ON_SENDER_ERROR
    定義:
    
    setListener インタフェース内 OutPortProvider
    
    パラメータ:
    
    info - 接続情報
    
    listeners - リスナオブジェクト
  - close_memory
```
public void close_memory(boolean unlink)
```
    マッピングした共有メモリをアンマップする
    
    パラメータ:
    
    unlink - Linuxで/dev/shm以下に作成したファイルを削除する場合にTrueにする # void close_memory(boolean unlink);
  - close_memory
```
public void close_memory()
```
  - put
```
public PortStatus put()
```
    データの送信を知らせる

クラス OutPortDSProvider

フィールドのサマリー

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

メソッドのサマリー

クラスから継承されたメソッド RTC.DataPullServicePOA

クラスから継承されたメソッド org.omg.PortableServer.Servant

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

フィールドの詳細

m_properties

コンストラクタの詳細

OutPortDSProvider

メソッドの詳細

_this

init

setBuffer

get

pull

convertReturn

creator_

destructor_

OutPortDSProviderInit

publishInterfaceProfile

publishInterface

setConnector

setPortType

setDataType

setInterfaceType

setDataFlowType

setSubscriptionType

setListener

close_memory

close_memory

put