System::Collections::Generic::Queue< T > Class Template Reference

Queue class forward declaration. More...

#include "system/collections/queue.h"

Classes

class  Enumerator
 

Public Types

typedef T ValueType
 This type. More...
 
typedef std::list< T, ASPOSE_COLLECTION_ALLOCATOR_TYPE > queue_t
 Underlying data type. More...
 
typedef SharedPtr< IEnumerable< T > > IEnumerablePtr
 Container of same type elements. More...
 
typedef SharedPtr< IEnumerator< T > > IEnumeratorPtr
 Enumerator type. More...
 

Public Member Functions

 Queue ()
 Constructs empty queue. More...
 
 Queue (int capacity)
 
 Queue (const SharedPtr< IEnumerable< T >> &items)
 
IEnumeratorPtr GetEnumerator () override
 
virtual int get_Count () const
 
virtual void Clear ()
 Deletes all elements in queue. More...
 
virtual bool Contains (const T &item) const
 
void Enqueue (const T &item)
 
Dequeue ()
 
Peek ()
 
queue_tdata ()
 
const queue_tdata () const
 

Detailed Description

template<typename T>
class System::Collections::Generic::Queue< T >

Queue class forward declaration.

Queue container wrapping STL list. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Template Parameters
TElement type.

Member Typedef Documentation

◆ IEnumerablePtr

template<typename T >
typedef SharedPtr<IEnumerable<T> > System::Collections::Generic::Queue< T >::IEnumerablePtr

Container of same type elements.

◆ IEnumeratorPtr

template<typename T >
typedef SharedPtr<IEnumerator<T> > System::Collections::Generic::Queue< T >::IEnumeratorPtr

Enumerator type.

◆ queue_t

template<typename T >
typedef std::list<T, ASPOSE_COLLECTION_ALLOCATOR_TYPE> System::Collections::Generic::Queue< T >::queue_t

Underlying data type.

◆ ValueType

template<typename T >
typedef T System::Collections::Generic::Queue< T >::ValueType

This type.

Constructor & Destructor Documentation

◆ Queue() [1/3]

template<typename T >
System::Collections::Generic::Queue< T >::Queue ( )
inline

Constructs empty queue.

◆ Queue() [2/3]

template<typename T >
System::Collections::Generic::Queue< T >::Queue ( int  capacity)
inline

Constructs empty queue.

Parameters
capacityNumber of elements to reserve.

◆ Queue() [3/3]

template<typename T >
System::Collections::Generic::Queue< T >::Queue ( const SharedPtr< IEnumerable< T >> &  items)
inline

Copy constructor.

Parameters
itemsContainer to copy data from.

Member Function Documentation

◆ Clear()

template<typename T >
virtual void System::Collections::Generic::Queue< T >::Clear ( )
inlinevirtual

Deletes all elements in queue.

◆ Contains()

template<typename T >
virtual bool System::Collections::Generic::Queue< T >::Contains ( const T &  item) const
inlinevirtual

Checks if queue contains specific element using operator == to compare elements.

Parameters
itemItem to look for.
Returns
True if item is present, false otherwise.

◆ data() [1/2]

template<typename T >
queue_t& System::Collections::Generic::Queue< T >::data ( )
inline

Underlying data structure accessor.

Returns
Reference to underlying data structure.

◆ data() [2/2]

template<typename T >
const queue_t& System::Collections::Generic::Queue< T >::data ( ) const
inline

Underlying data structure accessor.

Returns
Const reference to underlying data structure.

◆ Dequeue()

template<typename T >
T System::Collections::Generic::Queue< T >::Dequeue ( )
inline

Gets item from the beginning of the queue.

Returns
Popped item.

◆ Enqueue()

template<typename T >
void System::Collections::Generic::Queue< T >::Enqueue ( const T &  item)
inline

Puts item to the end of the queue.

Parameters
itemItem to push.

◆ get_Count()

template<typename T >
virtual int System::Collections::Generic::Queue< T >::get_Count ( ) const
inlinevirtual

Gets number of elements in queue.

Returns
Actual number of elements.

◆ GetEnumerator()

template<typename T >
IEnumeratorPtr System::Collections::Generic::Queue< T >::GetEnumerator ( )
inlineoverride

Gets enumerator to iterate through the queue.

Returns
Pointer to newly created enumerator.

◆ Peek()

template<typename T >
T System::Collections::Generic::Queue< T >::Peek ( )
inline

Gets item from the beginning of the queue, but does not remove it from queue.

Returns
First item in queue.