Ring buffer implementation class. More...

#include <RingBuffer.h>

Inheritance diagram for RTC::RingBuffer< DataType >:

Classes
struct	condition
	struct for condition variable More...
Public Member Functions
virtual ReturnCode	advanceRptr (long int n=1)
	Get the buffer length.
virtual ReturnCode	advanceWptr (long int n=1)
	Get the buffer length.
virtual bool	empty (void) const
	Check on whether the buffer is empty.
virtual bool	full (void) const
	Check on whether the buffer is full.
virtual ReturnCode	get (DataType &value)
	Write data into the buffer.
virtual DataType &	get ()
	Reading data from the buffer.
virtual void	init (const coil::Properties &prop)
	Set the buffer.
virtual size_t	length (void) const
	Get the buffer length.
virtual ReturnCode	length (size_t n)
	Get the buffer length.
virtual ReturnCode	put (const DataType &value)
	Write data into the buffer.
virtual ReturnCode	read (DataType &value, long int sec=-1, long int nsec=0)
	Readout data from the buffer.
virtual size_t	readable () const
	Write data into the buffer.
virtual ReturnCode	reset ()
	Get the buffer length.
	RingBuffer (long int length=RINGBUFFER_DEFAULT_LENGTH)
	Constructor.
virtual DataType *	rptr (long int n=0)
	Get the buffer length.
virtual DataType *	wptr (long int n=0)
	Get the buffer length.
virtual size_t	writable () const
	Write data into the buffer.
virtual ReturnCode	write (const DataType &value, long int sec=-1, long int nsec=0)
	Write data into the buffer.
virtual	~RingBuffer (void)
	Virtual destractor.
Public Attributes
BUFFERSTATUS_ENUM typedef coil::Guard< coil::Mutex >	Guard
Private Member Functions
void	initLength (const coil::Properties &prop)
void	initReadPolicy (const coil::Properties &prop)
void	initWritePolicy (const coil::Properties &prop)
Private Attributes
std::vector< DataType >	m_buffer
	baffer array
condition	m_empty
	empty condition variable
size_t	m_fillcount
	Fill count.
condition	m_full
	full condition variable
size_t	m_length
	Buffer length.
bool	m_overwrite
	Overwrite flag.
coil::Mutex	m_posmutex
	mutex for position variable
bool	m_readback
	Readback flag.
size_t	m_rpos
	poitner to read
coil::TimeValue	m_rtimeout
	Timeout time of reading.
bool	m_timedread
	Timedread flag.
bool	m_timedwrite
	Timedwrite flag.
size_t	m_wcount
	Counter for writing.
size_t	m_wpos
	pointer to write
coil::TimeValue	m_wtimeout
	Timeout time for writing.

Detailed Description

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

Ring buffer implementation class.

This is the buffer implementation class with ring shaped buffer of specified length. If data is stored in the entire buffer, data from now on will be overwritten from old data one by one. Therefore, only the length of latest data is stored in the buffer.

Note: In the current implementation, only last stored data can be read from the buffer.

Parameters:

DataType Data type to store in the buffer

Since:: 0.4.0

Definition at line 89 of file RingBuffer.h.

Constructor & Destructor Documentation

template<class DataType>

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

Constructor.

Constructor. Initialize the buffer by specified buffer length. However, if the specified length is less than two, the buffer should be initialized by two in length.

Parameters:

length Buffer length

Definition at line 118 of file RingBuffer.h.

template<class DataType>

virtual RTC::RingBuffer< DataType >::~RingBuffer ( void ) [inline, virtual]

Virtual destractor.

Virtual destractor

Definition at line 144 of file RingBuffer.h.

Member Function Documentation

template<class DataType>

virtual ReturnCode RTC::RingBuffer< DataType >::advanceRptr ( long int n = 1 ) [inline, virtual]

Get the buffer length.

Pure virtual function to get the buffer length.

Returns:: buffer length

virtual ReturnCode RTC::RingBuffer< DataType >::read	(	DataType &	value,
		long int	sec = `-1`,
		long int	nsec = `0`
	)		`[inline, virtual]`

virtual ReturnCode RTC::RingBuffer< DataType >::write	(	const DataType &	value,
		long int	sec = `-1`,
		long int	nsec = `0`
	)		`[inline, virtual]`

Classes

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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