Public Member Functions | Protected Member Functions | Private Attributes
RTC::NullBuffer< DataType > Class Template Reference

Concrete buffer class for dummy. More...

#include <BufferBase.h>

Inheritance diagram for RTC::NullBuffer< DataType >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool isEmpty (void) const
 Check on whether the buffer is empty.
virtual bool isFull (void) const
 Check on whether the buffer is full.
virtual long int length (void) const
 Get the buffer length (always 1)
 NullBuffer (long int size=1)
 Constructer.
virtual bool read (DataType &value)
 Read data from the buffer.
virtual bool write (const DataType &value)
 Write data into the buffer.
virtual ~NullBuffer (void)
 Destructor.

Protected Member Functions

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

Private Attributes

DataType m_data
long int m_length

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:
DataTypeData type to hold in a buffer
Since:
0.4.0

Definition at line 552 of file BufferBase.h.


Constructor & Destructor Documentation

template<class DataType >
RTC::NullBuffer< DataType >::NullBuffer ( long int  size = 1) [inline]

Constructer.

Constructer. Initialize buffer length to always 1.

Parameters:
sizeBuffer length(Not use)

Definition at line 577 of file BufferBase.h.

template<class DataType >
virtual RTC::NullBuffer< DataType >::~NullBuffer ( void  ) [inline, virtual]

Destructor.

Destractor

Definition at line 597 of file BufferBase.h.


Member Function Documentation

template<class DataType >
virtual const DataType& RTC::NullBuffer< DataType >::get ( void  ) [inline, protected, virtual]

Get data from the buffer.

Get data from the buffer.

Returns:
Data got from buffer.

Implements RTC::BufferBase< DataType >.

Definition at line 775 of file BufferBase.h.

template<class DataType >
virtual DataType& RTC::NullBuffer< DataType >::getRef ( void  ) [inline, protected, virtual]

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)

Definition at line 802 of file BufferBase.h.

template<class DataType >
virtual bool RTC::NullBuffer< DataType >::isEmpty ( void  ) const [inline, virtual]

Check on whether the buffer is empty.

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

Returns:
Always false.

Definition at line 726 of file BufferBase.h.

template<class DataType >
virtual bool RTC::NullBuffer< DataType >::isFull ( void  ) const [inline, virtual]

Check on whether the buffer is full.

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

Returns:
Always false.

Definition at line 702 of file BufferBase.h.

template<class DataType >
virtual long int RTC::NullBuffer< DataType >::length ( void  ) const [inline, virtual]

Get the buffer length (always 1)

Get the buffer length. (Return always 1.)

Returns:
buffer length(always 1)

Implements RTC::BufferBase< DataType >.

Definition at line 620 of file BufferBase.h.

template<class DataType >
virtual void RTC::NullBuffer< DataType >::put ( const DataType &  data) [inline, protected, virtual]

Store data into the buffer.

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

Parameters:
dataTarget data to store.

Implements RTC::BufferBase< DataType >.

Definition at line 751 of file BufferBase.h.

template<class DataType >
virtual bool RTC::NullBuffer< DataType >::read ( DataType &  value) [inline, virtual]

Read data from the buffer.

Read data stored in the buffer.

Parameters:
valueRead data.
Returns:
Result of having read (true:Successful, false:Failed)

Definition at line 677 of file BufferBase.h.

template<class DataType >
virtual bool RTC::NullBuffer< DataType >::write ( const DataType &  value) [inline, virtual]

Write data into the buffer.

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

Parameters:
valueTarget data to write.
Returns:
Result of having written in data (true:Successful, false:Failed)

Definition at line 648 of file BufferBase.h.


Member Data Documentation

template<class DataType >
DataType RTC::NullBuffer< DataType >::m_data [private]

Definition at line 808 of file BufferBase.h.

template<class DataType >
long int RTC::NullBuffer< DataType >::m_length [private]

Definition at line 809 of file BufferBase.h.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Sun Mar 26 2017 03:37:20