Public Member Functions | Static Public Attributes | Private Attributes
InPortBase::RingBufferMock< DataType > Class Template Reference
Inheritance diagram for InPortBase::RingBufferMock< DataType >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ReturnCode advanceRptr (long int n=1)
 Forward n reading pointers.
virtual ReturnCode advanceWptr (long int n=1)
 Forward n writing pointers.
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)
 Read data from the buffer.
virtual DataType & get ()
 Read 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)
 Set 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=-1)
 Read data from the buffer.
virtual size_t readable () const
 Write data into the buffer.
virtual ReturnCode reset ()
 Reset the buffer status.
BUFFERSTATUS_ENUM RingBufferMock (long int length=8)
virtual DataType * rptr (long int n=0)
 Get the reading pointer.
void set_read_return_value (::RTC::BufferStatus::Enum value)
void setLogger (Logger *logger)
virtual DataType * wptr (long int n=0)
 Get the writing pointer.
virtual size_t writable () const
 Get a writable number.
virtual ReturnCode write (const DataType &value, long int sec=-1, long int nsec=-1)
 Write data into the buffer.
virtual ~RingBufferMock (void)

Static Public Attributes

static Logger logger

Private Attributes

std::vector< DataType > m_buffer
DataType m_data
Loggerm_logger
::RTC::BufferStatus::Enum m_read_return_value

Detailed Description

template<class DataType>
class InPortBase::RingBufferMock< DataType >

Definition at line 171 of file InPortBaseTests.cpp.


Constructor & Destructor Documentation

template<class DataType >
BUFFERSTATUS_ENUM InPortBase::RingBufferMock< DataType >::RingBufferMock ( long int  length = 8) [inline]

Definition at line 176 of file InPortBaseTests.cpp.

template<class DataType >
virtual InPortBase::RingBufferMock< DataType >::~RingBufferMock ( void  ) [inline, virtual]

Definition at line 182 of file InPortBaseTests.cpp.


Member Function Documentation

template<class DataType >
virtual ReturnCode InPortBase::RingBufferMock< DataType >::advanceRptr ( long int  n = 1) [inline, virtual]

Forward n reading pointers.

Pure virtual function to forward n reading pointers.

Returns:
BUFFER_OK: Successful BUFFER_ERROR: Failed

Implements RTC::BufferBase< DataType >.

Definition at line 287 of file InPortBaseTests.cpp.

template<class DataType >
virtual ReturnCode InPortBase::RingBufferMock< DataType >::advanceWptr ( long int  n = 1) [inline, virtual]

Forward n writing pointers.

Pure virtual function to forward n writing pointers.

Returns:
BUFFER_OK: Successful BUFFER_ERROR: Failed

Implements RTC::BufferBase< DataType >.

Definition at line 238 of file InPortBaseTests.cpp.

template<class DataType >
virtual bool InPortBase::RingBufferMock< DataType >::empty ( void  ) const [inline, virtual]

Check on whether the buffer is empty.

Pure virtual function to check on whether the buffer is empty.

Returns:
True if the buffer is empty, else false.

Implements RTC::BufferBase< DataType >.

Definition at line 333 of file InPortBaseTests.cpp.

template<class DataType >
virtual bool InPortBase::RingBufferMock< DataType >::full ( void  ) const [inline, virtual]

Check on whether the buffer is full.

Pure virtual function to check on whether the buffer is full.

Returns:
True if the buffer is full, else false.

Implements RTC::BufferBase< DataType >.

Definition at line 271 of file InPortBaseTests.cpp.

template<class DataType >
virtual ReturnCode InPortBase::RingBufferMock< DataType >::get ( DataType &  value) [inline, virtual]

Read data from the buffer.

Pure virtual function to read data form the buffer.

Parameters:
valueData to read.
Returns:
BUFFER_OK: Successful BUFFER_ERROR: Failed

Implements RTC::BufferBase< DataType >.

Definition at line 295 of file InPortBaseTests.cpp.

template<class DataType >
virtual DataType& InPortBase::RingBufferMock< DataType >::get ( ) [inline, virtual]

Read data from the buffer.

Pure virtual function to read data from the buffer.

Returns:
Data got from buffer.

Implements RTC::BufferBase< DataType >.

Definition at line 303 of file InPortBaseTests.cpp.

template<class DataType >
virtual void InPortBase::RingBufferMock< DataType >::init ( const coil::Properties prop) [inline, virtual]

Set the buffer.

Implements RTC::BufferBase< DataType >.

Definition at line 199 of file InPortBaseTests.cpp.

template<class DataType >
virtual size_t InPortBase::RingBufferMock< DataType >::length ( void  ) const [inline, virtual]

Get the buffer length.

Pure virtual function to get the buffer length.

Returns:
buffer length

Implements RTC::BufferBase< DataType >.

Definition at line 206 of file InPortBaseTests.cpp.

