OpenRTM-aist-Python 2.0.2
|
公開メンバ関数 | |
init (self, prop) | |
length (self) | |
reset (self) | |
wptr (self, n=0) | |
advanceWptr (self, n=1, unlock_enable=True) | |
put (self, data) | |
write (self, value, sec=-1, nsec=-1) | |
writable (self) | |
full (self) | |
rptr (self, n=0) | |
advanceRptr (self, n=1, unlock_enable=True) | |
get (self) | |
read (self, sec=-1, nsec=-1) | |
readable (self) | |
empty (self) | |
BufferBase 抽象クラス
種々のバッファのための抽象インターフェースクラス。 具象バッファクラスは、以下の関数の実装を提供しなければならない。
publicインターフェースとして以下のものを提供する。
protectedインターフェースとして以下のものを提供する。
OpenRTM_aist.BufferBase.BufferBase.advanceRptr | ( | self, | |
n = 1, | |||
unlock_enable = True ) |
読み出しポインタを進める
現在の読み出し位置のポインタを n 個進める。
n | 読み出しポインタ + n の位置のポインタ |
unlock_enable | Trueの場合にバッファフルのブロックを解除する |
OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.advanceWptr | ( | self, | |
n = 1, | |||
unlock_enable = True ) |
書込みポインタを進める
現在の書き込み位置のポインタを n 個進める。
n | 書込みポインタ + n の位置のポインタ |
unlock_enable | Trueの場合にバッファエンプティのブロックを解除する |
OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.empty | ( | self | ) |
バッファemptyチェック
バッファemptyチェック用純粋仮想関数
OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.full | ( | self | ) |
バッファfullチェック
バッファfullチェック用純粋仮想関数
OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.get | ( | self | ) |
バッファからデータを取得する(サブクラス実装用)
バッファに格納されたデータ取得用関数
※サブクラスでの実装参照用
self |
OpenRTM_aist.BufferBase.NullBuffer, OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.init | ( | self, | |
prop ) |
バッファの設定
Properties で与えられるプロパティにより、 バッファの設定を初期化する。 使用できるオプションと意味は以下の通り
OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.length | ( | self | ) |
バッファの長さを取得する(サブクラス実装用)
バッファ長を取得する
※サブクラスでの実装参照用
self |
OpenRTM_aist.BufferBase.NullBuffer, OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.put | ( | self, | |
data ) |
バッファにデータを格納する(サブクラス実装用)
バッファへのデータ格納用関数
※サブクラスでの実装参照用
self | |
data | 対象データ |
OpenRTM_aist.BufferBase.NullBuffer, OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.read | ( | self, | |
sec = -1, | |||
nsec = -1 ) |
バッファからデータを読み出す(サブクラス実装用)
バッファからデータを読み出す
※サブクラスでの実装参照用
self |
OpenRTM_aist.BufferBase.NullBuffer, OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.readable | ( | self | ) |
バッファから読み出し可能な要素数
バッファから読み出し可能な要素数を返す。
OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.reset | ( | self | ) |
バッファの状態をリセットする
バッファの読み出しポインタと書き込みポインタの位置をリセットする。
OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.rptr | ( | self, | |
n = 0 ) |
バッファの現在の読み出し要素のポインタ
バッファの現在の読み出し要素のポインタまたは、n個先のポインタを返す
n | 読み出しポインタ + n の位置のポインタ |
OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.wptr | ( | self, | |
n = 0 ) |
バッファの現在の書込み要素のポインタ
バッファの現在の書込み要素のポインタまたは、n個先のポインタを返す
n | 書込みポインタ + n の位置のポインタ |
OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.writable | ( | self | ) |
バッファに書込み可能な要素数
バッファに書込み可能な要素数を返す。
OpenRTM_aist.RingBuffer.RingBufferで再実装されています。
OpenRTM_aist.BufferBase.BufferBase.write | ( | self, | |
value, | |||
sec = -1, | |||
nsec = -1 ) |
バッファにデータを書き込む(サブクラス実装用)
バッファにデータを書き込む
※サブクラスでの実装参照用
self | |
value | 書き込み対象データ |
OpenRTM_aist.BufferBase.NullBuffer, OpenRTM_aist.RingBuffer.RingBufferで再実装されています。