Inheritance diagram for OutPortBase::RingBufferMock< DataType >:

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

Definition at line 252 of file OutPortBaseTests.cpp.

Constructor & Destructor Documentation

◆ RingBufferMock()

template<class DataType >

BUFFERSTATUS_ENUM OutPortBase::RingBufferMock< DataType >::RingBufferMock ( long int length = 8 )

inline

Definition at line 257 of file OutPortBaseTests.cpp.

◆ ~RingBufferMock()

template<class DataType >

virtual OutPortBase::RingBufferMock< DataType >::~RingBufferMock ( void )

inlinevirtual

Definition at line 263 of file OutPortBaseTests.cpp.

Member Function Documentation

◆ advanceRptr()

template<class DataType >

virtual ReturnCode OutPortBase::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 368 of file OutPortBaseTests.cpp.

◆ advanceWptr()

template<class DataType >

virtual ReturnCode OutPortBase::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 319 of file OutPortBaseTests.cpp.

◆ empty()

template<class DataType >

virtual bool OutPortBase::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 414 of file OutPortBaseTests.cpp.

◆ full()

template<class DataType >

virtual bool OutPortBase::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 352 of file OutPortBaseTests.cpp.

◆ get() [1/2]

template<class DataType >

virtual ReturnCode OutPortBase::RingBufferMock< DataType >::get ( DataType & value )

inlinevirtual

Read data from the buffer.

Pure virtual function to read data form the buffer.

Parameters

value Data to read.

Returns: BUFFER_OK: Successful BUFFER_ERROR: Failed

Implements RTC::BufferBase< DataType >.

Definition at line 376 of file OutPortBaseTests.cpp.

◆ get() [2/2]

template<class DataType >

virtual DataType& OutPortBase::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 384 of file OutPortBaseTests.cpp.

◆ init()

template<class DataType >

virtual void OutPortBase::RingBufferMock< DataType >::init ( const coil::Properties & prop )

inlinevirtual

Set the buffer.

Implements RTC::BufferBase< DataType >.

Definition at line 280 of file OutPortBaseTests.cpp.

◆ length() [1/2]

template<class DataType >

virtual size_t OutPortBase::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 287 of file OutPortBaseTests.cpp.

◆ length() [2/2]

template<class DataType >

virtual ReturnCode OutPortBase::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 295 of file OutPortBaseTests.cpp.

◆ put()

template<class DataType >

virtual ReturnCode OutPortBase::RingBufferMock< DataType >::put ( const DataType & value )

inlinevirtual

Write data into the buffer.

Pure virtual function to write data into the buffer.

Parameters

value Target data to write.

Returns: BUFFER_OK: Successful BUFFER_ERROR: Failed

Implements RTC::BufferBase< DataType >.

Definition at line 327 of file OutPortBaseTests.cpp.

◆ read()

template<class DataType >

virtual ReturnCode OutPortBase::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

value Read data.

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

Implements RTC::BufferBase< DataType >.

Definition at line 392 of file OutPortBaseTests.cpp.

◆ readable()

template<class DataType >

virtual size_t OutPortBase::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 406 of file OutPortBaseTests.cpp.

◆ reset()

template<class DataType >

virtual ReturnCode OutPortBase::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 303 of file OutPortBaseTests.cpp.

◆ rptr()

template<class DataType >

virtual DataType* OutPortBase::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 360 of file OutPortBaseTests.cpp.

◆ set_read_return_value()

template<class DataType >

void OutPortBase::RingBufferMock< DataType >::set_read_return_value ( ::RTC::BufferStatus::Enum value )

inline

Definition at line 272 of file OutPortBaseTests.cpp.

◆ setLogger()

template<class DataType >

void OutPortBase::RingBufferMock< DataType >::setLogger ( Logger * logger )

inline

Definition at line 422 of file OutPortBaseTests.cpp.

◆ wptr()

template<class DataType >

virtual DataType* OutPortBase::RingBufferMock< DataType >::wptr ( long int n = 0 )

inlinevirtual

Get the writing pointer.

Pure virtual function to get the writing pointer.

Parameters

writeing pinter or n previous pointer

Returns: writing pointer

Implements RTC::BufferBase< DataType >.

Definition at line 311 of file OutPortBaseTests.cpp.

◆ writable()

template<class DataType >

virtual size_t OutPortBase::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 344 of file OutPortBaseTests.cpp.

◆ write()

template<class DataType >

virtual ReturnCode OutPortBase::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

value Target data to write.

Returns: BUFFER_OK: Successful BUFFER_ERROR: Failed

Implements RTC::BufferBase< DataType >.

Definition at line 335 of file OutPortBaseTests.cpp.

Member Data Documentation

◆ logger

template<class DataType >

Logger OutPortBase::RingBufferMock< DataType >::logger

static

Definition at line 427 of file OutPortBaseTests.cpp.

◆ m_buffer

template<class DataType >

std::vector<DataType> OutPortBase::RingBufferMock< DataType >::m_buffer

private

Definition at line 430 of file OutPortBaseTests.cpp.

◆ m_data

template<class DataType >

DataType OutPortBase::RingBufferMock< DataType >::m_data

private

Definition at line 429 of file OutPortBaseTests.cpp.

◆ m_logger

template<class DataType >

Logger* OutPortBase::RingBufferMock< DataType >::m_logger

private

Definition at line 431 of file OutPortBaseTests.cpp.

◆ m_read_return_value

template<class DataType >

::RTC::BufferStatus::Enum OutPortBase::RingBufferMock< DataType >::m_read_return_value

private

Definition at line 432 of file OutPortBaseTests.cpp.

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

OutPortBaseTests.cpp

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

template<class DataType> class OutPortBase::RingBufferMock< DataType >

Constructor & Destructor Documentation

◆ RingBufferMock()

◆ ~RingBufferMock()

Member Function Documentation

◆ advanceRptr()

◆ advanceWptr()

◆ empty()

◆ full()

◆ get() [1/2]

◆ get() [2/2]

◆ init()

◆ length() [1/2]

◆ length() [2/2]

◆ put()

◆ read()

◆ readable()

◆ reset()

◆ rptr()

◆ set_read_return_value()

◆ setLogger()

◆ wptr()

◆ writable()

◆ write()

Member Data Documentation

◆ logger

◆ m_buffer

◆ m_data

◆ m_logger

◆ m_read_return_value

template<class DataType>
class OutPortBase::RingBufferMock< DataType >