Public Member Functions | Static Public Attributes | Private Attributes | List of all members
InPortPushConnector::RingBufferMock< DataType > Class Template Reference
Inheritance diagram for InPortPushConnector::RingBufferMock< DataType >:
Inheritance graph
[legend]

Public Member Functions

virtual ReturnCode advanceRptr (long int n=1)
 Forward n reading pointers. More...
 
virtual ReturnCode advanceWptr (long int n=1)
 Forward n writing pointers. More...
 
virtual bool empty (void) const
 Check on whether the buffer is empty. More...
 
virtual bool full (void) const
 Check on whether the buffer is full. More...
 
virtual ReturnCode get (DataType &value)
 Read data from the buffer. More...
 
virtual DataType & get ()
 Read data from the buffer. More...
 
virtual void init (const coil::Properties &prop)
 Set the buffer. More...
 
virtual size_t length (void) const
 Get the buffer length. More...
 
virtual ReturnCode length (size_t n)
 Set the buffer length. More...
 
virtual ReturnCode put (const DataType &value)
 Write data into the buffer. More...
 
virtual ReturnCode read (DataType &value, long int sec=-1, long int nsec=-1)
 Read data from the buffer. More...
 
virtual size_t readable () const
 Write data into the buffer. More...
 
virtual ReturnCode reset ()
 Reset the buffer status. More...
 
BUFFERSTATUS_ENUM RingBufferMock (long int length=8)
 
virtual DataType * rptr (long int n=0)
 Get the reading pointer. More...
 
void set_read_return_value (::RTC::BufferStatus::Enum value)
 
void setLogger (Logger *logger)
 
virtual DataType * wptr (long int n=0)
 Get the writing pointer. More...
 
virtual size_t writable () const
 Get a writable number. More...
 
virtual ReturnCode write (const DataType &value, long int sec=-1, long int nsec=-1)
 Write data into the buffer. More...
 
virtual ~RingBufferMock (void)
 
- Public Member Functions inherited from RTC::BufferBase< DataType >
virtual BUFFERSTATUS_ENUM ~BufferBase (void)
 Virtual destructor. More...
 

Static Public Attributes

static Logger logger
 

Private Attributes

std::vector< DataType > m_buffer
 
DataType m_data
 
Logger * m_logger
 
::RTC::BufferStatus::Enum m_read_return_value
 

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 InPortPushConnector::RingBufferMock< DataType >

Definition at line 133 of file InPortPushConnectorTests.cpp.

Constructor & Destructor Documentation

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

Definition at line 138 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual InPortPushConnector::RingBufferMock< DataType >::~RingBufferMock ( void  )
inlinevirtual

Definition at line 144 of file InPortPushConnectorTests.cpp.

Member Function Documentation

template<class DataType >
virtual ReturnCode InPortPushConnector::RingBufferMock< DataType >::advanceRptr ( long int  n = 1)
inlinevirtual

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 249 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual ReturnCode InPortPushConnector::RingBufferMock< DataType >::advanceWptr ( long int  n = 1)
inlinevirtual

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 200 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual bool InPortPushConnector::RingBufferMock< DataType >::empty ( void  ) const
inlinevirtual

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 295 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual bool InPortPushConnector::RingBufferMock< DataType >::full ( void  ) const
inlinevirtual

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 233 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual ReturnCode InPortPushConnector::RingBufferMock< DataType >::get ( DataType &  value)
inlinevirtual

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 257 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual DataType& InPortPushConnector::RingBufferMock< DataType >::get ( )
inlinevirtual

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 265 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual void InPortPushConnector::RingBufferMock< DataType >::init ( const coil::Properties &  prop)
inlinevirtual

Set the buffer.

Implements RTC::BufferBase< DataType >.

Definition at line 161 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual size_t InPortPushConnector::RingBufferMock< DataType >::length ( void  ) const
inlinevirtual

Get the buffer length.

Pure virtual function to get the buffer length.

Returns
buffer length

Implements RTC::BufferBase< DataType >.

Definition at line 168 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual ReturnCode InPortPushConnector::RingBufferMock< DataType >::length ( size_t  n)
inlinevirtual

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 176 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual ReturnCode InPortPushConnector::RingBufferMock< DataType >::put ( const DataType &  value)
inlinevirtual

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 208 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual ReturnCode InPortPushConnector::RingBufferMock< DataType >::read ( DataType &  value,
long int  sec = -1,
long int  nsec = -1 
)
inlinevirtual

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 273 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual size_t InPortPushConnector::RingBufferMock< DataType >::readable ( ) const
inlinevirtual

Write data into the buffer.

Pure virtual function to get a reading number.

Returns
readable number

Implements RTC::BufferBase< DataType >.

Definition at line 287 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual ReturnCode InPortPushConnector::RingBufferMock< DataType >::reset ( )
inlinevirtual

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 184 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual DataType* InPortPushConnector::RingBufferMock< DataType >::rptr ( long int  n = 0)
inlinevirtual

Get the reading pointer.

Pure virtual function to get the reading pointer.

Returns
reading pointer

Implements RTC::BufferBase< DataType >.

Definition at line 241 of file InPortPushConnectorTests.cpp.

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

Definition at line 153 of file InPortPushConnectorTests.cpp.

template<class DataType >
void InPortPushConnector::RingBufferMock< DataType >::setLogger ( Logger *  logger)
inline

Definition at line 303 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual DataType* InPortPushConnector::RingBufferMock< DataType >::wptr ( long int  n = 0)
inlinevirtual

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 192 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual size_t InPortPushConnector::RingBufferMock< DataType >::writable ( ) const
inlinevirtual

Get a writable number.

Pure virtual function to get a writable number.

Returns
value writable number

Implements RTC::BufferBase< DataType >.

Definition at line 225 of file InPortPushConnectorTests.cpp.

template<class DataType >
virtual ReturnCode InPortPushConnector::RingBufferMock< DataType >::write ( const DataType &  value,
long int  sec = -1,
long int  nsec = -1 
)
inlinevirtual

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 216 of file InPortPushConnectorTests.cpp.

Member Data Documentation

template<class DataType >
Logger InPortPushConnector::RingBufferMock< DataType >::logger
static

Definition at line 308 of file InPortPushConnectorTests.cpp.

template<class DataType >
std::vector<DataType> InPortPushConnector::RingBufferMock< DataType >::m_buffer
private

Definition at line 311 of file InPortPushConnectorTests.cpp.

template<class DataType >
DataType InPortPushConnector::RingBufferMock< DataType >::m_data
private

Definition at line 310 of file InPortPushConnectorTests.cpp.

template<class DataType >
Logger* InPortPushConnector::RingBufferMock< DataType >::m_logger
private

Definition at line 312 of file InPortPushConnectorTests.cpp.

template<class DataType >
::RTC::BufferStatus::Enum InPortPushConnector::RingBufferMock< DataType >::m_read_return_value
private

Definition at line 313 of file InPortPushConnectorTests.cpp.

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

openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Jun 10 2019 14:08:01