|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectjp.go.aist.rtm.RTC.port.OutPortBase
jp.go.aist.rtm.RTC.port.OutPort<DataType>
DataType
- データ型を指定します。public class OutPort<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 |
コンストラクタの詳細 |
---|
public OutPort(java.lang.String name, DataRef<DataType> valueRef)
コンストラクタです。内部的にバッファが生成されて割り当てられます。
name
- ポート名valueRef
- 本ポートにバインドするデータ変数を内包するDataRefオブジェクトpublic OutPort(java.lang.String name, DataRef<DataType> valueRef, int length)
コンストラクタです。指定されたデータ長で内部的にバッファが生成されて割り当てられます。
name
- ポート名valueRef
- 本ポートにバインドするデータ変数を内包するDataRefオブジェクトlength
- バッファ長public OutPort(BufferBase<DataType> buffer, java.lang.String name, DataRef<DataType> valueRef)
コンストラクタです。指定されたバッファを割り当てます。
buffer
- 割り当てるバッファname
- ポート名valueRef
- 本ポートにバインドするデータ変数を内包するDataRefオブジェクトメソッドの詳細 |
---|
public boolean write(DataType value)
データを書き込みます。
BufferBase<DataType>
内の write
value
- 書き込むデータ
public boolean write()
データを書き込みます。本ポートにバインドされているデータ変数の値が書き込まれます。
public boolean read(DataRef<DataType> valueRef)
データを読み出します。
BufferBase<DataType>
内の read
valueRef
- 読み出したデータを受け取るためのDataRefオブジェクト
public void setReadBlock(boolean block)
データ読み出し時における、ブロック/非ブロックモードを指定します。
ブロックモードを指定した場合は、読み出せるデータを受信するかタイムアウトになるまで、
read()メソッドの呼び出しがブロックされます。
block
- ブロックモードを指定する場合はtrue、さもなくばfalsepublic void setWriteBlock(boolean block)
データ書き込み時における、ブロック/非ブロックモードを指定します。
ブロックモードを指定した場合は、バッファに書き込む余地ができるかタイムアウトになるまで、
write()メソッドの呼び出しがブロックされます。
block
- ブロックモードを指定する場合はtrue、さもなくばfalsepublic void setReadTimeout(long timeout)
読み出しがブロックモード指定されている場合のタイムアウト時間を設定します。
timeout
- タイムアウト時間 [usec]public void setWriteTimeout(long timeout)
書き込みがブロックモード指定されている場合のタイムアウト時間を設定します。
timeout
- タイムアウト時間 [usec]public void setOnWrite(OnWrite<DataType> onWrite)
データ書き込み直前に呼び出されるコールバックインタフェースを設定します。
onWrite
- OnWriteコールバックインタフェースを持つオブジェクトpublic void setOnWriteConvert(OnWriteConvert<DataType> onWriteConvert)
データ書き込み時に呼び出されるコールバックインタフェースを設定します。
設定されたコールバックの戻り値のデータが書き込まれます。 これにより、書き込みデータのフィルタリングを行うことができます。
onWriteConvert
- OutWriteConvertコールバックインタフェースを持つオブジェクトpublic void setOnOverflow(OnOverflow<DataType> onOverflow)
バッファフルによりデータ書き込みできない場合に呼び出されるコールバックインタフェースを設定します。
onOverflow
- OutOverflowコールバックインタフェースを持つオブジェクトpublic void setOnRead(OnRead<DataType> onRead)
データ読み出しの直前に呼び出されるコールバックインタフェースを設定します。
onRead
- OutReadコールバックインタフェースを持つオブジェクトpublic void setOnReadConvert(OnReadConvert<DataType> onReadConvert)
データ読み出し時に呼び出されるコールバックインタフェースを設定します。
設定されたコールバックの戻りデータ値が読み出されます。 これにより、読み出しデータをフィルタリングすることができます。
onReadConvert
- OutReadConvertコールバックインタフェースを持つオブジェクトpublic void setOnUnderflow(OnUnderflow<DataType> onUnderflow)
バッファ空により読み取れるデータがない場合に呼び出されるコールバックインタフェースを設定します。
onUnderflow
- OutUnderflowコールバックインタフェースを持つオブジェクトpublic int length()
内部に割り当てられているバッファ長を取得します。
BufferBase<DataType>
内の length
public boolean isFull()
バッファフルか否かを判定します。
BufferBase<DataType>
内の isFull
public boolean isEmpty()
バッファが空か否かを判定します。
BufferBase<DataType>
内の isEmpty
public void put(DataType data)
内部に割り当てられているバッファに、データを直接書き込みます。
バッファ状態のハンドリング、ブロッキング、タイムアウト、コールバック呼び出しなどは行われません。
BufferBase<DataType>
内の put
data
- 書き込むデータpublic DataType get()
内部に割り当てられているバッファから、データを直接読み出します。
バッファ状態のハンドリング、ブロッキング、タイムアウト、コールバック呼び出しなどは行われません。
BufferBase<DataType>
内の get
public boolean isNew()
バッファ内に、まだ読み出されていないデータが存在するかどうかを判定します。
BufferBase<DataType>
内の isNew
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |