Base Module  VST 3.6.5
SDK for developing VST Plug-in
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions
TQueue< T > Class Template Reference

Queue template. More...

#include <tqueue.h>

+ Inheritance diagram for TQueue< T >:

Public Member Functions

 TQueue ()
 Default queue constructor. More...
 
 TQueue (const TQueue< T > &)
 Queue copy constructor. More...
 
 ~TQueue ()
 Queue destructor. More...
 
TQueue< T > & operator= (const TQueue< T > &)
 Assignment operator. More...
 
bool enqueue (const T &)
 Push item into queue. More...
 
dequeue ()
 Pop front item from queue. More...
 
T & peek () const
 Return copy of front item. More...
 
- Public Member Functions inherited from TLinkedList< T >
 TLinkedList ()
 
 TLinkedList (const TLinkedList< T > &)
 List copy constructor. More...
 
 TLinkedList (const TContainer< T > &)
 Construct from container. More...
 
 ~TLinkedList ()
 List destructor. More...
 
TContainer< T > * newInstance () const
 Create a copy of this container. More...
 
TLinkedList< T > & operator= (const TLinkedList< T > &)
 Assignment operator. More...
 
virtual bool add (const T &)
 Create a copy of this container. More...
 
bool append (const T &)
 Same as TLinkedList::add. More...
 
bool prepend (const T &)
 Add item to beginning of the list. More...
 
bool insertAt (int32 index, const T &)
 Insert item at the specified index. More...
 
bool replaceAt (int32 index, const T &)
 Replace item at the specified index. More...
 
virtual bool remove (const T &)
 Remove equal item. More...
 
virtual bool remove (const TIterator< T > &)
 Remove item at current iterator position. More...
 
virtual bool removeAt (int32)
 Remove item at given index. More...
 
virtual void removeAll ()
 Remove all items from list. More...
 
removeFirst ()
 Remove first item and return copy of the removed item. More...
 
removeLast ()
 Remove last item and return copy of the removed item. More...
 
bool insertAfter (const T &after, const T &data)
 Search for the first item equal to the specified item in the list and inserts the second item immediately after. More...
 
bool insertBefore (const T &before, const T &data)
 Search for the first item equal to the specified item in the list and inserts the second item immediately before. More...
 
T & first () const
 Get first item in list. More...
 
T & last () const
 Get last item in list. More...
 
int32 index (const T &item) const
 Get index of equal item. More...
 
virtual T & at (int32 index) const
 Get item at index. More...
 
virtual T & lookup (const T &item) const
 Searches for the item equal to the specified item in the list and returns the first occurrence. More...
 
virtual bool contains (const T &item) const
 See if container has equal item. More...
 
virtual int32 occurrences (const T &item) const
 Count occurrences of equal items. More...
 
virtual TIterator< T > * newIterator () const
 Create container iterator instance. More...
 
- Public Member Functions inherited from TContainer< T >
 TContainer ()
 
 TContainer (const TContainer< T > &)
 
virtual ~TContainer ()
 
bool operator== (const TContainer< T > &) const
 
bool operator!= (const TContainer< T > &) const
 
T & operator[] (int32) const
 "[]" indexing operator returns the item at the specified index. More...
 
virtual int32 total () const
 Return number of items. More...
 
virtual bool isEmpty () const
 Is container empty? More...
 
virtual int32 size () const
 Returns the container size. More...
 
TContainer< T > * lookupAll (const T &item) const
 Allocate and returns a container with all items in this container equal to the specified item. More...
 
bool addAllFrom (const TContainer< T > &container)
 Adds all the items from the specified container to this container. More...
 
bool addNewFrom (const TContainer< T > &container)
 Adds the items from the specified container to this container that are not in this container already. More...
 
T & error () const
 Access error object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from TContainer< T >
void copy (const TContainer< T > &container)
 Internal copy method. Copies the contents of the specified container into this container. More...
 
- Protected Attributes inherited from TContainer< T >
errorObject
 Object used as return value when methods returning a T& fail. More...
 
int32 _size
 Container size. More...
 

Detailed Description

template<class T>
class Steinberg::TQueue< T >

Queue template.

A queue is a "first in first out" (FIFO) data structure. Elements are added to the back of the queue and may be removed from the front. Queue does not allow iteration through its elements. Only the top item of the queue can be examined.

Constructor & Destructor Documentation

TQueue ( )
inline

Default queue constructor.

TQueue ( const TQueue< T > &  queue)

Queue copy constructor.

"TQueue" is the queue copy constructor.

Parameters
[in]queue: source queue
~TQueue ( )
inline

Queue destructor.

Member Function Documentation

TQueue< T > & operator= ( const TQueue< T > &  queue)

Assignment operator.

The operator "=" copies the content of the input queue into this queue.

Parameters
[in]queue: source queue
Returns
: copy of the queue
bool enqueue ( const T &  obj)

Push item into queue.

The method "enqueue" adds a new item at the end of the queue.

Parameters
[in]obj: the new item which will be added to the queue.
Returns
: true if item is successfully added / false if item is not added
T dequeue ( )

Pop front item from queue.

The method "dequeue" removes the top item from the queue.

Returns
: copy of the removed item
T & peek ( ) const

Return copy of front item.

The method "peek" returns a copy of the top queue item.

Returns
: copy of the top queue item
Empty

Copyright ©2015 Steinberg Media Technologies GmbH. All Rights Reserved.