OpenRTM_aist.BufferBase.BufferBase クラス

BufferBase 抽象クラス [詳解]

OpenRTM_aist.BufferBase.BufferBase の継承関係図

公開メンバ関数
def	init (self, prop)
	バッファの設定 [詳解]
def	length (self)
	バッファの長さを取得する(サブクラス実装用) [詳解]
def	reset (self)
	バッファの状態をリセットする [詳解]
def	wptr (self, n=0)
	バッファの現在の書込み要素のポインタ [詳解]
def	advanceWptr (self, n=1)
	書込みポインタを進める [詳解]
def	put (self, data)
	バッファにデータを格納する(サブクラス実装用) [詳解]
def	write (self, value, sec=-1, nsec=-1)
	バッファにデータを書き込む(サブクラス実装用) [詳解]
def	writable (self)
	バッファに書込み可能な要素数 [詳解]
def	full (self)
	バッファfullチェック [詳解]
def	rptr (self, n=0)
	バッファの現在の読み出し要素のポインタ [詳解]
def	advanceRptr (self, n=1)
	読み出しポインタを進める [詳解]
def	get (self)
	バッファからデータを取得する(サブクラス実装用) [詳解]
def	read (self, value, sec=-1, nsec=-1)
	バッファからデータを読み出す(サブクラス実装用) [詳解]
def	readable (self)
	バッファから読み出し可能な要素数 [詳解]
def	empty (self)
	バッファ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: 異常終了

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

書込みポインタを進める

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

引数

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

戻り値

BUFFER_OK: 正常終了 BUFFER_ERROR: 異常終了

def OpenRTM_aist.BufferBase.BufferBase.empty

(

self

)

バッファemptyチェック

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

戻り値

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

def OpenRTM_aist.BufferBase.BufferBase.full

(

self

)

バッファfullチェック

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

戻り値

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

def OpenRTM_aist.BufferBase.BufferBase.get

(

self

)

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

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

引数

self

戻り値

取得データ

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 (最後の要素)。
• buffer.read.timeout: タイムアウト時間 [sec] で指定する。デフォルトは 1.0 [sec]。 1sec -> 1.0, 1ms -> 0.001, タイムアウトしない -> 0.0

def OpenRTM_aist.BufferBase.BufferBase.length

(

self

)

バッファの長さを取得する(サブクラス実装用)

バッファ長を取得する
※サブクラスでの実装参照用

引数

self

戻り値

バッファ長

def OpenRTM_aist.BufferBase.BufferBase.put	(		self,
			data
	)

バッファにデータを格納する(サブクラス実装用)

バッファへのデータ格納用関数
※サブクラスでの実装参照用

引数

self
data	対象データ

def OpenRTM_aist.BufferBase.BufferBase.read	(		self,
			value,
			sec = -1,
			nsec = -1
	)

バッファからデータを読み出す(サブクラス実装用)

バッファからデータを読み出す
※サブクラスでの実装参照用

引数

self
value	読み出しデータ

戻り値

データ読み出し結果(true:読み出し成功，false:読み出し失敗)

def OpenRTM_aist.BufferBase.BufferBase.readable

(

self

)

バッファから読み出し可能な要素数

バッファから読み出し可能な要素数を返す。

戻り値

読み出し可能な要素数

BUFFER_OK: 正常終了 BUFFER_ERROR: 異常終了

def OpenRTM_aist.BufferBase.BufferBase.reset

(

self

)

バッファの状態をリセットする

バッファの読み出しポインタと書き込みポインタの位置をリセットする。

戻り値

BUFFER_OK: 正常終了 NOT_SUPPORTED: バッファ長変更不可 BUFFER_ERROR: 異常終了

def OpenRTM_aist.BufferBase.BufferBase.rptr	(		self,
			n = 0
	)

バッファの現在の読み出し要素のポインタ

バッファの現在の読み出し要素のポインタまたは、n個先のポインタを返す

引数

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

戻り値

読み出し位置のポインタ

def OpenRTM_aist.BufferBase.BufferBase.wptr	(		self,
			n = 0
	)

バッファの現在の書込み要素のポインタ

バッファの現在の書込み要素のポインタまたは、n個先のポインタを返す

引数

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

戻り値

書込み位置のポインタ

def OpenRTM_aist.BufferBase.BufferBase.writable

(

self

)

バッファに書込み可能な要素数

バッファに書込み可能な要素数を返す。

戻り値

書き込み可能な要素数

BUFFER_OK: 正常終了 BUFFER_ERROR: 異常終了

def OpenRTM_aist.BufferBase.BufferBase.write	(		self,
			value,
			sec = -1,
			nsec = -1
	)

バッファにデータを書き込む(サブクラス実装用)

バッファにデータを書き込む
※サブクラスでの実装参照用

引数

self
value	書き込み対象データ

戻り値

データ書き込み結果(true:書き込み成功，false:書き込み失敗)

---

このクラス詳解は次のファイルから抽出されました:

• /tmp/workspace/03_openrtm-python-build-tags/OpenRTM_aist/BufferBase.py