クラス OpenRTM_aist.BufferBase.NullBuffer

ダミーバッファ実装クラス [詳細]

OpenRTM_aist.BufferBase.NullBufferに対する継承グラフ
OpenRTM_aist.BufferBase.BufferBase OpenRTM_aist.BufferStatus.BufferStatus

すべてのメンバ一覧

Public メソッド

def __init__
 コンストラクタ
def length
 バッファ長(1固定)を取得する
def write
 バッファにデータを書き込む
def read
 バッファからデータを読み出す
def isFull
 バッファfullチェック
def isEmpty
 バッファemptyチェック
def isNew
 最新データか確認する
def put
 バッファにデータを格納
def get
 バッファからデータを取得する
def getRef
 次に書き込むバッファへの参照を取得する

説明

ダミーバッファ実装クラス

バッファ長が1固定のダミーバッファ実装クラス。

引数:
DataType バッファに格納するデータ型
から:
0.4.0

メソッド

def OpenRTM_aist.BufferBase.NullBuffer.__init__ (   self,
  size = None 
)

コンストラクタ

コンストラクタ バッファ長を1(固定)で初期化する。

引数:
self 
size バッファ長(デフォルト値:None,ただし無効)
def OpenRTM_aist.BufferBase.NullBuffer.get (   self  ) 

バッファからデータを取得する

バッファに格納されたデータを取得する。

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

OpenRTM_aist.BufferBase.BufferBaseを再定義しています。

def OpenRTM_aist.BufferBase.NullBuffer.getRef (   self  ) 

次に書き込むバッファへの参照を取得する

書き込みバッファへの参照を取得する。 本バッファ実装ではバッファ長は固定で1であるため, 常に同じ位置への参照を返す。

引数:
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  ) 

バッファ長(1固定)を取得する

バッファ長を取得する。(常に1を返す。)

引数:
self 
戻り値:
バッファ長(1固定)

OpenRTM_aist.BufferBase.BufferBaseを再定義しています。

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

バッファにデータを格納

引数で与えられたデータをバッファに格納する。

引数:
self 
data 対象データ

OpenRTM_aist.BufferBase.BufferBaseを再定義しています。

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:書き込み失敗)

OpenRTM_aist.BufferBase.BufferBaseを再定義しています。


このクラスの説明は次のファイルから生成されました:
OpenRTM-aist-1.1.0-Pythonに対してMon Mar 2 14:14:07 2015に生成されました。  doxygen 1.6.3