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

Queue class forward declaration. More...

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

Classes

class  Enumerator
 Enumerator to iterate through queue. 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. More...
 

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 = EnumeratorBasedIterator< T, IEnumerator< T > >
 
using const_iterator = iterator
 
- 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)
 Constructs empty queue. More...
 
 Queue (const SharedPtr< IEnumerable< T >> &items)
 Copy constructor. More...
 
IEnumeratorPtr GetEnumerator () override
 Gets enumerator to iterate through the queue. More...
 
virtual int get_Count () const
 Gets number of elements in queue. More...
 
virtual void Clear ()
 Deletes all elements in queue. More...
 
virtual bool Contains (const T &item) const
 Checks if queue contains specific element using operator == to compare elements. More...
 
void Enqueue (const T &item)
 Puts item to the end of the queue. More...
 
Dequeue ()
 Gets item from the beginning of the queue. More...
 
Peek ()
 Gets item from the beginning of the queue, but does not remove it from queue. More...
 
queue_tdata ()
 Underlying data structure accessor. More...
 
const queue_tdata () const
 Underlying data structure accessor. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< T >
LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
LINQ_First ()
 Returns the first element of a sequence. More...
 
LINQ_First (const Func< T, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
LINQ_FirstOrDefault (std::function< bool(T)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
LINQ_Last ()
 Returns the last element of a sequence. More...
 
LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< T > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< T, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< T > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(T)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(T)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< T > > LINQ_Where (std::function< bool(T)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (T value)
 Determines if a sequence contains a specified value. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderBy (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderByDescending (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, ResultType > &selector)
 Transforms elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< T > > LINQ_Concat (SharedPtr< IEnumerable< T >> sequence)
 Concatenates two sequences. More...
 
template<typename Key >
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, T > > > > LINQ_GroupBy (System::Func< T, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< T, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
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
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual 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 bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Types

typedef SharedPtr< Queue< T > > ThisPtr
 Pointer type. More...
 
typedef queue_t::iterator queueIt_t
 Iterator type. More...
 

Protected Member Functions

 ~Queue () override
 Destructor. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. More...
 

Protected Attributes

queue_t m_data
 Wrapped data structure. More...
 

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...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. 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
*/
Definition: algorithms.h:10
Definition: db_command.h:9
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.

◆ queueIt_t

template<typename T >
typedef queue_t::iterator System::Collections::Generic::Queue< T >::queueIt_t
protected

Iterator type.

◆ ThisPtr

template<typename T >
typedef SharedPtr<Queue<T> > System::Collections::Generic::Queue< T >::ThisPtr
protected

Pointer 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.

◆ ~Queue()

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

Destructor.

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.

Member Data Documentation

◆ m_data

template<typename T >
queue_t System::Collections::Generic::Queue< T >::m_data
protected

Wrapped data structure.