クラス BufferBase

BufferBase 抽象クラス [詳細]

NullBufferに継承されています。


Public メソッド

def length
 バッファの長さを取得する(サブクラス実装用)
def write
 バッファにデータを書き込む(サブクラス実装用)
def read
 バッファからデータを読み出す(サブクラス実装用)
def isFull
 バッファfullチェック(サブクラス実装用)
def isEmpty
 バッファemptyチェック(サブクラス実装用)
def put
 バッファにデータを格納する(サブクラス実装用)
def get
 バッファからデータを取得する(サブクラス実装用)
def getRef
 次に書き込むバッファへの参照を取得する(サブクラス実装用)


説明

BufferBase 抽象クラス

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

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

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

から:
0.4.0

BufferBase.py51 行で定義されています。


関数

def length (   self  ) 

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

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

引数:
self 
戻り値:
バッファ長

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

BufferBase.py75 行で定義されています。

def write (   self,
  value 
)

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

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

引数:
self 
value 書き込み対象データ
戻り値:
データ書き込み結果(true:書き込み成功,false:書き込み失敗)

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

BufferBase.py97 行で定義されています。

def read (   self,
  value 
)

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

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

引数:
self 
value 読み出しデータ
戻り値:
データ読み出し結果(true:読み出し成功,false:読み出し失敗)

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

BufferBase.py119 行で定義されています。

def isFull (   self  ) 

バッファfullチェック(サブクラス実装用)

バッファfullチェック用関数
※サブクラスでの実装参照用

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

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

BufferBase.py140 行で定義されています。

def isEmpty (   self  ) 

バッファemptyチェック(サブクラス実装用)

バッファemptyチェック用関数
※サブクラスでの実装参照用

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

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

BufferBase.py161 行で定義されています。

def put (   self,
  data 
)

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

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

引数:
self 
data 対象データ

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

BufferBase.py181 行で定義されています。

def get (   self  ) 

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

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

引数:
self 
戻り値:
取得データ

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

BufferBase.py202 行で定義されています。

def getRef (   self  ) 

次に書き込むバッファへの参照を取得する(サブクラス実装用)

書き込みバッファへの参照取得用関数
※サブクラスでの実装参照用

引数:
self 
戻り値:
次の書き込み対象バッファへの参照

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

BufferBase.py223 行で定義されています。


OpenRTMに対してMon Mar 17 15:11:07 2008に生成されました。  doxygen 1.5.4