System::Collections::Generic::BaseEnumerator< Container, Element > Class Template Reference

Inherits System::Object, and System::Collections::Generic::IEnumerator< Element >.

Inherited by System::Collections::Generic::SimpleEnumerator< Container, Element >.

Public Member Functions

 BaseEnumerator (Object::ptr owner, Container &cont)
 
bool IsValid () const
 
bool MoveNext () override
 
void Reset () override
 Resets enumerator to allow re-enumerating elements. 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...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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)
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerator< Element >
virtual Element Current () ASPOSE_CONST
 
virtual Element get_Current () ASPOSE_CONST=0
 

Protected Attributes

Object::ptr m_owner
 Pointer to owner container object to make sure it is not deleted before enumerator is. More...
 
Container & m_data
 Container inner data structure reference. More...
 
Container::iterator m_it
 Actual STL iterator. More...
 
bool m_inited
 Whether MoveNext() was ever called. More...
 

Additional Inherited Members

- 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 Types inherited from System::Collections::Generic::IEnumerator< Element >
typedef Element 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 TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

template<typename Container, typename Element>
class System::Collections::Generic::BaseEnumerator< Container, Element >

Enumerator definition to wrap STL-styled types for C#-styled usage. Makes no assertions on container structure except for existance of sequental iterator. Uses begin() and end() functions. 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
ContainerSTL-styled container type.
ElementElement type.

Constructor & Destructor Documentation

◆ BaseEnumerator()

template<typename Container, typename Element>
System::Collections::Generic::BaseEnumerator< Container, Element >::BaseEnumerator ( Object::ptr  owner,
Container &  cont 
)
inline

Initializes iterator.

Parameters
ownerPointer to owner container.
contActual container implementation reference.

Member Function Documentation

◆ IsValid()

template<typename Container, typename Element>
bool System::Collections::Generic::BaseEnumerator< Container, Element >::IsValid ( ) const
inline

Checks whether MoveNext() was called and end was not reached.

Returns
false if MoveNext() was not called at all or container end is hit; true otherwise.

◆ MoveNext()

template<typename Container, typename Element>
bool System::Collections::Generic::BaseEnumerator< Container, Element >::MoveNext ( )
inlineoverridevirtual

Enumerator-style increment.

Returns
true if enumerator points to valid element, false if container end is hit.

Implements System::Collections::Generic::IEnumerator< Element >.

◆ Reset()

template<typename Container, typename Element>
void System::Collections::Generic::BaseEnumerator< Container, Element >::Reset ( )
inlineoverridevirtual

Resets enumerator to allow re-enumerating elements.

Reimplemented from System::Collections::Generic::IEnumerator< Element >.

Member Data Documentation

◆ m_data

template<typename Container, typename Element>
Container& System::Collections::Generic::BaseEnumerator< Container, Element >::m_data
protected

Container inner data structure reference.

◆ m_inited

template<typename Container, typename Element>
bool System::Collections::Generic::BaseEnumerator< Container, Element >::m_inited
protected

Whether MoveNext() was ever called.

◆ m_it

template<typename Container, typename Element>
Container::iterator System::Collections::Generic::BaseEnumerator< Container, Element >::m_it
protected

Actual STL iterator.

◆ m_owner

template<typename Container, typename Element>
Object::ptr System::Collections::Generic::BaseEnumerator< Container, Element >::m_owner
protected

Pointer to owner container object to make sure it is not deleted before enumerator is.