|
||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||
java.lang.Objectjp.go.aist.rtm.RTC.port.InPort<DataType>
DataType - データ型を指定します。public class InPort<DataType>
入力ポートのためのベース実装クラスです。 外部から送信されてきたデータは順次、コンストラクタで指定されたバッファに格納されます。 バッファ内のデータはフラグによって未読/既読状態が管理され、isNew(), isEmpty()などの メソッドによってハンドリングできます。
| コンストラクタの概要 | |
|---|---|
InPort(BufferBase<DataType> superClass,
java.lang.String name,
DataRef<DataType> value)
コンストラクタです。 |
|
InPort(BufferBase<DataType> superClass,
java.lang.String name,
DataRef<DataType> value,
boolean read_block,
boolean write_block,
long read_timeout,
long write_timeout)
コンストラクタです。 |
|
InPort(java.lang.String name,
DataRef<DataType> value)
コンストラクタです。 |
|
| メソッドの概要 | |
|---|---|
DataType |
get()
データを読み取ります。 |
void |
init(DataType value)
当該ポートに割り当てられているバッファを、指定されたデータで埋め尽くします。 |
boolean |
isEmpty()
バッファが空である、つまり読み取れるデータがないかどうかを取得します。 |
boolean |
isFull()
バッファフルかどうかを取得します。 |
boolean |
isNew()
バッファ中に、まだ読み取られていないデータがあるかどうか判定します。 |
int |
length()
ポート内のバッファ長を取得します。 |
java.lang.String |
name()
ポート名称を取得します。 |
void |
put(DataType data)
データを書き込みます。 |
DataType |
read()
ポートからデータを読み出します。 |
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 |
update()
バインドされたDataType型のデータに、ポート内バッファの最新値を読み込みます。 |
boolean |
write(DataType value)
ポートに値を書き込みます。 |
| クラス java.lang.Object から継承されたメソッド |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| コンストラクタの詳細 |
|---|
public InPort(BufferBase<DataType> superClass,
java.lang.String name,
DataRef<DataType> value,
boolean read_block,
boolean write_block,
long read_timeout,
long write_timeout)
コンストラクタです。
superClass - ポートに割り当てるバッファname - ポート名称value - このポートにバインドされるDataType型の変数read_block - データ読み込み時に未読データがない場合に、データ受信までブロックする場合はtrue、さもなくばfalsewrite_block - データ書き込み時にバッファがフルであった場合に、バッファに空きができるまでブロック場合はtrue、さもなくばfalseread_timeout - 非ブロック指定の場合の、データ読み取りのタイムアウト時間 (ミリ秒)write_timeout - 非ブロック指定の場合の、データ書き込みのタイムアウト時間 (ミリ秒)
public InPort(java.lang.String name,
DataRef<DataType> value)
コンストラクタです。デフォルトの設定でバッファが生成され割り当てられます。 また、読み取り・書き込みともに非ブロックモードとなり、タイムアウト時間は0で設定されます。
name - ポート名称value - このポートにバインドされるDataType型の変数
public InPort(BufferBase<DataType> superClass,
java.lang.String name,
DataRef<DataType> value)
コンストラクタです。 読み取り・書き込みともに非ブロックモードとなり、タイムアウト時間は0で設定されます。
superClass - ポートに割り当てるバッファname - ポート名称value - このポートにバインドされるDataType型の変数| メソッドの詳細 |
|---|
public java.lang.String name()
ポート名称を取得します。
public boolean write(DataType value)
ポートに値を書き込みます。
BufferBase<DataType> 内の writevalue - 書き込むデータ
public DataType read()
ポートからデータを読み出します。
public void init(DataType value)
当該ポートに割り当てられているバッファを、指定されたデータで埋め尽くします。
public void update()
バインドされたDataType型のデータに、ポート内バッファの最新値を読み込みます。
ただし、あらかじめコンストラクタで、DataType型の変数がバインドされていなければなりません。
public void setOnWrite(OnWrite<DataType> onWrite)
ポートが持つバッファにデータが書き込まれる直前に呼び出される コールバックインタフェースを設定します。
onWrite - OnWrite<DataType>インタフェースを持つオブジェクトpublic void setOnWriteConvert(OnWriteConvert<DataType> onWriteConvert)
ポートが持つバッファにデータが書き込まれる際に呼び出される
コールバックインタフェースを設定します。
コールバックインタフェースの戻り値がバッファに書き込まれます。
onWriteConvert - OnWriteConvert<DataType>インタフェースを持つオブジェクトpublic void setOnRead(OnRead<DataType> onRead)
ポートが持つバッファからデータが読み込まれる直前に呼び出される コールバックインタフェースを設定します。
onRead - OnRead<DataType>インタフェースを持つオブジェクトpublic void setOnReadConvert(OnReadConvert<DataType> onReadConvert)
ポートが持つバッファからデータが読み出される際に呼び出される
コールバックインタフェースを設定します。
コールバックインタフェースの戻り値がread()メソッドの読み出し結果として取得されます。
onReadConvert - OnReadConvert<DataType>インタフェースを持つオブジェクトpublic void setOnOverflow(OnOverflow<DataType> onOverflow)
データ書き込み時に、バッファオーバーフロー検出の際に呼び出される コールバックインタフェースを設定します。
onOverflow - OnOverflow<DataType>インタフェースを持つオブジェクトpublic void setOnUnderflow(OnUnderflow<DataType> onUnderflow)
データ読み込みときに、バッファアンダーフロー検出の際に呼び出される コールバックインタフェースを設定します。
onUnderflow - OnUnderflow<DataType>インタフェースを持つオブジェクトpublic int length()
ポート内のバッファ長を取得します。
BufferBase<DataType> 内の lengthpublic boolean read(DataRef<DataType> valueRef)
データを読み取ります。
BufferBase<DataType> 内の readvalueRef - 読み取ったデータを受け取るためのDataRefオブジェクト
public boolean isFull()
バッファフルかどうかを取得します。
BufferBase<DataType> 内の isFullpublic boolean isEmpty()
バッファが空である、つまり読み取れるデータがないかどうかを取得します。
BufferBase<DataType> 内の isEmptypublic void put(DataType data)
データを書き込みます。
BufferBase<DataType> 内の putdata - 書き込むデータpublic DataType get()
データを読み取ります。
BufferBase<DataType> 内の getpublic boolean isNew()
BufferBase の記述: バッファ中に、まだ読み取られていないデータがあるかどうか判定します。
BufferBase<DataType> 内の isNew
|
||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||