InPortSHMProvider

java.lang.Object
- org.omg.PortableServer.Servant
- - OpenRTM.PortSharedMemoryPOA
  - - jp.go.aist.rtm.RTC.port.SharedMemory
    - - jp.go.aist.rtm.RTC.port.InPortSHMProvider

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

ObjectCreator<InPortProvider>, ObjectDestructor, InPortProvider, PortSharedMemoryOperations, org.omg.CORBA.portable.InvokeHandler
```
public class InPortSHMProvider
extends SharedMemory
implements InPortProvider, ObjectCreator<InPortProvider>, ObjectDestructor
```
InPortSHMProvider クラス
データ転送に CORBA の OpenRTM::PortSharedMemory インターフェースを利用した、push 型データフロー型を実現する InPort プロバイダクラス。

フィールドのサマリー

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

protected NVListHolder m_properties
インタフェース情報を保持するオブジェクトです。
- クラスから継承されたフィールド jp.go.aist.rtm.RTC.port.SharedMemory
  m_endian

フィールド
修飾子とタイプ	フィールドと説明
`protected NVListHolder`	`m_properties` インタフェース情報を保持するオブジェクトです。

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

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

InPortSHMProvider()
コンストラクタ

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

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`PortSharedMemory`	`_this()` 当該OpenRTM.PortSharedMemoryのCORBAオブジェクト参照を取得する。
`void`	`close_memory()`
`void`	`close_memory(boolean unlink)` マッピングした共有メモリをアンマップする
`protected PortStatus`	`convertReturn(ReturnCode status, EncapsOutputStreamExt data)` リターンコード変換 {p.en Return codes conversion}
`void`	`create_memory(int memory_size, java.lang.String shm_address)` 共有メモリの初期化 {@.en Initializes a shared memory
`InPortProvider`	`creator_()` InPortSHMProvider を生成する
`void`	`destructor_(java.lang.Object obj)` InPortSHMProvider を破棄する
`PortStatus`	`get()` データの送信を要求する
`void`	`init(Properties prop)` 設定初期化 {@.ja InPortSHMProvider の各種設定を行う。
`static void`	`InPortSHMProviderInit()` モジュール初期化関数 InPortSHMConsumer のファクトリを登録する初期化関数。
`boolean`	`publishInterface(NVListHolder properties)` Interface情報を公開する {@.ja Interface情報を公開する。
`void`	`publishInterfaceProfile(NVListHolder properties)` InterfaceProfile情報を公開する {@.ja InterfaceProfile情報を公開する。
`PortStatus`	`put()` データの送信を知らせる
`PortStatus`	`put(byte[] data)` [CORBA interface] バッファにデータを書き込む設定されたバッファにデータを書き込む。
`void`	`setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)` バッファをセットする {@.ja OutPortProvider がデータを取り出すバッファをセットする。
`void`	`setConnector(InPortConnector connector)` Connectorを設定する。
`protected void`	`setDataFlowType(java.lang.String dataflowType)` インタフェースプロフィールのデータフロータイプを設定する。
`protected void`	`setDataType(java.lang.String dataType)` インタフェースプロフィールのデータタイプを設定する。
`void`	`setInterface(PortSharedMemory sm)` 通信先のCORBAインターフェースを登録する
`protected void`	`setInterfaceType(java.lang.String interfaceType)` インタフェースプロフィールのインタフェースタイプを設定する。
`void`	`setListener(ConnectorBase.ConnectorInfo info, ConnectorListeners listeners)` リスナを設定する。
`protected void`	`setSubscriptionType(java.lang.String subscriptionType)` インタフェースプロフィールのサブスクリプションタイプを設定する。

クラスから継承されたメソッド jp.go.aist.rtm.RTC.port.SharedMemory
create_memory, open_memory, read, setEndian, string_to_MemorySize, write

クラスから継承されたメソッド OpenRTM.PortSharedMemoryPOA
_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
```
    インタフェース情報を保持するオブジェクトです。
- コンストラクタの詳細
  - InPortSHMProvider
```
public InPortSHMProvider()
```
    コンストラクタ
- メソッドの詳細
  - _this
```
public PortSharedMemory _this()
```
    当該OpenRTM.PortSharedMemoryのCORBAオブジェクト参照を取得する。
    
    オーバーライド:
    
    _this クラス内 PortSharedMemoryPOA
    
    戻り値:
    
    当該PortのCORBAオブジェクト参照
  - init
```
public void init(Properties prop)
```
    設定初期化
    InPortSHMProvider の各種設定を行う。与えられた Propertiesから必要な情報を取得して各種設定を行う。この init() 関数は、InPortProvider生成直後および、接続時にそれぞれ呼ばれる可能性がある。したがって、この関数は複数回呼ばれることを想定して記述されるべきである。
    
    定義:
    
    init インタフェース内 InPortProvider
    
    パラメータ:
    
    prop - 設定情報
  - setBuffer
```
public void setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
```
    バッファをセットする
    OutPortProvider がデータを取り出すバッファをセットする。すでにセットされたバッファがある場合、以前のバッファへのポインタに対して上書きされる。 OutPortProviderはバッファの所有権を仮定していないので、バッファの削除はユーザの責任で行わなければならない。
    
    定義:
    
    setBuffer インタフェース内 InPortProvider
    
    パラメータ:
    
    buffer - OutPortProviderがデータを取り出すバッファへのポインタ
  - put
```
public PortStatus put(byte[] data)
               throws org.omg.CORBA.SystemException
```
    [CORBA interface] バッファにデータを書き込む
    設定されたバッファにデータを書き込む。
    
    パラメータ:
    
    data - 書込対象データ
    
    例外:
    
    org.omg.CORBA.SystemException
  - convertReturn
```
protected PortStatus convertReturn(ReturnCode status,
                                   EncapsOutputStreamExt data)
```
    リターンコード変換 {p.en Return codes conversion}
    
    パラメータ:
    
    status - ReturnCode
    
    戻り値:
    
    PortStatus
  - creator_
```
public InPortProvider creator_()
```
    InPortSHMProvider を生成する
    
    定義:
    
    creator_ インタフェース内 ObjectCreator<InPortProvider>
    
    戻り値:
    
    生成されたInPortProvider
  - destructor_
```
public void destructor_(java.lang.Object obj)
```
    InPortSHMProvider を破棄する
    
    定義:
    
    destructor_ インタフェース内 ObjectDestructor
    
    パラメータ:
    
    obj - 破棄するインタスタンス
  - InPortSHMProviderInit
```
public static void InPortSHMProviderInit()
```
    モジュール初期化関数
    InPortSHMConsumer のファクトリを登録する初期化関数。
  - publishInterfaceProfile
```
public void publishInterfaceProfile(NVListHolder properties)
```
    InterfaceProfile情報を公開する
    InterfaceProfile情報を公開する。引数で指定するプロパティ情報内の NameValue オブジェクトの dataport.interface_type 値を調べ、当該ポートに設定されているインターフェースタイプと一致する場合のみ情報を取得する。
    
    定義:
    
    publishInterfaceProfile インタフェース内 InPortProvider
    
    パラメータ:
    
    properties - InterfaceProfile情報を受け取るホルダオブジェクト
  - publishInterface
```
public boolean publishInterface(NVListHolder properties)
```
    Interface情報を公開する
    Interface情報を公開する。引数で指定するプロパティ情報内の NameValue オブジェクトのdataport.interface_type 値を調べ、当該ポートに設定されていなければNameValue に情報を追加する。すでに同一インターフェースが登録済みの場合は何も行わない。
    
    定義:
    
    publishInterface インタフェース内 InPortProvider
    
    パラメータ:
    
    properties - properties Interface情報を受け取るホルダオブジェクト
    
    戻り値:
    
    true: 正常終了
  - setListener
```
public void setListener(ConnectorBase.ConnectorInfo info,
                        ConnectorListeners listeners)
```
    リスナを設定する。
    InPort はデータ送信処理における各種イベントに対して特定のリスナオブジェクトをコールするコールバック機構を提供する。詳細は ConnectorListener.h の ConnectorDataListener, ConnectorListener 等を参照のこと。InPortSHMProvider では、以下のコールバックが提供される。
    - - ON_BUFFER_WRITE
    - - ON_BUFFER_FULL
    - - ON_BUFFER_WRITE_TIMEOUT
    - - ON_BUFFER_OVERWRITE
    - - ON_RECEIVED
    - - ON_RECEIVER_FULL
    - - ON_RECEIVER_FULL
    - - ON_RECEIVER_TIMEOUT
    - - ON_RECEIVER_ERROR
    定義:
    
    setListener インタフェース内 InPortProvider
    
    パラメータ:
    
    info - 接続情報
    
    listeners - リスナオブジェクト
  - setConnector
```
public void setConnector(InPortConnector connector)
```
    Connectorを設定する。
    InPort は接続確立時に InPortConnector オブジェクトを生成し、生成したオブジェクトのポインタと共にこの関数を呼び出す。所有権は InPort が保持するので InPortProvider は InPortConnector を削除してはいけない。
    
    定義:
    
    setConnector インタフェース内 InPortProvider
    
    パラメータ:
    
    connector - InPortConnector
  - 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 - サブスクリプションタイプ
  - create_memory
```
public void create_memory(int memory_size,
                          java.lang.String shm_address)
```
    共有メモリの初期化 # windowsではページングファイル上に領域を確保する # Linuxでは/dev/shm以下にファイルを作成する # 作成したファイルの内容を仮想アドレスにマッピングする
    
    パラメータ:
    
    memory_size - 共有メモリのサイズ
    
    shm_address - 空間名 # void create_memory(int memory_size, string shm_address);
  - close_memory
```
public void close_memory(boolean unlink)
```
    マッピングした共有メモリをアンマップする
    
    定義:
    
    close_memory インタフェース内 PortSharedMemoryOperations
    
    オーバーライド:
    
    close_memory クラス内 SharedMemory
    
    パラメータ:
    
    unlink - Linuxで/dev/shm以下に作成したファイルを削除する場合にTrueにする # void close_memory(boolean unlink);
  - close_memory
```
public void close_memory()
```
    オーバーライド:
    
    close_memory クラス内 SharedMemory
  - setInterface
```
public void setInterface(PortSharedMemory sm)
```
    通信先のCORBAインターフェースを登録する
    登録する事により共有メモリの初期化したときに、通信先でもマッピングをやり直すことができる
    
    定義:
    
    setInterface インタフェース内 PortSharedMemoryOperations
    
    オーバーライド:
    
    setInterface クラス内 SharedMemory
    
    パラメータ:
    
    sm - SharedMemoryのオブジェクトリファレンス
  - get
```
public PortStatus get()
```
    データの送信を要求する
    
    定義:
    
    get インタフェース内 PortSharedMemoryOperations
    
    オーバーライド:
    
    get クラス内 SharedMemory
  - put
```
public PortStatus put()
```
    データの送信を知らせる
    
    定義:
    
    put インタフェース内 PortSharedMemoryOperations
    
    オーバーライド:
    
    put クラス内 SharedMemory

クラス InPortSHMProvider

フィールドのサマリー

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

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

メソッドのサマリー

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

クラスから継承されたメソッド OpenRTM.PortSharedMemoryPOA

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

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

フィールドの詳細

m_properties

コンストラクタの詳細

InPortSHMProvider

メソッドの詳細

_this

init

setBuffer

put

convertReturn

creator_

destructor_

InPortSHMProviderInit

publishInterfaceProfile

publishInterface

setListener

setConnector

setDataType

setInterfaceType

setDataFlowType

setSubscriptionType

create_memory

close_memory

close_memory

setInterface

get

put