template<class DataType >
virtual ReturnCode InPortBase::RingBufferMock< DataType >::length ( size_t  n) [inline, virtual]

Set the buffer length.

Pure virtual function to set the buffer length.

Returns:
BUFFER_OK: Successful NOT_SUPPORTED: The buffer length cannot be set. BUFFER_ERROR: Failed

Implements RTC::BufferBase< DataType >.

Definition at line 214 of file InPortBaseTests.cpp.

template<class DataType >
virtual ReturnCode InPortBase::RingBufferMock< DataType >::put ( const DataType &  value) [inline, virtual]

Write data into the buffer.

Pure virtual function to write data into the buffer.

Parameters:
valueTarget data to write.
Returns:
BUFFER_OK: Successful BUFFER_ERROR: Failed

Implements RTC::BufferBase< DataType >.

Definition at line 246 of file InPortBaseTests.cpp.

template<class DataType >
virtual ReturnCode InPortBase::RingBufferMock< DataType >::read ( DataType &  value,
long int  sec = -1,
long int  nsec = -1 
) [inline, virtual]

Read data from the buffer.

Pure virtual function to read data from the buffer.

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

Implements RTC::BufferBase< DataType >.

Definition at line 311 of file InPortBaseTests.cpp.

template<class DataType >
virtual size_t InPortBase::RingBufferMock< DataType >::readable ( ) const [inline, virtual]

Write data into the buffer.

Pure virtual function to get a reading number.

Returns:
readable number

Implements RTC::BufferBase< DataType >.

Definition at line 325 of file InPortBaseTests.cpp.

template<class DataType >
virtual ReturnCode InPortBase::RingBufferMock< DataType >::reset ( ) [inline, virtual]

Reset the buffer status.

Pure virtual function to reset the buffer status.

Returns:
BUFFER_OK: Successful NOT_SUPPORTED: The buffer status cannot be reset. BUFFER_ERROR: Failed

Implements RTC::BufferBase< DataType >.

Definition at line 222 of file InPortBaseTests.cpp.

template<class DataType >
virtual DataType* InPortBase::RingBufferMock< DataType >::rptr ( long int  n = 0) [inline, virtual]

Get the reading pointer.

Pure virtual function to get the reading pointer.

Returns:
reading pointer

Implements RTC::BufferBase< DataType >.

Definition at line 279 of file InPortBaseTests.cpp.

template<class DataType >
void InPortBase::RingBufferMock< DataType >::set_read_return_value ( ::RTC::BufferStatus::Enum  value) [inline]

Definition at line 191 of file InPortBaseTests.cpp.

template<class DataType >
void InPortBase::RingBufferMock< DataType >::setLogger ( Logger logger) [inline]

Definition at line 341 of file InPortBaseTests.cpp.

template<class DataType >
virtual DataType* InPortBase::RingBufferMock< DataType >::wptr ( long int  n = 0) [inline, virtual]

Get the writing pointer.

Pure virtual function to get the writing pointer.

Parameters:
writeingpinter or n previous pointer
Returns:
writing pointer

Implements RTC::BufferBase< DataType >.

Definition at line 230 of file InPortBaseTests.cpp.

template<class DataType >
virtual size_t InPortBase::RingBufferMock< DataType >::writable ( ) const [inline, virtual]

Get a writable number.

Pure virtual function to get a writable number.

Returns:
value writable number

Implements RTC::BufferBase< DataType >.

Definition at line 263 of file InPortBaseTests.cpp.

template<class DataType >
virtual ReturnCode InPortBase::RingBufferMock< DataType >::write ( const DataType &  value,
long int  sec = -1,
long int  nsec = -1 
) [inline, virtual]

Write data into the buffer.

Pure virtual function to write data into the buffer.

Parameters:
valueTarget data to write.
Returns:
BUFFER_OK: Successful BUFFER_ERROR: Failed

Implements RTC::BufferBase< DataType >.

Definition at line 254 of file InPortBaseTests.cpp.


Member Data Documentation

template<class DataType >
Logger InPortBase::RingBufferMock< DataType >::logger [static]

Definition at line 346 of file InPortBaseTests.cpp.

template<class DataType >
std::vector<DataType> InPortBase::RingBufferMock< DataType >::m_buffer [private]

Definition at line 349 of file InPortBaseTests.cpp.

template<class DataType >
DataType InPortBase::RingBufferMock< DataType >::m_data [private]

Definition at line 348 of file InPortBaseTests.cpp.

template<class DataType >
Logger* InPortBase::RingBufferMock< DataType >::m_logger [private]

Definition at line 350 of file InPortBaseTests.cpp.

template<class DataType >
::RTC::BufferStatus::Enum InPortBase::RingBufferMock< DataType >::m_read_return_value [private]

Definition at line 351 of file InPortBaseTests.cpp.


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:19