MeVisLab Toolbox Reference
Public Member Functions | List of all members
ml::WEMQueue< T > Class Template Reference

The WEMQueue is a single linked list with pointers to its head and tail elements. More...

#include <WEMQueue.h>

Public Member Functions

 WEMQueue ()
 Default constructor.
 
 WEMQueue (T *elem)
 Constructor takes a T as an argument and sets up a queue with that T as a single element (head and tail).
 
 ~WEMQueue ()
 Default destructor.
 
void append (T *elem)
 Appends a WEMQueueElement to the end of the queue.
 
void prepend (T *elem)
 Prepends a WEMQueueElement to the front of the queue.
 
void popFront ()
 Pops the head element.
 
unsigned int getSize () const
 Returns the number of elements in the queue.
 
WEMQueueElement< T > * getHead () const
 Returns the head element of the queue.
 
WEMQueueElement< T > * getTail () const
 Returns the tail element of the queue.
 

Detailed Description

template<class T>
class ml::WEMQueue< T >

The WEMQueue is a single linked list with pointers to its head and tail elements.

It provides the methods 'append(T*)' and 'popFront()', and information about the number of elements in the queue.

Definition at line 58 of file WEMQueue.h.

Constructor & Destructor Documentation

◆ WEMQueue() [1/2]

template<class T >
ml::WEMQueue< T >::WEMQueue ( )

Default constructor.

Definition at line 134 of file WEMQueue.h.

References mlrange_cast().

◆ WEMQueue() [2/2]

template<class T >
ml::WEMQueue< T >::WEMQueue ( T * elem)

Constructor takes a T as an argument and sets up a queue with that T as a single element (head and tail).

Definition at line 144 of file WEMQueue.h.

References mlrange_cast().

◆ ~WEMQueue()

template<class T >
ml::WEMQueue< T >::~WEMQueue ( )

Default destructor.

Definition at line 158 of file WEMQueue.h.

References ml::WEMQueueElement< T >::getNextQueueElement(), and mlrange_cast().

Member Function Documentation

◆ append()

template<class T >
void ml::WEMQueue< T >::append ( T * elem)

Appends a WEMQueueElement to the end of the queue.

Definition at line 177 of file WEMQueue.h.

References mlrange_cast().

◆ getHead()

template<class T >
WEMQueueElement< T > * ml::WEMQueue< T >::getHead ( ) const
inline

Returns the head element of the queue.

Definition at line 79 of file WEMQueue.h.

◆ getSize()

template<class T >
unsigned int ml::WEMQueue< T >::getSize ( ) const
inline

Returns the number of elements in the queue.

Definition at line 77 of file WEMQueue.h.

◆ getTail()

template<class T >
WEMQueueElement< T > * ml::WEMQueue< T >::getTail ( ) const
inline

Returns the tail element of the queue.

Definition at line 81 of file WEMQueue.h.

◆ popFront()

template<class T >
void ml::WEMQueue< T >::popFront ( )

Pops the head element.

Definition at line 219 of file WEMQueue.h.

References ml::WEMQueueElement< T >::getNextQueueElement(), and mlrange_cast().

◆ prepend()

template<class T >
void ml::WEMQueue< T >::prepend ( T * elem)

Prepends a WEMQueueElement to the front of the queue.

Definition at line 198 of file WEMQueue.h.

References mlrange_cast().

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