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

Queue class forward declaration. More...

Inherits System::Collections::Generic::IEnumerable< T >.

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 Types inherited from System::Collections::Generic::IEnumerable< T >
typedef IEnumerator< T > IEnumeratorType
 Enumerator type. More...
 
using ValueType = T
 
using iterator = System::Details::VirtualizedIterator< T >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< T >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< T >
 Inner iterator base type. More...
 
using virtualized_iterator_element = T
 Inner iterator element type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer 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
 
System::Details::VirtualizedIteratorBase< T > * virtualizeBeginIterator () override
 
System::Details::VirtualizedIteratorBase< T > * virtualizeEndIterator () override
 
System::Details::VirtualizedIteratorBase< T > * virtualizeBeginConstIterator () const override
 
System::Details::VirtualizedIteratorBase< T > * virtualizeEndConstIterator () const override
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< T >
LINQ_ElementAt (int index)
 
LINQ_First ()
 
LINQ_First (const Func< T, bool > &predicate)
 
LINQ_FirstOrDefault ()
 
LINQ_FirstOrDefault (std::function< bool(T)> predicate)
 
LINQ_Last ()
 
LINQ_LastOrDefault ()
 
SharedPtr< List< T > > LINQ_ToList ()
 
int LINQ_Count ()
 
int LINQ_Count (const Func< T, bool > &predicate)
 
System::ArrayPtr< T > LINQ_ToArray ()
 
bool LINQ_All (std::function< bool(T)> predicate)
 
bool LINQ_Any ()
 
bool LINQ_Any (std::function< bool(T)> predicate)
 
SharedPtr< IEnumerable< T > > LINQ_Where (std::function< bool(T)> predicate)
 
bool LINQ_Contains (T value)
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderBy (const Func< T, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderByDescending (const Func< T, Key > &keySelector)
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, ResultType > &selector)
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, int32_t, ResultType > &selector)
 
SharedPtr< IEnumerable< T > > LINQ_Concat (SharedPtr< IEnumerable< T >> sequence)
 
template<typename Key >
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, T > > > > LINQ_GroupBy (System::Func< T, Key > keyPredicate)
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< T, SharedPtr< IEnumerable< ResultType >>> &selector)
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
const_iterator cbegin () const
 
const_iterator cend () const
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

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.

#include <system/collections/queue.h>
#include <system/smart_ptr.h>
using namespace System;
void PrintItems(const SmartPtr<IEnumerable<int>> &queue)
{
for (const int item: queue)
{
std::cout << item << ' ';
}
std::cout << std::endl;
}
int main()
{
// Create the Queue-class instance.
auto queue = MakeObject<Queue<int>>();
// Fill the queue.
queue->Enqueue(1);
queue->Enqueue(2);
queue->Enqueue(3);
// Print the first queue item. The Peek method doesn't remove an item from the queue.
std::cout << queue->Peek() << std::endl;
// Print the queue items.
PrintItems(queue);
// Print the first queue item. The Dequeue method removes an item from the queue.
std::cout << queue->Dequeue() << std::endl;
// Print the queue items.
PrintItems(queue);
return 0;
}
/*
* This code example produces the following output:
* 1
* 1 2 3
* 1
* 2 3
*/
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.
Exceptions
ArgumentOutOfRangeExceptionif capacity is less than zero.

◆ 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.
Exceptions
ArgumentNullExceptionif items is nullptr.

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.
Exceptions
ArgumentNullExceptionif the queue is empty.

◆ 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 ( )
inlineoverridevirtual

Gets enumerator to iterate through the queue.

Returns
Pointer to newly created enumerator.

Implements System::Collections::Generic::IEnumerable< T >.

◆ 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.
Exceptions
ArgumentNullExceptionif the queue is empty.

◆ virtualizeBeginConstIterator()

template<typename T >
System::Details::VirtualizedIteratorBase<T>* System::Collections::Generic::Queue< T >::virtualizeBeginConstIterator ( ) const
inlineoverridevirtual

Gets the implementation of begin const iterator for the current container.

Returns
Pointer to the newly created iterator kernel object.

Reimplemented from System::Collections::Generic::IEnumerable< T >.

◆ virtualizeBeginIterator()

template<typename T >
System::Details::VirtualizedIteratorBase<T>* System::Collections::Generic::Queue< T >::virtualizeBeginIterator ( )
inlineoverridevirtual

Gets the implementation of begin iterator for the current container.

Returns
Pointer to the newly created iterator kernel object.

Reimplemented from System::Collections::Generic::IEnumerable< T >.

◆ virtualizeEndConstIterator()

template<typename T >
System::Details::VirtualizedIteratorBase<T>* System::Collections::Generic::Queue< T >::virtualizeEndConstIterator ( ) const
inlineoverridevirtual

Gets the implementation of end const iterator for the current container.

Returns
Pointer to the newly created iterator kernel object.

Reimplemented from System::Collections::Generic::IEnumerable< T >.

◆ virtualizeEndIterator()

template<typename T >
System::Details::VirtualizedIteratorBase<T>* System::Collections::Generic::Queue< T >::virtualizeEndIterator ( )
inlineoverridevirtual

Gets the implementation of end iterator for the current container.

Returns
Pointer to the newly created iterator kernel object.

Reimplemented from System::Collections::Generic::IEnumerable< T >.