クラス テンプレート RTC::BufferBase< DataType >

BufferBase 抽象クラス [詳細]

#include <BufferBase.h>

RTC::BufferBase< DataType >に対する継承グラフ

RTC::NullBuffer< DataType > RTC::RingBuffer< DataType > RTC::SyncFIFO< DataType > RTC::SyncLIFO< DataType >

すべてのメンバ一覧

Public メソッド

virtual ~BufferBase ()
 仮想デストラクタ
virtual long int length () const =0
 バッファの長さを取得する
virtual bool write (const DataType &value)=0
 バッファにデータを書き込む
virtual bool read (DataType &value)=0
 バッファからデータを読み出す
virtual bool isFull () const =0
 バッファfullチェック
virtual bool isEmpty () const =0
 バッファemptyチェック

Protected メソッド

virtual void put (const DataType &data)=0
 バッファにデータを格納する
virtual const DataType & get ()=0
 バッファからデータを取得する
virtual DataType & getRef ()=0
 次に書き込むバッファへの参照を取得する


説明

template<class DataType>
class RTC::BufferBase< DataType >

BufferBase 抽象クラス

種々のバッファのための抽象インターフェースクラス。 具象バッファクラスは、以下の純粋仮想関数の実装を提供しなければならない。 <DataType>としてバッファ内で保持するデータ型を指定する。

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

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

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

コンストラクタとデストラクタ

template<class DataType>
virtual RTC::BufferBase< DataType >::~BufferBase (  )  [inline, virtual]

仮想デストラクタ


関数

template<class DataType>
virtual long int RTC::BufferBase< DataType >::length (  )  const [pure virtual]

バッファの長さを取得する

バッファ長を取得するための純粋仮想関数

戻り値:
バッファ長

RTC::NullBuffer< DataType >, RTC::RingBuffer< DataType >, RTC::SyncFIFO< DataType >, と RTC::SyncLIFO< DataType >で実装されています。

template<class DataType>
virtual bool RTC::BufferBase< DataType >::write ( const DataType &  value  )  [pure virtual]

バッファにデータを書き込む

バッファにデータを書き込むための純粋仮想関数

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

RTC::NullBuffer< DataType >, RTC::RingBuffer< DataType >, RTC::SyncFIFO< DataType >, と RTC::SyncLIFO< DataType >で実装されています。

template<class DataType>
virtual bool RTC::BufferBase< DataType >::read ( DataType &  value  )  [pure virtual]

バッファからデータを読み出す

バッファからデータを読み出すための純粋仮想関数

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

RTC::NullBuffer< DataType >, RTC::RingBuffer< DataType >, RTC::SyncFIFO< DataType >, と RTC::SyncLIFO< DataType >で実装されています。

template<class DataType>
virtual bool RTC::BufferBase< DataType >::isFull (  )  const [pure virtual]

バッファfullチェック

バッファfullチェック用純粋仮想関数

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

RTC::NullBuffer< DataType >, RTC::RingBuffer< DataType >, RTC::SyncFIFO< DataType >, と RTC::SyncLIFO< DataType >で実装されています。

template<class DataType>
virtual bool RTC::BufferBase< DataType >::isEmpty (  )  const [pure virtual]

バッファemptyチェック

バッファemptyチェック用純粋仮想関数

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

RTC::NullBuffer< DataType >, RTC::RingBuffer< DataType >, RTC::SyncFIFO< DataType >, と RTC::SyncLIFO< DataType >で実装されています。

template<class DataType>
virtual void RTC::BufferBase< DataType >::put ( const DataType &  data  )  [protected, pure virtual]

バッファにデータを格納する

バッファへのデータ格納用純粋仮想関数

引数:
data 対象データ

RTC::NullBuffer< DataType >, RTC::RingBuffer< DataType >, RTC::SyncFIFO< DataType >, と RTC::SyncLIFO< DataType >で実装されています。

template<class DataType>
virtual const DataType& RTC::BufferBase< DataType >::get (  )  [protected, pure virtual]

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

バッファに格納されたデータ取得用純粋仮想関数

戻り値:
取得データ

RTC::NullBuffer< DataType >, RTC::RingBuffer< DataType >, RTC::SyncFIFO< DataType >, と RTC::SyncLIFO< DataType >で実装されています。

template<class DataType>
virtual DataType& RTC::BufferBase< DataType >::getRef (  )  [protected, pure virtual]

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

書き込みバッファへの参照取得用純粋仮想関数

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

RTC::NullBuffer< DataType >, と RTC::RingBuffer< DataType >で実装されています。


OpenRTMに対してWed May 21 05:17:25 2008に生成されました。  doxygen 1.5.3