Electronics and Software
Engineering Innovation
Beam-lib  2.15.1
BQueue< T > Class Template Reference

Queue class. More...

#include <BQueue.h>

Inheritance diagram for BQueue< T >:
BList< T >

Public Member Functions

 BQueue (BUInt size)
 
 ~BQueue ()
 
void clear ()
 Clear the queue. More...
 
BUInt writeAvailable () const
 
BError write (const T &v, BTimeout timeout=BTimeoutForever)
 Append an item onto the queue. More...
 
BUInt readAvailable () const
 
BError read (T &v, BTimeout timeout=BTimeoutForever)
 Get an item from the queue. More...
 

Private Attributes

BMutex olock
 
BUInt osize
 
BCondInt onumber
 
- Private Attributes inherited from BList< T >
Nodeonodes
 
unsigned int olength
 

Additional Inherited Members

- Private Types inherited from BList< T >
typedef int(* SortFunc) (T &a, T &b)
 Prototype for sorting function. More...
 
- Private Member Functions inherited from BList< T >
 BList ()
 
 BList (const BList< T > &l)
 
virtual ~BList ()
 
void start (BIter &i) const
 Iterator to start of list. More...
 
BIter begin () const
 Iterator for start of list. More...
 
BIter end () const
 Iterator for end of list. More...
 
BIter end (BIter &i) const
 Iterator for end of list. More...
 
void next (BIter &i) const
 Iterator for next item in list. More...
 
void prev (BIter &i)
 Iterator for previous item in list. More...
 
BIter goTo (int pos) const
 Iterator for pos item in list. More...
 
int position (BIter i)
 Postition in list item with iterator i. More...
 
unsigned int number () const
 Number of items in list. More...
 
unsigned int size () const
 Number of items in list. More...
 
int isEnd (BIter &i) const
 True if iterator refers to last item. More...
 
T & front ()
 Get first item in list. More...
 
T & rear ()
 Get last item in list. More...
 
T & get (BIter i)
 Get item specified by iterator in list. More...
 
const T & get (BIter i) const
 Get item specified by iterator in list. More...
 
void append (const T &item)
 Append item to list. More...
 
virtual void insert (BIter &i, const T &item)
 Insert item before item. More...
 
void insertAfter (BIter &i, const T &item)
 Insert item after item. More...
 
virtual void del (BIter &i)
 Delete specified item. More...
 
void deleteLast ()
 Delete last item. More...
 
void deleteFirst ()
 Delete fisrt item. More...
 
void push (const T &i)
 Push item onto list. More...
 
pop ()
 Pop item from list deleteing item. More...
 
void queueAdd (const T &i)
 Add item to end of list. More...
 
queueGet ()
 Get item from front of list deleteing item. More...
 
void append (const BList< T > &l)
 Append list to list. More...
 
int has (const T &i) const
 Checks if the item is in the list. More...
 
void swap (BIter i1, BIter i2)
 Swap two items in list. More...
 
void sort ()
 Sort list based on get(i) values. More...
 
void sort (SortFunc func)
 Sort list based on Sort func. More...
 
BList< T > & operator= (const BList< T > &l)
 
T & operator[] (int i)
 
const T & operator[] (int i) const
 
T & operator[] (BIter i)
 
const T & operator[] (const BIter &i) const
 
BList< T > operator+ (const BList< T > &l) const
 
virtual NodenodeGet (BIter i)
 
virtual const NodenodeGet (BIter i) const
 
virtual NodenodeCreate (const T &item)
 

Detailed Description

template<class T>
class BQueue< T >

Queue class.

Constructor & Destructor Documentation

◆ BQueue()

template<class T >
BQueue< T >::BQueue ( BUInt  size)

◆ ~BQueue()

template<class T >
BQueue< T >::~BQueue ( )

Member Function Documentation

◆ clear()

template<class T >
void BQueue< T >::clear ( )
virtual

Clear the queue.

Reimplemented from BList< T >.

◆ read()

template<class T>
BError BQueue< T >::read ( T &  v,
BTimeout  timeout = BTimeoutForever 
)

Get an item from the queue.

◆ readAvailable()

template<class T >
BUInt BQueue< T >::readAvailable ( ) const

◆ write()

template<class T>
BError BQueue< T >::write ( const T &  v,
BTimeout  timeout = BTimeoutForever 
)

Append an item onto the queue.

◆ writeAvailable()

template<class T >
BUInt BQueue< T >::writeAvailable ( ) const

Member Data Documentation

◆ olock

template<class T>
BMutex BQueue< T >::olock
private

◆ onumber

template<class T>
BCondInt BQueue< T >::onumber
private

◆ osize

template<class T>
BUInt BQueue< T >::osize
private

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