WriteInterface Class Template Reference

#include <rtt/WriteInterface.hpp>

Inheritance diagram for WriteInterface:

List of all members.

---

Detailed Description

template<class T>
class RTT::WriteInterface< T >

This interface describes a write interface for value types.

Parameters:

T

The value type write into this buffer.

Definition at line 52 of file WriteInterface.hpp.

Public Types
typedef T	value_t
typedef boost::call_traits < T >::param_type	param_t
typedef BufferBase::size_type	size_type
typedef boost::shared_ptr < BufferBase >	shared_ptr
Public Member Functions
virtual bool	Push (param_t item)=0
	Write a single value to the buffer.
virtual size_type	Push (const std::vector< value_t > &items)=0
	Write a sequence of values to the buffer.
virtual	~WriteInterface ()
virtual size_type	capacity () const =0
	Returns the maximum number of items that can be stored in the buffer.
virtual size_type	size () const =0
	Returns the actual number of items that are stored in the buffer.
virtual bool	empty () const =0
	Check if this buffer is empty.
virtual bool	full () const =0
	Check if this buffer is full.
virtual void	clear ()=0
	Clears all contents of this buffer.

---

Member Function Documentation

virtual bool Push

(

param_t

item

)

[pure virtual]

Write a single value to the buffer.

Parameters:

item

the value to write

Returns:

false if the buffer is full.

virtual size_type Push

(

const std::vector< value_t > &

items

)

[pure virtual]

Write a sequence of values to the buffer.

Parameters:

items

the values to write

Returns:

the number of values written (may be less than items.size())

Implemented in BufferLocked, BufferLockFree, and CorbaBufferProxy.

virtual size_type capacity

(

)

const [pure virtual, inherited]

Returns the maximum number of items that can be stored in the buffer.

Returns:

maximum number of items.

Implemented in BufferLocked, BufferLockFree, and CorbaBufferProxy.

virtual size_type size

(

)

const [pure virtual, inherited]

Returns the actual number of items that are stored in the buffer.

Returns:

number of items.

Implemented in BufferLocked, BufferLockFree, and CorbaBufferProxy.

virtual bool empty

(

)

const [pure virtual, inherited]

Check if this buffer is empty.

Returns:

true if size() == 0

Implemented in BufferLocked, BufferLockFree, and CorbaBufferProxy.

virtual bool full

(

)

const [pure virtual, inherited]

Check if this buffer is full.

Returns:

true if size() == capacity()

Implemented in BufferLocked, BufferLockFree, and CorbaBufferProxy.

---

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

• rtt/WriteInterface.hpp

---