概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド

jp.go.aist.rtm.RTC.port
クラス OutPortCorbaCdrConsumer

java.lang.Object
  上位を拡張 jp.go.aist.rtm.RTC.port.CorbaConsumerBase
      上位を拡張 jp.go.aist.rtm.RTC.port.CorbaConsumer<OutPortCdr>
          上位を拡張 jp.go.aist.rtm.RTC.port.OutPortCorbaCdrConsumer
すべての実装されたインタフェース:
ObjectCreator<OutPortConsumer>, ObjectDestructor, OutPortConsumer
public class OutPortCorbaCdrConsumer
extends CorbaConsumer<OutPortCdr>
implements OutPortConsumer, ObjectCreator<OutPortConsumer>, ObjectDestructor

OutPortCorbaCdrConsumer クラス

データ転送に CORBA の OpenRTM::OutPortCdr インターフェースを利用し た、pull 型データフロー型を実現する OutPort コンシューマクラス。

フィールドの概要
 
クラス jp.go.aist.rtm.RTC.port.CorbaConsumer から継承されたフィールド
m_var
 
クラス jp.go.aist.rtm.RTC.port.CorbaConsumerBase から継承されたフィールド
m_objref
 
コンストラクタの概要
OutPortCorbaCdrConsumer()
          コンストラクタ
 
メソッドの概要
protected  ReturnCode convertReturn(PortStatus status)
          リターンコード変換 (DataPortStatus -> BufferStatus)
 OutPortConsumer creator_()
          OutPortCorbaCdrConsumer を生成する
 void destructor_(java.lang.Object obj)
          Object を破棄する
 ReturnCode get(org.omg.CORBA.portable.OutputStream data)
          データを読み出す 設定されたデータを読み出す。
 void init(Properties prop)
          設定初期化 {@.ja OutPortConsumerの各種設定を行う。
static void OutPortCorbaCdrConsumerInit()
          モジュール初期化関数 OutPortCorbaCdrConsumer のファクトリを登録する初期化関数。
 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
 

コンストラクタの詳細

OutPortCorbaCdrConsumer

public OutPortCorbaCdrConsumer()
コンストラクタ

メソッドの詳細

init

public void init(Properties prop)
設定初期化

OutPortConsumerの各種設定を行う。実装クラスでは、与えられた Propertiesから必要な情報を取得して各種設定を行う。この init() 関 数は、OutPortProvider生成直後および、接続時にそれぞれ呼ばれる可 能性がある。したがって、この関数は複数回呼ばれることを想定して記 述されるべきである。

定義:
インタフェース OutPortConsumer 内の init
パラメータ:
prop - 設定情報

setBuffer

public void setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
バッファをセットする

OutPortConsumerがデータを取り出すバッファをセットする。 すでにセットされたバッファがある場合、以前のバッファへの ポインタに対して上書きされる。 OutPortProviderはバッファの所有権を仮定していないので、 バッファの削除はユーザの責任で行わなければならない。

定義:
インタフェース OutPortConsumer 内の setBuffer
パラメータ:
buffer - OutPortProviderがデータを取り出すバッファへのポインタ

setListener

public void setListener(ConnectorBase.ConnectorInfo info,
                        ConnectorListeners listeners)
リスナを設定する。

InPort はデータ送信処理における各種イベントに対して特定のリスナ オブジェクトをコールするコールバック機構を提供する。詳細は ConnectorListener.h の ConnectorDataListener, ConnectorListener 等を参照のこと。OutPortCorbaCdrProvider では、以下のコールバック が提供される。

  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

定義:
インタフェース OutPortConsumer 内の setListener
パラメータ:
info - 接続情報
listeners - リスナオブジェクト

get

public ReturnCode get(org.omg.CORBA.portable.OutputStream data)
データを読み出す

設定されたデータを読み出す。

定義:
インタフェース OutPortConsumer 内の get
パラメータ:
data - 読み出したデータを受け取るオブジェクト
戻り値:
データ読み出し処理結果(読み出し成功:true、読み出し失敗:false)

subscribeInterface

public boolean subscribeInterface(NVListHolder properties)
データ受信通知への登録

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

定義:
インタフェース OutPortConsumer 内の subscribeInterface
パラメータ:
properties - 登録情報
戻り値:
登録処理結果(登録成功:true、登録失敗:false)

unsubscribeInterface

public void unsubscribeInterface(NVListHolder properties)
データ受信通知からの登録解除

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

定義:
インタフェース OutPortConsumer 内の unsubscribeInterface
パラメータ:
properties - 登録解除情報

convertReturn

protected ReturnCode convertReturn(PortStatus status)
リターンコード変換 (DataPortStatus -> BufferStatus)

パラメータ:
status - PortStatus
戻り値:
ReturnCode

creator_

public OutPortConsumer creator_()
OutPortCorbaCdrConsumer を生成する

定義:
インタフェース ObjectCreator<OutPortConsumer> 内の creator_
戻り値:
生成されたOutPortConsumer

destructor_

public void destructor_(java.lang.Object obj)
Object を破棄する

定義:
インタフェース ObjectDestructor 内の destructor_
パラメータ:
obj - 破棄するインタスタンス

OutPortCorbaCdrConsumerInit

public static void OutPortCorbaCdrConsumerInit()
モジュール初期化関数

OutPortCorbaCdrConsumer のファクトリを登録する初期化関数。

setConnector

public void setConnector(InPortConnector connector)
Connectorを設定する。

定義:
インタフェース OutPortConsumer 内の setConnector
パラメータ:
connector - InPortConnector
概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド