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

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

public class OutPort<DataType>
extends OutPortBase
implements BufferBase<DataType>

出力ポートの実装です。さらに上位の出力ポートのベース実装として利用されます。


入れ子のクラスの概要
 
クラス jp.go.aist.rtm.RTC.port.OutPortBase から継承された入れ子のクラス/インタフェース
OutPortBase.Publisher
 
フィールドの概要
 
クラス jp.go.aist.rtm.RTC.port.OutPortBase から継承されたフィールド
m_name, m_publishers
 
コンストラクタの概要
OutPort(BufferBase<DataType> buffer, java.lang.String name, DataRef<DataType> valueRef)
          コンストラクタです。
OutPort(java.lang.String name, DataRef<DataType> valueRef)
          コンストラクタです。
OutPort(java.lang.String name, DataRef<DataType> valueRef, int length)
          コンストラクタです。
 
メソッドの概要
 DataType get()
          内部に割り当てられているバッファから、データを直接読み出します。
 boolean isEmpty()
          バッファが空か否かを判定します。
 boolean isFull()
          バッファフルか否かを判定します。
 boolean isNew()
          バッファ内に、まだ読み出されていないデータが存在するかどうかを判定します。
 int length()
          内部に割り当てられているバッファ長を取得します。
 void put(DataType data)
          内部に割り当てられているバッファに、データを直接書き込みます。
 boolean read(DataRef<DataType> valueRef)
          データを読み出します。
 void setOnOverflow(OnOverflow<DataType> onOverflow)
          バッファフルによりデータ書き込みできない場合に呼び出されるコールバックインタフェースを設定します。
 void setOnRead(OnRead<DataType> onRead)
          データ読み出しの直前に呼び出されるコールバックインタフェースを設定します。
 void setOnReadConvert(OnReadConvert<DataType> onReadConvert)
          データ読み出し時に呼び出されるコールバックインタフェースを設定します。
 void setOnUnderflow(OnUnderflow<DataType> onUnderflow)
          バッファ空により読み取れるデータがない場合に呼び出されるコールバックインタフェースを設定します。
 void setOnWrite(OnWrite<DataType> onWrite)
          データ書き込み直前に呼び出されるコールバックインタフェースを設定します。
 void setOnWriteConvert(OnWriteConvert<DataType> onWriteConvert)
          データ書き込み時に呼び出されるコールバックインタフェースを設定します。
 void setReadBlock(boolean block)
          データ読み出し時における、ブロック/非ブロックモードを指定します。
 void setReadTimeout(long timeout)
          読み出しがブロックモード指定されている場合のタイムアウト時間を設定します。
 void setWriteBlock(boolean block)
          データ書き込み時における、ブロック/非ブロックモードを指定します。
 void setWriteTimeout(long timeout)
          書き込みがブロックモード指定されている場合のタイムアウト時間を設定します。
 boolean write()
          データを書き込みます。
 boolean write(DataType value)
          データを書き込みます。
 
クラス jp.go.aist.rtm.RTC.port.OutPortBase から継承されたメソッド
attach_back, attach_front, attach, detach, name, update
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

OutPort

public OutPort(java.lang.String name,
               DataRef<DataType> valueRef)

コンストラクタです。内部的にバッファが生成されて割り当てられます。

パラメータ:
name - ポート名
valueRef - 本ポートにバインドするデータ変数を内包するDataRefオブジェクト

OutPort

public OutPort(java.lang.String name,
               DataRef<DataType> valueRef,
               int length)

コンストラクタです。指定されたデータ長で内部的にバッファが生成されて割り当てられます。

パラメータ:
name - ポート名
valueRef - 本ポートにバインドするデータ変数を内包するDataRefオブジェクト
length - バッファ長

OutPort

public OutPort(BufferBase<DataType> buffer,
               java.lang.String name,
               DataRef<DataType> valueRef)

コンストラクタです。指定されたバッファを割り当てます。

パラメータ:
buffer - 割り当てるバッファ
name - ポート名
valueRef - 本ポートにバインドするデータ変数を内包するDataRefオブジェクト
メソッドの詳細

write

public boolean write(DataType value)

データを書き込みます。

定義:
インタフェース BufferBase<DataType> 内の write
パラメータ:
value - 書き込むデータ
戻り値:
データを書き込めた場合はtrueを、さもなくばfalseを返します。

write

public boolean write()

データを書き込みます。本ポートにバインドされているデータ変数の値が書き込まれます。

戻り値:
データを書き込めた場合はtrueを、さもなくばfalseを返します。

read

public boolean read(DataRef<DataType> valueRef)

データを読み出します。

