RTC::NullBuffer< DataType > Class Template Reference

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.
virtual	~NullBuffer ()=default
	Destructor.
virtual long int	length () const
	Get the buffer length (always 1)
virtual bool	write (const DataType &value)
	Write data into the buffer.
virtual bool	read (DataType &value)
	Read data from the buffer.
virtual bool	isFull () const
	Check on whether the buffer is full.
virtual bool	isEmpty () const
	Check on whether the buffer is empty.
Public Member Functions inherited from RTC::BufferBase< DataType >
virtual	~BufferBase ()=default
	Virtual destructor.
virtual void	init (const coil::Properties &prop)=0
	Set the buffer.
virtual BufferStatus	length (size_t n)=0
	Set the buffer length.
virtual BufferStatus	reset ()=0
	Reset the buffer status.
virtual DataType *	wptr (long int n=0)=0
	Get the writing pointer.
virtual BufferStatus	advanceWptr (long int n=1, bool unlock_enable=true)=0
	Forward n writing pointers.
virtual BufferStatus	write (const DataType &value, std::chrono::nanoseconds timeout=std::chrono::nanoseconds(-1))=0
	Write data into the buffer.
virtual size_t	writable () const =0
	Get a writable number.
virtual bool	full () const =0
	Check on whether the buffer is full.
virtual DataType *	rptr (long int n=0)=0
	Get the reading pointer.
virtual BufferStatus	advanceRptr (long int n=1, bool unlock_enable=true)=0
	Forward n reading pointers.
virtual BufferStatus	get (DataType &value)=0
	Read data from the buffer.
virtual BufferStatus	read (DataType &value, std::chrono::nanoseconds nsec=std::chrono::nanoseconds(-1))=0
	Read data from the buffer.
virtual size_t	readable () const =0
	Write data into the buffer.
virtual bool	empty () const =0
	Check on whether the buffer is empty.

Protected Member Functions
virtual void	put (const DataType &data)
	Store data into the buffer.
virtual const DataType &	get ()
	Get data from the buffer.
virtual DataType &	getRef ()
	Get the buffer's reference to be written the next.

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

NullBuffer()

template<class DataType >

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

inlineexplicit

Constructer.

Constructer. Initialize buffer length to always 1.

Parameters

size	Buffer length(Not use)

~NullBuffer()

template<class DataType >

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

virtualdefault

Destructor.

Destractor

Member Function Documentation

get()

template<class DataType >

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

inlineprotectedvirtual

Get data from the buffer.

Get data from the buffer.

Returns

Data got from buffer.

Implements RTC::BufferBase< DataType >.

getRef()

template<class DataType >

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

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)

isEmpty()

template<class DataType >

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

inlinevirtual

Check on whether the buffer is empty.

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

Returns

Always false.

isFull()

template<class DataType >

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

inlinevirtual

Check on whether the buffer is full.

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

Returns

Always false.

length()

template<class DataType >

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

inlinevirtual

Get the buffer length (always 1)

Get the buffer length. (Return always 1.)

Returns

buffer length(always 1)

Implements RTC::BufferBase< DataType >.

put()

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 >.

read()

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)

write()

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