System::Collections::Generic::IEnumerator< T > Class Template Referenceabstract

Interface of enumerator which can be used to iterate through some elements. 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...

Inherits System::IDisposable, System::Details::EnumeratorBasedIterator< T >, and System::Details::IteratorPointerUpdater< T, false >.

Inherited by System::Array< T >::Enumerator, System::Collections::Generic::LinkedList< T >::Enumerator, and System::Linq::Details::EmptyEnumerator< T >.

Public Types

typedef T ValueType
 Value type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

 IEnumerator ()
 
virtual ~IEnumerator ()
 
virtual MakeConstRef_t< T > Current () const
 Gets current element. More...
 
virtual MakeConstRef_t< T > get_Current () const =0
 Gets current element. More...
 
virtual bool MoveNext ()=0
 Moves enumerator to the next element. If no element was referenced before, sets reference to the first element available. If container end was hit, does nothing. More...
 
virtual void Reset ()
 Resets enumerator to position before first element. More...
 
void InitializeIterator () override
 Does the first MoveNext() call and prepares the enumerator object to be used by VirtualizedIterator. More...
 
void IncrementIterator () override
 Moves the iterator step forward. More...
 
System::Details::VirtualizedIteratorBase< T > * CloneIterator () const override
 Clones current iterator. More...
 
IEnumeratorAsVirtualizedIterator ()
 Prepares the iterator to be used by the VirtualizedIterator class. More...
 
void MarkOwnedByVirtualizedIterator ()
 Marks the enumerator owned by virtualized iterator. More...
 
- Public Member Functions inherited from System::IDisposable
virtual void Dispose ()
 Does nothing. 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 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)
 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...
 

Protected Member Functions

 IEnumerator (const IEnumerator &other)
 Copy constructor. More...
 

Protected Attributes

bool m_owned_by_virtualized_iterator
 Whether is owned by VirtualizedIterator. 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...
 

Detailed Description

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

Interface of enumerator which can be used to iterate through some elements. 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/list.h>
#include <system/smart_ptr.h>
using namespace System;
int main()
{
// Create the List-class instance.
auto collection = MakeObject<List<int>>();
// Fill the list.
collection->Add(1);
collection->Add(2);
collection->Add(3);
// Get the enumerator of the list.
auto enumerator = collection->GetEnumerator();
while (enumerator->MoveNext())
{
// Get the current element and print it.
std::cout << enumerator->get_Current() << ' ';
}
// Reset the enumerator.
enumerator->Reset();
return 0;
}
/*
This code example produces the following output:
1 2 3
*/
Template Parameters
TElement type.

Member Typedef Documentation

◆ ValueType

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

Value type.

Constructor & Destructor Documentation

◆ IEnumerator() [1/2]

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

◆ ~IEnumerator()

template<typename T>
virtual System::Collections::Generic::IEnumerator< T >::~IEnumerator ( )
inlinevirtual

◆ IEnumerator() [2/2]

template<typename T>
System::Collections::Generic::IEnumerator< T >::IEnumerator ( const IEnumerator< T > &  other)
inlineprotected

Copy constructor.

Parameters
otherEnumerator to copy data from.

Member Function Documentation

◆ AsVirtualizedIterator()

template<typename T>
IEnumerator* System::Collections::Generic::IEnumerator< T >::AsVirtualizedIterator ( )
inline

Prepares the iterator to be used by the VirtualizedIterator class.

Returns
This pointer.

◆ CloneIterator()

template<typename T>
System::Details::VirtualizedIteratorBase<T>* System::Collections::Generic::IEnumerator< T >::CloneIterator ( ) const
inlineoverride

Clones current iterator.

Returns
Copy of the current iterator.

◆ Current()

template<typename T>
virtual MakeConstRef_t<T> System::Collections::Generic::IEnumerator< T >::Current ( ) const
inlinevirtual

Gets current element.

Returns
Currently referenced element copy.

◆ get_Current()

◆ IncrementIterator()

template<typename T>
void System::Collections::Generic::IEnumerator< T >::IncrementIterator ( )
inlineoverride

Moves the iterator step forward.

◆ InitializeIterator()

template<typename T>
void System::Collections::Generic::IEnumerator< T >::InitializeIterator ( )
inlineoverride

Does the first MoveNext() call and prepares the enumerator object to be used by VirtualizedIterator.

◆ MarkOwnedByVirtualizedIterator()

template<typename T>
void System::Collections::Generic::IEnumerator< T >::MarkOwnedByVirtualizedIterator ( )
inline

Marks the enumerator owned by virtualized iterator.

◆ MoveNext()

template<typename T>
virtual bool System::Collections::Generic::IEnumerator< T >::MoveNext ( )
pure virtual

◆ Reset()

Member Data Documentation

◆ m_owned_by_virtualized_iterator

template<typename T>
bool System::Collections::Generic::IEnumerator< T >::m_owned_by_virtualized_iterator
protected

Whether is owned by VirtualizedIterator.