定義:
インタフェース BufferBase<DataType> 内の read
パラメータ:
valueRef - 読み出したデータを受け取るためのDataRefオブジェクト
戻り値:
データを読み出せた場合はtrueを、さもなくばfalseを返します。

setReadBlock

public void setReadBlock(boolean block)

データ読み出し時における、ブロック/非ブロックモードを指定します。
ブロックモードを指定した場合は、読み出せるデータを受信するかタイムアウトになるまで、 read()メソッドの呼び出しがブロックされます。

パラメータ:
block - ブロックモードを指定する場合はtrue、さもなくばfalse

setWriteBlock

public void setWriteBlock(boolean block)

データ書き込み時における、ブロック/非ブロックモードを指定します。
ブロックモードを指定した場合は、バッファに書き込む余地ができるかタイムアウトになるまで、 write()メソッドの呼び出しがブロックされます。

パラメータ:
block - ブロックモードを指定する場合はtrue、さもなくばfalse

setReadTimeout

public void setReadTimeout(long timeout)

読み出しがブロックモード指定されている場合のタイムアウト時間を設定します。

パラメータ:
timeout - タイムアウト時間 [usec]

setWriteTimeout

public void setWriteTimeout(long timeout)

書き込みがブロックモード指定されている場合のタイムアウト時間を設定します。

パラメータ:
timeout - タイムアウト時間 [usec]

setOnWrite

public void setOnWrite(OnWrite<DataType> onWrite)

データ書き込み直前に呼び出されるコールバックインタフェースを設定します。

パラメータ:
onWrite - OnWriteコールバックインタフェースを持つオブジェクト

setOnWriteConvert

public void setOnWriteConvert(OnWriteConvert<DataType> onWriteConvert)

データ書き込み時に呼び出されるコールバックインタフェースを設定します。

設定されたコールバックの戻り値のデータが書き込まれます。 これにより、書き込みデータのフィルタリングを行うことができます。

パラメータ:
onWriteConvert - OutWriteConvertコールバックインタフェースを持つオブジェクト

setOnOverflow

public void setOnOverflow(OnOverflow<DataType> onOverflow)

バッファフルによりデータ書き込みできない場合に呼び出されるコールバックインタフェースを設定します。

パラメータ:
onOverflow - OutOverflowコールバックインタフェースを持つオブジェクト

setOnRead

public void setOnRead(OnRead<DataType> onRead)

データ読み出しの直前に呼び出されるコールバックインタフェースを設定します。

パラメータ:
onRead - OutReadコールバックインタフェースを持つオブジェクト

setOnReadConvert

public void setOnReadConvert(OnReadConvert<DataType> onReadConvert)

データ読み出し時に呼び出されるコールバックインタフェースを設定します。

設定されたコールバックの戻りデータ値が読み出されます。 これにより、読み出しデータをフィルタリングすることができます。

パラメータ:
onReadConvert - OutReadConvertコールバックインタフェースを持つオブジェクト

setOnUnderflow

public void setOnUnderflow(OnUnderflow<DataType> onUnderflow)

バッファ空により読み取れるデータがない場合に呼び出されるコールバックインタフェースを設定します。

パラメータ:
onUnderflow - OutUnderflowコールバックインタフェースを持つオブジェクト

length

public int length()

内部に割り当てられているバッファ長を取得します。

定義:
インタフェース BufferBase<DataType> 内の length
戻り値:
バッファ長

isFull

public boolean isFull()

バッファフルか否かを判定します。

定義:
インタフェース BufferBase<DataType> 内の isFull
戻り値:
バッファフルの場合はtrueを、さもなくばfalseを返します。

isEmpty

public boolean isEmpty()

バッファが空か否かを判定します。

定義:
インタフェース BufferBase<DataType> 内の isEmpty
戻り値:
バッファが空の場合はtrueを、さもなくばfalseを返します。

put

public void put(DataType data)

内部に割り当てられているバッファに、データを直接書き込みます。
バッファ状態のハンドリング、ブロッキング、タイムアウト、コールバック呼び出しなどは行われません。

定義:
インタフェース BufferBase<DataType> 内の put
パラメータ:
data - 書き込むデータ

get

public DataType get()

内部に割り当てられているバッファから、データを直接読み出します。
バッファ状態のハンドリング、ブロッキング、タイムアウト、コールバック呼び出しなどは行われません。

定義:
インタフェース BufferBase<DataType> 内の get
戻り値:
読み出したデータ

isNew

public boolean isNew()

バッファ内に、まだ読み出されていないデータが存在するかどうかを判定します。

定義:
インタフェース BufferBase<DataType> 内の isNew
戻り値:
まだ読み出されていないデータがあればtrueを、さもなくばfalseを返します。