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