Implements a very simple blocking thread-safe buffer, using mutexes (locks). More...

#include <rtt/base/BufferLocked.hpp>

Inheritance diagram for RTT::base::BufferLocked< T >:

Public Types
typedef BufferBase::Options	Options

typedef BufferInterface< T >::reference_t	reference_t

typedef BufferInterface< T >::param_t	param_t

typedef BufferInterface< T >::size_type	size_type

typedef T	value_t

typedef boost::shared_ptr< BufferInterface< T > >	shared_ptr

Public Member Functions
	BufferLocked (size_type size, const Options &options=Options())
	Create an unitialized buffer of size size, with preallocated data storage. More...

	BufferLocked (size_type size, param_t initial_value, const Options &options=Options())
	Create a buffer of size size, with preallocated data storage. More...

virtual bool	data_sample (param_t sample, bool reset=true)
	Initializes this buffer with a data sample, such that for dynamical allocated types T, the buffer can reserve place to hold these elements. More...

virtual value_t	data_sample () const
	Reads back a data sample. More...

	~BufferLocked ()
	Destructor. More...

bool	Push (param_t item)
	Write a single value to the buffer. More...

size_type	Push (const std::vector< value_t > &items)
	Write a sequence of values to the buffer. More...

FlowStatus	Pop (reference_t item)
	Read the oldest value from the buffer. More...

size_type	Pop (std::vector< value_t > &items)
	Read the whole buffer. More...

value_t *	PopWithoutRelease ()
	Returns a pointer to the first element in the buffer. More...

void	Release (value_t *item)
	Releases the pointer. More...

size_type	capacity () const
	Returns the maximum number of items that can be stored in the buffer. More...

size_type	size () const
	Returns the actual number of items that are stored in the buffer. More...

void	clear ()
	Clears all contents of this buffer. More...

bool	empty () const
	Check if this buffer is empty. More...

bool	full () const
	Check if this buffer is full. More...

size_type	dropped () const
	Returns the number of dropped samples, because the buffer was full. More...

Detailed Description

template<class T>
class RTT::base::BufferLocked< T >

Implements a very simple blocking thread-safe buffer, using mutexes (locks).

See also: BufferLockFree

Definition at line 61 of file BufferLocked.hpp.

Member Typedef Documentation

template<class T>

typedef BufferBase::Options RTT::base::BufferLocked< T >::Options

Definition at line 65 of file BufferLocked.hpp.

template<class T>

typedef BufferInterface<T>::param_t RTT::base::BufferLocked< T >::param_t

Definition at line 67 of file BufferLocked.hpp.

template<class T>

typedef BufferInterface<T>::reference_t RTT::base::BufferLocked< T >::reference_t

Definition at line 66 of file BufferLocked.hpp.

template<class T>

typedef boost::shared_ptr< BufferInterface<T> > RTT::base::BufferInterface< T >::shared_ptr

inherited

Definition at line 63 of file BufferInterface.hpp.

template<class T>

typedef BufferInterface<T>::size_type RTT::base::BufferLocked< T >::size_type

Definition at line 68 of file BufferLocked.hpp.

template<class T>

typedef T RTT::base::BufferLocked< T >::value_t

Definition at line 69 of file BufferLocked.hpp.

Constructor & Destructor Documentation

template<class T>

RTT::base::BufferLocked< T >::BufferLocked	(	size_type	size,
		const Options &	options = `Options()`
	)

inline

Create an unitialized buffer of size size, with preallocated data storage.

Parameters

size	The number of elements this buffer can hold.

Definition at line 75 of file BufferLocked.hpp.

template<class T>

RTT::base::BufferLocked< T >::BufferLocked	(	size_type	size,
		param_t	initial_value,
		const Options &	options = `Options()`
	)

inline

Create a buffer of size size, with preallocated data storage.

Parameters

size	The number of elements this buffer can hold.
initial_value	A data sample with which each preallocated data element is initialized.

Definition at line 85 of file BufferLocked.hpp.

References RTT::base::BufferLocked< T >::data_sample().

template<class T>

RTT::base::BufferLocked< T >::~BufferLocked ( )

inline

Destructor.

Definition at line 113 of file BufferLocked.hpp.

Member Function Documentation

template<class T>

size_type RTT::base::BufferLocked< T >::capacity ( ) const

inlinevirtual

Returns the maximum number of items that can be stored in the buffer.

Returns: maximum number of items.

Implements RTT::base::BufferBase.

Definition at line 212 of file BufferLocked.hpp.

template<class T>

