System::Array< T >::Enumerator Class Reference
Implements IEnumerator interface that enables enumeration of elements of an Array object. 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...
#include <array.h>
Inherits System::Object, and System::Collections::Generic::IEnumerator< T >.
Public Member Functions | |
| Enumerator (const SharedPtr< Array< T > > &arr) | |
| Constructs a new Enumerator object that represents the specified array. More... | |
| virtual | ~Enumerator () |
| Destructor. More... | |
| virtual MakeConstRef_t< T > | get_Current () const override |
| Returns a copy of the current element. More... | |
| virtual bool | MoveNext () override |
| Checks if the current element's index does not point to the last element in the array and advances it if id does not. More... | |
| virtual void | Reset () override |
| Resets the current element's index. More... | |
 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... | |
| Object & | operator= (Object const &x) |
| Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
| Object * | SharedRefAdded () |
| 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 TypeInfo & | GetType () 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... | |
| Public Member Functions inherited from System::Collections::Generic::IEnumerator< T > | |
| 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... | |
| IEnumerator * | AsVirtualizedIterator () |
| 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... | |
Additional Inherited Members | |
| Public Types inherited from System::Object | |
| typedef SmartPtr< Object > | ptr |
| Alias for smart pointer type. More... | |
| Public Types inherited from System::Collections::Generic::IEnumerator< T > | |
| typedef T | ValueType |
| Value type. More... | |
| 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 TypeInfo & | Type () |
| 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... | |
| Protected Member Functions inherited from System::Collections::Generic::IEnumerator< T > | |
| IEnumerator (const IEnumerator &other) | |
| Copy constructor. More... | |
| Protected Attributes inherited from System::Collections::Generic::IEnumerator< T > | |
| bool | m_owned_by_virtualized_iterator |
| Whether is owned by VirtualizedIterator. More... | |
Detailed Description
template<typename T>
class System::Array< T >::Enumerator
class System::Array< T >::Enumerator
Implements IEnumerator interface that enables enumeration of elements of an Array object. 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.
Constructor & Destructor Documentation
◆ Enumerator()
template<typename T >
|
inline |
Constructs a new Enumerator object that represents the specified array.
- Parameters
-
arr A shared pointer to the Array object
◆ ~Enumerator()
template<typename T >
|
inlinevirtual |
Destructor.
Member Function Documentation
◆ get_Current()
template<typename T >
|
inlineoverridevirtual |
Returns a copy of the current element.
Implements System::Collections::Generic::IEnumerator< T >.
◆ MoveNext()
template<typename T >
|
inlineoverridevirtual |
Checks if the current element's index does not point to the last element in the array and advances it if id does not.
- Returns
- True if the current element's index did not point to the last element in the array before it was advanced, otherwise - false
Implements System::Collections::Generic::IEnumerator< T >.
◆ Reset()
template<typename T >
|
inlineoverridevirtual |
Resets the current element's index.
Reimplemented from System::Collections::Generic::IEnumerator< T >.
