Concrete buffer class for dummy. More...

#include <BufferBase.h>

Inheritance diagram for RTC::NullBuffer< DataType >:

Collaboration diagram for RTC::NullBuffer< DataType >:

Public Member Functions
	NullBuffer (long int size=1)
	Constructer. More...

virtual	~NullBuffer (void)
	Destructor. More...

virtual long int	length (void) const
	Get the buffer length (always 1) More...

virtual bool	write (const DataType &value)
	Write data into the buffer. More...

virtual bool	read (DataType &value)
	Read data from the buffer. More...

virtual bool	isFull (void) const
	Check on whether the buffer is full. More...

virtual bool	isEmpty (void) const
	Check on whether the buffer is empty. More...

Public Member Functions inherited from RTC::BufferBase< DataType >
virtual BUFFERSTATUS_ENUM	~BufferBase (void)
	Virtual destructor. More...

virtual void	init (const coil::Properties &prop)=0
	Set the buffer. More...

virtual ReturnCode	length (size_t n)=0
	Set the buffer length. More...

virtual ReturnCode	reset ()=0
	Reset the buffer status. More...

virtual DataType *	wptr (long int n=0)=0
	Get the writing pointer. More...

virtual ReturnCode	advanceWptr (long int n=1, bool unlock_enable=true)=0
	Forward n writing pointers. More...

virtual ReturnCode	write (const DataType &value, long int sec=-1, long int nsec=-1)=0
	Write data into the buffer. More...

virtual size_t	writable () const =0
	Get a writable number. More...

virtual bool	full (void) const =0
	Check on whether the buffer is full. More...

virtual DataType *	rptr (long int n=0)=0
	Get the reading pointer. More...

virtual ReturnCode	advanceRptr (long int n=1, bool unlock_enable=true)=0
	Forward n reading pointers. More...

virtual ReturnCode	get (DataType &value)=0
	Read data from the buffer. More...

virtual ReturnCode	read (DataType &value, long int sec=-1, long int nsec=-1)=0
	Read data from the buffer. More...

virtual size_t	readable () const =0
	Write data into the buffer. More...

virtual bool	empty (void) const =0
	Check on whether the buffer is empty. More...

Protected Member Functions
virtual void	put (const DataType &data)
	Store data into the buffer. More...

virtual const DataType &	get (void)
	Get data from the buffer. More...

virtual DataType &	getRef (void)
	Get the buffer's reference to be written the next. More...

Additional Inherited Members
Public Types inherited from RTC::BufferStatus
enum	Enum { BUFFER_OK = 0, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY, NOT_SUPPORTED, TIMEOUT, PRECONDITION_NOT_MET }
	DataPortStatus return codes. More...

Static Public Member Functions inherited from RTC::BufferStatus
static const char *	toString (Enum status)
	Convert BufferStatus into the string. More...

Detailed Description

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

Concrete buffer class for dummy.

Concrete buffer class for dummy. Buffer length is fixed to 1. The users specify data type to hold it in a buffer as <DataType>.

Parameters

DataType Data type to hold in a buffer

Since: 0.4.0

Constructor & Destructor Documentation

template<class DataType >

RTC::NullBuffer< DataType >::NullBuffer ( long int size = 1 )

inline

Constructer.

Constructer. Initialize buffer length to always 1.

Parameters

size	Buffer length(Not use)

template<class DataType >

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

inlinevirtual

Destructor.

Destractor

Member Function Documentation

template<class DataType >

virtual const DataType& RTC::NullBuffer< DataType >::get ( void )

inlineprotectedvirtual

Get data from the buffer.

Returns: Data got from buffer.

Implements RTC::BufferBase< DataType >.

template<class DataType >

virtual DataType& RTC::NullBuffer< DataType >::getRef ( void )

inlineprotectedvirtual

Get the buffer's reference to be written the next.

Get the reference to be written buffer. Return always same position because this buffer's length is always 1.

Returns: Reference to be written the next(always same)

template<class DataType >

virtual bool RTC::NullBuffer< DataType >::isEmpty ( void ) const

inlinevirtual

Check on whether the buffer is empty.

Check on whether the buffer is empty. (Always false.)

Returns: Always false.

template<class DataType >

virtual bool RTC::NullBuffer< DataType >::isFull ( void ) const

inlinevirtual

Check on whether the buffer is full.

Check on whether the buffer is full. (Always false.)

Returns: Always false.

template<class DataType >

virtual long int RTC::NullBuffer< DataType >::length ( void ) const

inlinevirtual

Get the buffer length (always 1)

Get the buffer length. (Return always 1.)

Returns: buffer length(always 1)

Implements RTC::BufferBase< DataType >.

template<class DataType >

virtual void RTC::NullBuffer< DataType >::put ( const DataType & data )

inlineprotectedvirtual

Store data into the buffer.

Store data which were given with an argument into the buffer.

Parameters

data	Target data to store.

Implements RTC::BufferBase< DataType >.

template<class DataType >

virtual bool RTC::NullBuffer< DataType >::read ( DataType & value )

inlinevirtual

Read data from the buffer.

Read data stored in the buffer.

Parameters

value Read data.

Returns: Result of having read (true:Successful, false:Failed)

template<class DataType >

virtual bool RTC::NullBuffer< DataType >::write ( const DataType & value )

inlinevirtual

Write data into the buffer.

Write data which were given with an argument into the buffer.

Parameters

value Target data to write.

Returns: Result of having written in data (true:Successful, false:Failed)

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

BufferBase.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

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