Public Types | Public Member Functions | List of all members
RTT::base::Buffer< T > Class Template Reference

#include <Buffer.hpp>

Inheritance diagram for RTT::base::Buffer< T >:
Inheritance graph
[legend]

Public Types

typedef BufferInterface< T >::param_t param_t
 
typedef BufferInterface< T >::reference_t reference_t
 
typedef BufferInterface< T >::size_type size_type
 
typedef T value_t
 
- Public Types inherited from RTT::base::BufferLockFree< T >
typedef BufferBase::Options Options
 
typedef BufferInterface< T >::param_t param_t
 
typedef BufferInterface< T >::reference_t reference_t
 
typedef BufferInterface< T >::size_type size_type
 
typedef T value_t
 
- Public Types inherited from RTT::base::BufferInterface< T >
typedef boost::call_traits< T >::param_type param_t
 
typedef boost::call_traits< T >::reference reference_t
 
typedef boost::shared_ptr< BufferInterface< T > > shared_ptr
 
typedef BufferBase::size_type size_type
 
typedef T value_t
 
- Public Types inherited from RTT::base::BufferBase
typedef boost::shared_ptr< BufferBaseshared_ptr
 
typedef int size_type
 

Public Member Functions

 Buffer (int qsize, const T &initial_value=T())
 
- Public Member Functions inherited from RTT::base::BufferLockFree< T >
 BufferLockFree (unsigned int bufsize, const Options &options=Options())
 
 BufferLockFree (unsigned int bufsize, param_t initial_value, const Options &options=Options())
 
size_type capacity () const
 
void clear ()
 
virtual bool data_sample (param_t sample, bool reset=true)
 
virtual value_t data_sample () const
 
virtual size_type dropped () const
 
bool empty () const
 
bool full () const
 
FlowStatus Pop (reference_t item)
 
size_type Pop (std::vector< value_t > &items)
 
value_tPopWithoutRelease ()
 
bool Push (param_t item)
 
size_type Push (const std::vector< value_t > &items)
 
void Release (value_t *item)
 
size_type size () const
 
 ~BufferLockFree ()
 
- Public Member Functions inherited from RTT::base::BufferInterface< T >
virtual ~BufferInterface ()
 
- Public Member Functions inherited from RTT::base::BufferBase
virtual ~BufferBase ()
 

Additional Inherited Members

- Public Attributes inherited from RTT::base::BufferLockFree< T >
const unsigned int MAX_THREADS
 The maximum number of threads. More...
 

Detailed Description

template<class T>
class RTT::base::Buffer< T >

This object represents the default thread-safe buffer implementation used by Orocos objects.

Definition at line 67 of file Buffer.hpp.

Member Typedef Documentation

template<class T >
typedef BufferInterface<T>::param_t RTT::base::Buffer< T >::param_t

Definition at line 76 of file Buffer.hpp.

template<class T >
typedef BufferInterface<T>::reference_t RTT::base::Buffer< T >::reference_t

Definition at line 75 of file Buffer.hpp.

template<class T >
typedef BufferInterface<T>::size_type RTT::base::Buffer< T >::size_type

Definition at line 77 of file Buffer.hpp.

template<class T >
typedef T RTT::base::Buffer< T >::value_t

Definition at line 78 of file Buffer.hpp.

Constructor & Destructor Documentation

template<class T >
RTT::base::Buffer< T >::Buffer ( int  qsize,
const T &  initial_value = T() 
)
inline

Create a fifo queue of fixed size.

Definition at line 84 of file Buffer.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Fri Oct 25 2019 03:59:46