クラス OpenRTM_aist.BufferBase.BufferBase

OpenRTM_aist.BufferBase.BufferBaseに対する継承グラフ

Public メソッド
def	init
	バッファの設定
def	length
	バッファの長さを取得する(サブクラス実装用)
def	reset
	バッファの状態をリセットする
def	wptr
	バッファの現在の書込み要素のポインタ
def	advanceWptr
	書込みポインタを進める
def	put
	バッファにデータを格納する(サブクラス実装用)
def	write
	バッファにデータを書き込む(サブクラス実装用)
def	writable
	バッファに書込み可能な要素数
def	full
	バッファfullチェック
def	rptr
	バッファの現在の読み出し要素のポインタ
def	advanceRptr
	読み出しポインタを進める
def	get
	バッファからデータを取得する(サブクラス実装用)
def	read
	バッファからデータを読み出す(サブクラス実装用)
def	readable
	バッファから読み出し可能な要素数
def	empty
	バッファemptyチェック

説明

BufferBase 抽象クラス.

種々のバッファのための抽象インターフェースクラス。具象バッファクラスは、以下の関数の実装を提供しなければならない。

publicインターフェースとして以下のものを提供する。

write(): バッファに書き込む
read(): バッファから読み出す
length(): バッファ長を返す
isFull(): バッファが満杯である
isEmpty(): バッファが空である

protectedインターフェースとして以下のものを提供する。

put(): バッファにデータを書き込む
get(): バッファからデータを読み出す

から:: 0.4.0

メソッド

def OpenRTM_aist.BufferBase.BufferBase.advanceRptr	(	self,
		n = `1`
	)

読み出しポインタを進める

現在の読み出し位置のポインタを n 個進める。

引数:

n

読み出しポインタ + n の位置のポインタ

戻り値:: BUFFER_OK: 正常終了 BUFFER_ERROR: 異常終了

OpenRTM_aist.RingBuffer.RingBufferで再定義されています。

def OpenRTM_aist.BufferBase.BufferBase.advanceWptr	(	self,
		n = `1`
	)

書込みポインタを進める

現在の書き込み位置のポインタを n 個進める。

引数:

n

書込みポインタ + n の位置のポインタ

戻り値:: BUFFER_OK: 正常終了 BUFFER_ERROR: 異常終了

OpenRTM_aist.RingBuffer.RingBufferで再定義されています。

def OpenRTM_aist.BufferBase.BufferBase.empty ( self )

バッファemptyチェック

バッファemptyチェック用純粋仮想関数

戻り値:: emptyチェック結果(true:バッファempty，false:バッファデータあり)

OpenRTM_aist.RingBuffer.RingBufferで再定義されています。

def OpenRTM_aist.BufferBase.BufferBase.full ( self )

バッファfullチェック

バッファfullチェック用純粋仮想関数

戻り値:: fullチェック結果(true:バッファfull，false:バッファ空きあり)

OpenRTM_aist.RingBuffer.RingBufferで再定義されています。

def OpenRTM_aist.BufferBase.BufferBase.get ( self )

バッファからデータを取得する(サブクラス実装用)

バッファに格納されたデータ取得用関数
※サブクラスでの実装参照用

引数:

self

戻り値:: 取得データ

OpenRTM_aist.BufferBase.NullBufferで再定義されています。

def OpenRTM_aist.BufferBase.BufferBase.init	(	self,
		prop
	)

バッファの設定

Properties で与えられるプロパティにより、バッファの設定を初期化する。使用できるオプションと意味は以下の通り

buffer.length: バッファの長さ。自然数以外の数値が指定されても無視される。すでにバッファが使用状態でも、長さが再設定されたのち、すべてのポインタが初期化される。

buffer.write.full_policy: 上書きするかどうかのポリシー。 overwrite (上書き), do_nothing (何もしない), block (ブロックする) block を指定した場合、次の timeout 値を指定すれば、指定時間後書き込み不可能であればタイムアウトする。デフォルトは overwrite (上書き)。

buffer.write.timeout: タイムアウト時間を [sec] で指定する。デフォルトは 1.0 [sec]。 1 sec -> 1.0, 1 ms -> 0.001, タイムアウトしない -> 0.0

buffer.read.empty_policy: バッファが空のときの読み出しポリシー。 readback (最後の要素), do_nothing (何もしない), block (ブロックする) block を指定した場合、次の timeout 値を指定すれば、指定時間後読み出し不可能であればタイムアウトする。デフォルトは readback (最後の要素)。