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, typename pointer_mode_t::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...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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...
 
void SetTemplateWeakPtr (unsigned int argument) override
 Makes queue treat stored pointers as weak (if applicable). More...
 
- 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_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...
 
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...
 
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...
 

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 ()
 Impleemnts 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.

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, typename pointer_mode_t::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 ( )
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.

◆ SetTemplateWeakPtr()

template<typename T >
void System::Collections::Generic::Queue< T >::SetTemplateWeakPtr ( unsigned int  argument)
inlineoverridevirtual

Makes queue treat stored pointers as weak (if applicable).

Parameters
argumentShould be 0 as there is only one template argument present.

Reimplemented from System::Object.