RTT::base::BufferBase Class Reference
[Data Storage and Buffering classes.]

#include <BufferBase.hpp>

Inheritance diagram for RTT::base::BufferBase:

[legend]

List of all members.

Public Types
typedef boost::shared_ptr < BufferBase >	shared_ptr
typedef boost::shared_ptr < BufferBase >	shared_ptr
typedef int	size_type
typedef int	size_type
Public Member Functions
virtual size_type	capacity () const =0
virtual size_type	capacity () const =0
virtual void	clear ()=0
virtual void	clear ()=0
virtual bool	empty () const =0
virtual bool	empty () const =0
virtual bool	full () const =0
virtual bool	full () const =0
virtual size_type	size () const =0
virtual size_type	size () const =0
virtual	~BufferBase ()
virtual	~BufferBase ()

---

Detailed Description

Any Buffer has a capacity, size and can be empty or full. This class contains the type-independent methods of a Buffer.

Definition at line 52 of file install/include/rtt/base/BufferBase.hpp.

---

Member Typedef Documentation

typedef boost::shared_ptr< BufferBase > RTT::base::BufferBase::shared_ptr

Reimplemented in RTT::base::BufferInterface< T >, and RTT::base::BufferInterface< T >.

Definition at line 57 of file rtt/base/BufferBase.hpp.

typedef boost::shared_ptr< BufferBase > RTT::base::BufferBase::shared_ptr

Reimplemented in RTT::base::BufferInterface< T >, and RTT::base::BufferInterface< T >.

Definition at line 57 of file install/include/rtt/base/BufferBase.hpp.

typedef int RTT::base::BufferBase::size_type

Reimplemented in RTT::base::Buffer< T >, RTT::base::BufferInterface< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, RTT::base::BufferUnSync< T >, RTT::base::Buffer< T >, RTT::base::BufferInterface< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, and RTT::base::BufferUnSync< T >.

Definition at line 55 of file rtt/base/BufferBase.hpp.

typedef int RTT::base::BufferBase::size_type

Reimplemented in RTT::base::Buffer< T >, RTT::base::BufferInterface< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, RTT::base::BufferUnSync< T >, RTT::base::Buffer< T >, RTT::base::BufferInterface< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, and RTT::base::BufferUnSync< T >.

Definition at line 55 of file install/include/rtt/base/BufferBase.hpp.

---

Constructor & Destructor Documentation

BufferBase::~BufferBase

(

)

[virtual]

Definition at line 44 of file BufferBase.cpp.

virtual RTT::base::BufferBase::~BufferBase

(

)

[virtual]

---

Member Function Documentation

virtual size_type RTT::base::BufferBase::capacity

(

)

const [pure virtual]

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

Returns:

maximum number of items.

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, RTT::base::BufferUnSync< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, and RTT::base::BufferUnSync< T >.

virtual size_type RTT::base::BufferBase::capacity

(

)

const [pure virtual]

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

Returns:

maximum number of items.

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, RTT::base::BufferUnSync< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, and RTT::base::BufferUnSync< T >.

virtual void RTT::base::BufferBase::clear

(

)

[pure virtual]

Clears all contents of this buffer.

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, RTT::base::BufferUnSync< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, and RTT::base::BufferUnSync< T >.

virtual void RTT::base::BufferBase::clear

(

)

[pure virtual]

Clears all contents of this buffer.

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, RTT::base::BufferUnSync< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, and RTT::base::BufferUnSync< T >.

virtual bool RTT::base::BufferBase::empty

(

)

const [pure virtual]

Check if this buffer is empty.

Returns:

true if size() == 0

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, RTT::base::BufferUnSync< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, and RTT::base::BufferUnSync< T >.

virtual bool RTT::base::BufferBase::empty

(

)

const [pure virtual]

Check if this buffer is empty.

Returns:

true if size() == 0

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, RTT::base::BufferUnSync< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, and RTT::base::BufferUnSync< T >.

virtual bool RTT::base::BufferBase::full

(

)

const [pure virtual]

Check if this buffer is full.

Returns:

true if size() == capacity()

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, RTT::base::BufferUnSync< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, and RTT::base::BufferUnSync< T >.

virtual bool RTT::base::BufferBase::full

(

)

const [pure virtual]

Check if this buffer is full.

Returns:

true if size() == capacity()

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, RTT::base::BufferUnSync< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, and RTT::base::BufferUnSync< T >.

virtual size_type RTT::base::BufferBase::size

(

)

const [pure virtual]

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

Returns:

number of items.

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, RTT::base::BufferUnSync< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, and RTT::base::BufferUnSync< T >.

virtual size_type RTT::base::BufferBase::size

(

)

const [pure virtual]

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

Returns:

number of items.

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, RTT::base::BufferUnSync< T >, RTT::base::BufferLocked< T >, RTT::base::BufferLockFree< T >, and RTT::base::BufferUnSync< T >.

---

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

• install/include/rtt/base/BufferBase.hpp
• rtt/base/BufferBase.hpp
• BufferBase.cpp