ダミーバッファ実装クラス [詳解]
OpenRTM_aist.BufferBase.NullBuffer の継承関係図
公開メンバ関数 | |
| def | __init__ (self, size=None) |
| コンストラクタ [詳解] | |
| def | length (self) |
| バッファ長(１固定)を取得する [詳解] | |
| def | write (self, value, sec=-1, nsec=-1) |
| バッファにデータを書き込む [詳解] | |
| def | read (self, value) |
| バッファからデータを読み出す [詳解] | |
| def | isFull (self) |
| バッファfullチェック [詳解] | |
| def | isEmpty (self) |
| バッファemptyチェック [詳解] | |
| def | isNew (self) |
| 最新データか確認する [詳解] | |
| def | put (self, data) |
| バッファにデータを格納 [詳解] | |
| def | get (self) |
| バッファからデータを取得する [詳解] | |
| def | getRef (self) |
| 次に書き込むバッファへの参照を取得する [詳解] | |
 基底クラス 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チェック [詳解] | |
詳解
ダミーバッファ実装クラス
バッファ長が１固定のダミーバッファ実装クラス。
- 引数
-
DataType バッファに格納するデータ型
- から
- 0.4.0
構築子と解体子
| def OpenRTM_aist.BufferBase.NullBuffer.__init__ | ( | self, | |
size = None |
|||
| ) |
コンストラクタ
コンストラクタ バッファ長を１(固定)で初期化する。
- 引数
-
self size バッファ長(デフォルト値:None，ただし無効)
メソッド詳解
| def OpenRTM_aist.BufferBase.NullBuffer.get | ( | self | ) |
バッファからデータを取得する
バッファに格納されたデータを取得する。
- 引数
-
self
- 戻り値
- 取得データ
| def OpenRTM_aist.BufferBase.NullBuffer.getRef | ( | self | ) |
次に書き込むバッファへの参照を取得する
書き込みバッファへの参照を取得する。 本バッファ実装ではバッファ長は固定で１であるため， 常に同じ位置への参照を返す。
- 引数
-
self
- 戻り値
- 次の書き込み対象バッファへの参照(固定)
| def OpenRTM_aist.BufferBase.NullBuffer.isEmpty | ( | self | ) |
バッファemptyチェック
バッファemptyをチェックする。(常にfalseを返す。) ※要確認
- 引数
-
self
- 戻り値
- emptyチェック結果(常にfalse)
| def OpenRTM_aist.BufferBase.NullBuffer.isFull | ( | self | ) |
バッファfullチェック
バッファfullをチェックする。(常にfalseを返す。)
- 引数
-
self
- 戻り値
- fullチェック結果(常にfalse)
| def OpenRTM_aist.BufferBase.NullBuffer.isNew | ( | self | ) |
最新データか確認する
現在のバッファ位置に格納されているデータが最新データか確認する。
- 引数
-
self
- 戻り値
- 最新データ確認結果 ( true:最新データ．データはまだ読み出されていない false:過去のデータ．データは既に読み出されている)
| def OpenRTM_aist.BufferBase.NullBuffer.length | ( | self | ) |
バッファ長(１固定)を取得する
バッファ長を取得する。(常に１を返す。)
- 引数
-
self
- 戻り値
- バッファ長(１固定)
| def OpenRTM_aist.BufferBase.NullBuffer.put | ( | self, | |
| data | |||
| ) |
バッファにデータを格納
引数で与えられたデータをバッファに格納する。
- 引数
-
self data 対象データ
| def OpenRTM_aist.BufferBase.NullBuffer.read | ( | self, | |
| value | |||
| ) |
バッファからデータを読み出す
バッファに格納されたデータを読み出す。
- 引数
-
self value 読み出したデータ
- 戻り値
- データ読み出し結果(true:読み出し成功，false:読み出し失敗)
| def OpenRTM_aist.BufferBase.NullBuffer.write | ( | self, | |
| value, | |||
sec = -1, |
|||
nsec = -1 |
|||
| ) |
バッファにデータを書き込む
引数で与えられたデータをバッファに書き込む。
- 引数
-
self value 書き込み対象データ
- 戻り値
- データ書き込み結果(true:書き込み成功，false:書き込み失敗)
このクラス詳解は次のファイルから抽出されました:
- /tmp/workspace/03_openrtm-python-build-tags/OpenRTM_aist/BufferBase.py
