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

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

#include <BufferBase.h>

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

すべてのメンバ一覧

Public メソッド
	NullBuffer (long int size=1)
	コンストラクタ
virtual	~NullBuffer (void)
	デストラクタ
virtual long int	length (void) const
	バッファ長(1固定)を取得する
virtual bool	write (const DataType &value)
	バッファにデータを書き込む
virtual bool	read (DataType &value)
	バッファからデータを読み出す
virtual bool	isFull (void) const
	バッファfullチェック
virtual bool	isEmpty (void) const
	バッファemptyチェック
Protected メソッド
virtual void	put (const DataType &data)
	バッファにデータを格納
virtual const DataType &	get (void)
	バッファからデータを取得する
virtual DataType &	getRef (void)
	次に書き込むバッファへの参照を取得する

---

説明

template<class DataType>
class RTC::NullBuffer< DataType >

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

バッファ長が１固定のダミーバッファ実装クラス。 <DataType>としてバッファ内で保持するデータ型を指定する。

引数:

DataType

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

から:

0.4.0

---

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

template<class DataType >

RTC::NullBuffer< DataType >::NullBuffer

(

long int

size = 1

)

[inline]

コンストラクタ

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

引数:

size

バッファ長(ただし無効)

template<class DataType >

virtual RTC::NullBuffer< DataType >::~NullBuffer

(

void

)

[inline, virtual]

デストラクタ

デストラクタ。

---

関数

template<class DataType >

virtual const DataType& RTC::NullBuffer< DataType >::get

(

void

)

[inline, protected, virtual]

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

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

戻り値:

取得データ

RTC::BufferBase< DataType >を実装しています。

template<class DataType >

virtual DataType& RTC::NullBuffer< DataType >::getRef

(

void

)

[inline, protected, virtual]

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

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

戻り値:

次の書き込み対象バッファへの参照(固定)

template<class DataType >

virtual bool RTC::NullBuffer< DataType >::isEmpty

(

void

)

const [inline, virtual]

バッファemptyチェック

バッファemptyをチェックする。(常にfalseを返す。)

戻り値:

emptyチェック結果(常にfalse)

template<class DataType >

virtual bool RTC::NullBuffer< DataType >::isFull

(

void

)

const [inline, virtual]

バッファfullチェック

バッファfullをチェックする。(常にfalseを返す。)

戻り値:

fullチェック結果(常にfalse)

template<class DataType >

virtual long int RTC::NullBuffer< DataType >::length

(

void

)

const [inline, virtual]

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

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

戻り値:

バッファ長(1固定)

RTC::BufferBase< DataType >を実装しています。

template<class DataType >

virtual void RTC::NullBuffer< DataType >::put

(

const DataType &

data

)

[inline, protected, virtual]

バッファにデータを格納

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

引数:

data

対象データ

RTC::BufferBase< DataType >を実装しています。

template<class DataType >

virtual bool RTC::NullBuffer< DataType >::read

(

DataType &

value

)

[inline, virtual]

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

バッファに格納されたデータを読み出す。

引数:

value

読み出したデータ

戻り値:

データ読み出し結果(true:読み出し成功，false:読み出し失敗)

template<class DataType >

virtual bool RTC::NullBuffer< DataType >::write

(

const DataType &

value

)

[inline, virtual]

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

引数で与えられたデータをバッファに書き込む。

引数:

value

書き込み対象データ

戻り値:

データ書き込み結果(true:書き込み成功，false:書き込み失敗)