リングバッファ実装クラス [詳解]

#include <RingBuffer.h>

RTC::RingBuffer< DataType > の継承関係図

RTC::RingBuffer< DataType > 連携図

公開メンバ関数
	RingBuffer (long int length=RINGBUFFER_DEFAULT_LENGTH)
	コンストラクタ [詳解]

virtual	~RingBuffer (void)
	仮想デストラクタ [詳解]

virtual void	init (const coil::Properties &prop)
	バッファの設定 [詳解]

virtual size_t	length (void) const
	バッファ長を取得する [詳解]

virtual ReturnCode	length (size_t n)
	バッファの長さをセットする [詳解]

virtual ReturnCode	reset ()
	バッファの状態をリセットする [詳解]

virtual DataType *	wptr (long int n=0)
	バッファの現在の書込み要素のポインタ [詳解]

virtual ReturnCode	advanceWptr (long int n=1, bool unlock_enable=true)
	書込みポインタを進める [詳解]

virtual ReturnCode	put (const DataType &value)
	バッファにデータを書き込む [詳解]

virtual ReturnCode	write (const DataType &value, long int sec=-1, long int nsec=0)
	バッファに書き込む [詳解]

virtual size_t	writable () const
	バッファに書込み可能な要素数 [詳解]

virtual bool	full (void) const
	バッファfullチェック [詳解]

virtual DataType *	rptr (long int n=0)
	バッファの現在の読み出し要素のポインタ [詳解]

virtual ReturnCode	advanceRptr (long int n=1, bool unlock_enable=true)
	読み出しポインタを進める [詳解]

virtual ReturnCode	get (DataType &value)
	バッファからデータを読み出す [詳解]

virtual DataType &	get ()
	バッファからデータを読み出す [詳解]

virtual ReturnCode	read (DataType &value, long int sec=-1, long int nsec=0)
	バッファから読み出す [詳解]

virtual size_t	readable () const
	バッファから読み出し可能な要素数 [詳解]

virtual bool	empty (void) const
	バッファemptyチェック [詳解]

基底クラス RTC::BufferBase< DataType > に属する継承公開メンバ関数
virtual BUFFERSTATUS_ENUM	~BufferBase (void)
	仮想デストラクタ [詳解]

公開変数類
BUFFERSTATUS_ENUM typedef coil::Guard< coil::Mutex >	Guard

その他の継承メンバ
基底クラス RTC::BufferStatus に属する継承公開型
enum	Enum { BUFFER_OK = 0, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY, NOT_SUPPORTED, TIMEOUT, PRECONDITION_NOT_MET }
	BufferStatus リターンコード [詳解]

基底クラス RTC::BufferStatus に属する継承静的公開メンバ関数
static const char *	toString (Enum status)
	BufferStatus リターンコードを文字列に変換 [詳解]

詳解

template<class DataType>
class RTC::RingBuffer< DataType >

リングバッファ実装クラス

指定した長さのリング状バッファを持つバッファ実装クラス。バッファ全体にデータが格納された場合、以降のデータは古いデータから順次上書きされる。従って、バッファ内には直近のバッファ長分のデータのみ保持される。

注)現在の実装では、一番最後に格納したデータのみバッファから読み出し可能

引数

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

から: 0.4.0

構築子と解体子

template<class DataType >

RTC::RingBuffer< DataType >::RingBuffer ( long int length = RINGBUFFER_DEFAULT_LENGTH )

inline

コンストラクタ

コンストラクタ指定されたバッファ長でバッファを初期化する。

引数

length バッファ長

参照先 RTC::RingBuffer< DataType >::reset().

template<class DataType >

virtual RTC::RingBuffer< DataType >::~RingBuffer ( void )

inlinevirtual

仮想デストラクタ

仮想デストラクタ。

関数詳解

template<class DataType >

virtual ReturnCode RTC::RingBuffer< DataType >::advanceRptr	(	long int	n = `1`,
		bool	unlock_enable = `true`
	)

inlinevirtual

読み出しポインタを進める

現在の読み出し位置のポインタを n 個進める。

引数

n	読み出しポインタ + n の位置のポインタ
unlock_enable	trueの場合にバッファフルのブロックを解除する

戻り値: BUFFER_OK: 正常終了 BUFFER_ERROR: 異常終了

n	書込みポインタ + n の位置のポインタ
unlock_enable	trueの場合にバッファエンプティのブロックを解除する

value	読み出し対象データ
sec	タイムアウト時間 sec (default -1: 無効)
nsec	タイムアウト時間 nsec (default 0)

value	書き込み対象データ
sec	タイムアウト時間 sec (default -1: 無効)
nsec	タイムアウト時間 nsec (default 0)

公開メンバ関数

公開変数類

その他の継承メンバ

詳解

template<class DataType> class RTC::RingBuffer< DataType >

構築子と解体子

関数詳解

メンバ詳解

template<class DataType>
class RTC::RingBuffer< DataType >