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

Stack class forward declaration. More...

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

Classes

class  Enumerator
 

Public Types

typedef T ValueType
 Value type. More...
 
typedef std::list< T, typename pointer_mode_t::allocator_type > stack_t
 Underlying data type. More...
 
typedef SharedPtr< IEnumerable< T > > IEnumerablePtr
 Collection containing elements of same type. 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

 Stack ()
 Constructs empty stack. More...
 
 Stack (int capacity)
 
 Stack (IEnumerablePtr collection)
 
IEnumeratorPtr GetEnumerator () override
 
virtual int get_Count () const
 
virtual void Clear ()
 Deletes all elements from stack. More...
 
virtual bool Contains (const T &item) const
 
void Push (const T &item)
 
Pop ()
 
Peek ()
 
stack_tdata ()
 
const stack_tdata () const
 
virtual ArrayPtr< T > ToArray ()
 
void AddRange (IEnumerablePtr collection)
 
void SetTemplateWeakPtr (unsigned int argument) override
 
- 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_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...
 
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)
 

Protected Types

typedef SharedPtr< Stack< T > > ThisPtr
 Pointer type. More...
 
typedef stack_t::reverse_iterator queueIt_t
 Iterator type. 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::Stack< T >

Stack class forward declaration.

Stack class wrapping std::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::Stack< T >::IEnumerablePtr

Collection containing elements of same type.

◆ IEnumeratorPtr

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

Enumerator type.

◆ queueIt_t

template<typename T >
typedef stack_t::reverse_iterator System::Collections::Generic::Stack< T >::queueIt_t
protected

Iterator type.

◆ stack_t

template<typename T >
typedef std::list<T, typename pointer_mode_t::allocator_type> System::Collections::Generic::Stack< T >::stack_t

Underlying data type.

◆ ThisPtr

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

Pointer type.

◆ ValueType

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

Value type.

Constructor & Destructor Documentation

◆ Stack() [1/3]

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

Constructs empty stack.

◆ Stack() [2/3]

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

Constructs empty stack.

Parameters
capacityNumber of elements to reserve; ignored.

◆ Stack() [3/3]

template<typename T >
System::Collections::Generic::Stack< T >::Stack ( IEnumerablePtr  collection)
inline

Copy constructor.

Parameters
collectionCollection to copy elements from.

Member Function Documentation

◆ AddRange()

template<typename T >
void System::Collections::Generic::Stack< T >::AddRange ( IEnumerablePtr  collection)
inline

Puts elements into stack.

Parameters
collectionContainer of elements to push into stack.

◆ Clear()

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

Deletes all elements from stack.

◆ Contains()

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

Checks if specific item is present in container; uses operator == for comparison.

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

◆ data() [1/2]

template<typename T >
stack_t& System::Collections::Generic::Stack< T >::data ( )
inline

Internal data structure accessor.

Returns
Reference to internal data structure.

◆ data() [2/2]

template<typename T >
const stack_t& System::Collections::Generic::Stack< T >::data ( ) const
inline

Internal data structure accessor.

Returns
Const reference to internal data structure.

◆ get_Count()

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

Gets number of elements in stack.

Returns
Actual elements count.

◆ GetEnumerator()

template<typename T >
IEnumeratorPtr System::Collections::Generic::Stack< T >::GetEnumerator ( )
inlineoverridevirtual

Gets enumerator to iterate through current stack.

Returns
Newly created enumerator to iterate through current stack.

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

◆ Peek()

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

Gets element from stack top, but keeps it in stack.

Returns
Top element of the stack.

◆ Pop()

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

Gets element from top of the stack.

Returns
Popped element.

◆ Push()

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

Puts element of top of the stack.

Parameters
itemElement to push into stack.

◆ SetTemplateWeakPtr()

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

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

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

Reimplemented from System::Object.

◆ ToArray()

template<typename T >
virtual ArrayPtr<T> System::Collections::Generic::Stack< T >::ToArray ( )
inlinevirtual

Converts stack to array.

Returns
Newly created element with copies of all elements in stack.