void RTT::base::BufferLocked< T >::clear ( )

inlinevirtual

Clears all contents of this buffer.

Implements RTT::base::BufferBase.

Definition at line 222 of file BufferLocked.hpp.

template<class T>

virtual bool RTT::base::BufferLocked< T >::data_sample	(	param_t	sample,
		bool	reset = `true`
	)

inlinevirtual

Initializes this buffer with a data sample, such that for dynamical allocated types T, the buffer can reserve place to hold these elements.

Parameters

sample	the data sample
reset	enforce reinitialization even if this operation clears all data.

Returns: true if the buffer was successfully (re)initialized.

Postcondition: Calling this function causes all data in the buffer to be lost and the size being reset to zero.

Implements RTT::base::BufferInterface< T >.

Definition at line 91 of file BufferLocked.hpp.

template<class T>

virtual value_t RTT::base::BufferLocked< T >::data_sample ( ) const

inlinevirtual

Reads back a data sample.

Implements RTT::base::BufferInterface< T >.

Definition at line 105 of file BufferLocked.hpp.

Referenced by RTT::base::BufferLocked< T >::BufferLocked().

template<class T>

size_type RTT::base::BufferLocked< T >::dropped ( ) const

inlinevirtual

Returns the number of dropped samples, because the buffer was full.

Implements RTT::base::BufferBase.

Definition at line 237 of file BufferLocked.hpp.

template<class T>

bool RTT::base::BufferLocked< T >::empty ( ) const

inlinevirtual

Check if this buffer is empty.

Returns: true if size() == 0

Implements RTT::base::BufferBase.

Definition at line 227 of file BufferLocked.hpp.

template<class T>

bool RTT::base::BufferLocked< T >::full ( ) const

inlinevirtual

Check if this buffer is full.

Returns: true if size() == capacity()

Implements RTT::base::BufferBase.

Definition at line 232 of file BufferLocked.hpp.

template<class T>

FlowStatus RTT::base::BufferLocked< T >::Pop ( reference_t item )

inlinevirtual

Read the oldest value from the buffer.

Parameters

item	is to be set with a value from the buffer.

Returns: true if something was read.

Implements RTT::base::BufferInterface< T >.

Definition at line 167 of file BufferLocked.hpp.

References RTT::NewData, and RTT::NoData.

template<class T>

size_type RTT::base::BufferLocked< T >::Pop ( std::vector< value_t > & items )

inlinevirtual

Read the whole buffer.

Parameters

items is to be filled with all values in the buffer, with items.begin() the oldest value.

Returns: the number of items read.

Implements RTT::base::BufferInterface< T >.

Definition at line 178 of file BufferLocked.hpp.

template<class T>

value_t* RTT::base::BufferLocked< T >::PopWithoutRelease ( )

inlinevirtual

Returns a pointer to the first element in the buffer.

The pointer is only garanteed to stay valid until the next pop operation.

Note the pointer needs the be released by calling Release on the buffer.

Returns: a pointer to a sample or Zero if buffer is empty

Implements RTT::base::BufferInterface< T >.

Definition at line 191 of file BufferLocked.hpp.

template<class T>

bool RTT::base::BufferLocked< T >::Push ( param_t item )

inlinevirtual

Write a single value to the buffer.

Parameters

item	the value to write

Returns: false if the buffer is full.

Implements RTT::base::BufferInterface< T >.

Definition at line 115 of file BufferLocked.hpp.

template<class T>

size_type RTT::base::BufferLocked< T >::Push ( const std::vector< value_t > & items )

inlinevirtual

Write a sequence of values to the buffer.

Parameters

items the values to write

Returns: the number of values written (may be less than items.size())

Implements RTT::base::BufferInterface< T >.

Definition at line 132 of file BufferLocked.hpp.

template<class T>

void RTT::base::BufferLocked< T >::Release ( value_t * item )

inlinevirtual

Releases the pointer.

Parameters

item	pointer aquired using PopWithoutRelease()

Implements RTT::base::BufferInterface< T >.

Definition at line 205 of file BufferLocked.hpp.

template<class T>

size_type RTT::base::BufferLocked< T >::size ( ) const

inlinevirtual

Returns the actual number of items that are stored in the buffer.

Returns: number of items.

Implements RTT::base::BufferBase.

Definition at line 217 of file BufferLocked.hpp.

The documentation for this class was generated from the following file:

rtt/base/BufferLocked.hpp

Public Types

Public Member Functions

Detailed Description

template<class T> class RTT::base::BufferLocked< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class T>
class RTT::base::BufferLocked< T >