jp.go.aist.rtm.RTC.port
クラス OutPortCorbaConsumer<DataType>

java.lang.Object
  上位を拡張 jp.go.aist.rtm.RTC.port.CorbaConsumerBase
      上位を拡張 jp.go.aist.rtm.RTC.port.CorbaConsumer<OutPortAny>
          上位を拡張 jp.go.aist.rtm.RTC.port.OutPortCorbaConsumer<DataType>
型パラメータ:
DataType - データ型を指定します。
すべての実装されたインタフェース:
OutPortConsumer

public class OutPortCorbaConsumer<DataType>
extends CorbaConsumer<OutPortAny>
implements OutPortConsumer

CORBAを通信手段とする出力ポートコンシューマの実装です。


フィールドの概要
 
クラス jp.go.aist.rtm.RTC.port.CorbaConsumer から継承されたフィールド
m_var
 
クラス jp.go.aist.rtm.RTC.port.CorbaConsumerBase から継承されたフィールド
m_objref
 
コンストラクタの概要
OutPortCorbaConsumer(java.lang.Class<DataType> DATA_TYPE_CLASS, BufferBase<DataType> buffer)
          コンストラクタです。
 
メソッドの概要
 boolean get(DataRef<DataType> dataRef)
          データを読み出します。
 ReturnCode get(org.omg.CORBA.portable.OutputStream data)
           Pure virtual function to receive data.
 void init(Properties prop)
           Initializing configuration This operation would be called to configure in initialization.
 void pull()
          接続先のポートからデータを受信します。
 void setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
           Setting outside buffer's pointer A pointer to a buffer from which OutPortProvider retrieve data.
 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
 

コンストラクタの詳細

OutPortCorbaConsumer

public OutPortCorbaConsumer(java.lang.Class<DataType> DATA_TYPE_CLASS,
                            BufferBase<DataType> buffer)

コンストラクタです。

パラメータ:
DATA_TYPE_CLASS - 型パラメータで指定したデータ型のClassオブジェクト
buffer - 割り当てるバッファ
メソッドの詳細

get

public boolean get(DataRef<DataType> dataRef)

データを読み出します。

パラメータ:
dataRef - 読み出したデータを受け取るためのDataRefオブジェクト

pull

public void pull()

接続先のポートからデータを受信します。受信したデータは、内部のバッファに書き込まれます。


subscribeInterface

public boolean subscribeInterface(NVListHolder properties)

指定されたプロパティセットの内容に基づいて、データ受信通知の受け取りに登録します。

定義:
インタフェース OutPortConsumer 内の subscribeInterface
パラメータ:
properties - 登録時に参照される情報
戻り値:
登録された場合にはtrueを、さもなくばfalseを返します。

unsubscribeInterface

public void unsubscribeInterface(NVListHolder properties)

データ受信通知の受け取り登録を解除します。

定義:
インタフェース OutPortConsumer 内の unsubscribeInterface
パラメータ:
properties - 登録解除時に参照される情報

init

public void init(Properties prop)
インタフェース OutPortConsumer の記述:

Initializing configuration

This operation would be called to configure in initialization. In the concrete class, configuration should be performed getting appropriate information from the given Properties data. This function might be called right after instantiation and connection sequence respectivly. Therefore, this function should be implemented assuming multiple call.

定義:
インタフェース OutPortConsumer 内の init
パラメータ:
prop - Configuration information

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.

定義:
インタフェース OutPortConsumer 内の setBuffer
パラメータ:
buffer - A pointer to a data buffer to be used by OutPortProvider

get

public ReturnCode get(org.omg.CORBA.portable.OutputStream data)
インタフェース OutPortConsumer の記述:

Pure virtual function to receive data.

定義:
インタフェース OutPortConsumer 内の get
戻り値:
PORT_OK BUFFER_TIMEOUT RECV_EMPTY CONNECTION_LOST PORT_ERROR UNKNOWN_ERROR