Asposecpplib
System::Collections::Generic::IEnumerable< T > Class Template Referenceabstract

Interface of object providing enumerator on contained elements. More...

Inherits System::Object.

Inherited by System::Collections::Generic::ICollection< T > [virtual], System::Linq::Details::EmptyEnumerable< T >, System::Xml::XmlAttributeCollection, and System::Xml::XmlNodeList.

Classes

class  EnumeratorBasedIterator
 

Public Types

typedef IEnumerator< T > IEnumeratorType
 Enumerator type. More...
 
using ValueType = T
 
- 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

virtual SharedPtr< IEnumerator< T > > GetEnumerator ()=0
 Gets enumerator. More...
 
LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
LINQ_First ()
 Returns the first element of a sequence. More...
 
LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
LINQ_FirstOrDefault (std::function< bool(T)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
LINQ_Last ()
 Returns the last element of a sequence. More...
 
LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< T > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
System::ArrayPtr< T > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(T)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(T)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< T > > LINQ_Where (std::function< bool(T)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (T value)
 Determines if a sequence contains a specified value. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, ResultType > &selector)
 Transforms elements of a sequence. More...
 
EnumeratorBasedIterator< T, IEnumerator< T > > begin () noexcept
 Gets iterator to the first const-qualified element of collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. It's impossible to add a const-qualifier for this method because GetEnumerator() is not const-qualified followed the C# .NET implementation. More...
 
EnumeratorBasedIterator< T, IEnumerator< T > > end () noexcept
 Gets iterator for a non-existent const-qualified element behind the end of the collection. This iterator can't be declared as a const-qualifier because GetEnumerator() is not const-qualified followed the C# .NET implementation. More...
 
EnumeratorBasedIterator< T, IEnumerator< T > > cbegin () noexcept
 Synonym for begin(). Gets iterator to the first const-qualified element of collection. More...
 
EnumeratorBasedIterator< T, IEnumerator< T > > cend () noexcept
 Synonym for end(). Gets iterator for a non-existent const-qualified element behind the end of the collection. More...
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
- 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 () 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 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...
 
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...
 

Detailed Description

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

Interface of object providing enumerator on contained elements.

Template Parameters
TElement type.

Member Typedef Documentation

◆ IEnumeratorType

Enumerator type.

◆ ValueType

template<typename T >
using System::Collections::Generic::IEnumerable< T >::ValueType = T

Member Function Documentation

◆ begin()

template<typename T >
EnumeratorBasedIterator<T, IEnumerator<T> > System::Collections::Generic::IEnumerable< T >::begin ( )
inlinenoexcept

Gets iterator to the first const-qualified element of collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. It's impossible to add a const-qualifier for this method because GetEnumerator() is not const-qualified followed the C# .NET implementation.

Returns
An iterator pointing to the first element in the const-qualified instance of collection.

◆ cbegin()

template<typename T >
EnumeratorBasedIterator<T, IEnumerator<T> > System::Collections::Generic::IEnumerable< T >::cbegin ( )
inlinenoexcept

Synonym for begin(). Gets iterator to the first const-qualified element of collection.

Returns
An iterator pointing to the first element in the const-qualified instance of collection.

◆ cend()

template<typename T >
EnumeratorBasedIterator<T, IEnumerator<T> > System::Collections::Generic::IEnumerable< T >::cend ( )
inlinenoexcept

Synonym for end(). Gets iterator for a non-existent const-qualified element behind the end of the collection.

Returns
An iterator pointing to the theoretical const-qualified element placed after the end element of collection.

◆ end()

template<typename T >
EnumeratorBasedIterator<T, IEnumerator<T> > System::Collections::Generic::IEnumerable< T >::end ( )
inlinenoexcept

Gets iterator for a non-existent const-qualified element behind the end of the collection. This iterator can't be declared as a const-qualifier because GetEnumerator() is not const-qualified followed the C# .NET implementation.

Returns
An iterator pointing to the theoretical const-qualified element placed after the end element of collection.

◆ GetEnumerator()

template<typename T >
virtual SharedPtr<IEnumerator<T> > System::Collections::Generic::IEnumerable< T >::GetEnumerator ( )
pure virtual

Gets enumerator.

Returns
Pointer to newly created enumerator object which can be used to iterate through interfaced object.

Implemented in System::Collections::Generic::BaseDictionary< map_t >, System::Collections::Generic::BaseDictionary< Detail::FlatMap< TKey, TValue, ComparerAdapter< TKey > > >, System::Xml::XmlNodeList, System::Collections::Generic::IKVCollection< T >, System::Collections::Generic::IKVCollection< Dict::map_t::mapped_type >, System::Collections::Generic::IKVCollection< Dict::map_t::key_type >, System::Collections::Generic::IKVCollection< KV >, System::Net::Http::Headers::HttpHeaderValueCollection< System::String >, System::Collections::Generic::SortedList< TKey, TValue >, System::Collections::Generic::Details::EnumerableSelectAdapter< Source, Result >, System::Collections::Generic::Details::EnumerableAdapter< Source, Result, EnumeratorAdapter >, System::Array< T >, System::Collections::Generic::ArrayList< T >, System::Collections::Generic::ArrayList< MatchPtr >, System::Net::Http::Headers::HttpHeaderValueCollection< T >, System::Collections::BitArray, System::Collections::ObjectModel::Collection< T >, System::Collections::ObjectModel::Collection< TItem >, System::Net::Http::Headers::HttpHeaders, System::Collections::Generic::_ValueCollection< Dict >, System::Windows::Forms::Control::ControlCollection, System::Xml::XmlAttributeCollection, System::Collections::ObjectModel::ReadOnlyCollection< T >, System::Net::CookieCollection, System::Collections::Specialized::NameValueCollection, System::Linq::Details::EmptyEnumerable< T >, System::Collections::Specialized::StringCollection, System::Collections::Generic::_KeyCollection< Dict >, System::Xml::XPath::XPathNodeIterator, and System::Security::Cryptography::Xml::KeyInfo.

◆ LINQ_All()

template<typename T >
bool System::Collections::Generic::IEnumerable< T >::LINQ_All ( std::function< bool(T)>  predicate)

Determines whether all elements of a sequence satisfy a condition.

Parameters
predicateA function to test each element for a condition.
Returns
true if every element of the source sequence passes the test in the specified predicate, or if the sequence is empty; otherwise, false.

◆ LINQ_Any() [1/2]

template<typename T >
bool System::Collections::Generic::IEnumerable< T >::LINQ_Any

Determines whether a sequence contains any elements.

Returns
true if the source sequence contains any elements; otherwise, false.

◆ LINQ_Any() [2/2]

template<typename T >
bool System::Collections::Generic::IEnumerable< T >::LINQ_Any ( std::function< bool(T)>  predicate)

Determines whether any element of a sequence exists or satisfies a condition.

Parameters
predicateA function to test each element for a condition.
Returns
true if the source sequence contains any elements; otherwise, false.

◆ LINQ_Cast() [1/2]

template<typename T >
template<typename ResultType >
SharedPtr<IEnumerable<ResultType> > System::Collections::Generic::IEnumerable< T >::LINQ_Cast ( )

Casts the elements to the specified type.

Template Parameters
ResultTypeThe type to cast the elements of the sequence.
Returns
An IEnumerable that contains elements of the sequence cast the ResultType.
Exceptions
InvalidCastExceptionElement of the sequence cannot be cast to the ResultType.

◆ LINQ_Cast() [2/2]

template<typename T >
template<typename Result >
SharedPtr<IEnumerable<Result> > System::Collections::Generic::IEnumerable< T >::LINQ_Cast ( )

◆ LINQ_Contains()

template<typename T >
bool System::Collections::Generic::IEnumerable< T >::LINQ_Contains ( value)

Determines if a sequence contains a specified value.

Parameters
valueThe value to locate in the sequence.
Returns
true if the sequence contains the specified value, otherwise false.

◆ LINQ_Count()

template<typename T >
int System::Collections::Generic::IEnumerable< T >::LINQ_Count

Returns the number of elements in the sequence (calculated via direct counting).

Returns
Number of elements in the sequence.

◆ LINQ_ElementAt()

template<typename T >
T System::Collections::Generic::IEnumerable< T >::LINQ_ElementAt ( int  index)

Returns the element at a specified index in a sequence.

Parameters
indexIndex to get element at.
Returns
Element at specified index or default-constructed value if not found.

◆ LINQ_First()

template<typename T >
T System::Collections::Generic::IEnumerable< T >::LINQ_First

Returns the first element of a sequence.

Returns
First element in the sequence.
Exceptions
InvalidOperationExceptionSource sequence is empty.

◆ LINQ_FirstOrDefault() [1/2]

template<typename T >
T System::Collections::Generic::IEnumerable< T >::LINQ_FirstOrDefault

Returns the first element of a sequence, or a default value if the sequence is empty.

Returns
First element in the sequence or default-constructed value if the sequence is empty.

◆ LINQ_FirstOrDefault() [2/2]

template<typename T >
T System::Collections::Generic::IEnumerable< T >::LINQ_FirstOrDefault ( std::function< bool(T)>  predicate)

Returns the first element of the sequence that satisfies a condition or a default value if no such element is found.

Parameters
predicateA function to test each element for a condition.
Returns
default(T) if source is empty or if no element passes the test specified by predicate; otherwise, the first element in source that passes the test specified by predicate.

◆ LINQ_Last()

template<typename T >
T System::Collections::Generic::IEnumerable< T >::LINQ_Last

Returns the last element of a sequence.

Returns
Last element in the sequence.
Exceptions
InvalidOperationExceptionSource sequence is empty.

◆ LINQ_LastOrDefault()

template<typename T >
T System::Collections::Generic::IEnumerable< T >::LINQ_LastOrDefault

Returns the last element of a sequence, or a default value if the sequence is empty.

Returns
Last element in the sequence or default-constructed value if the sequence is empty.

◆ LINQ_OfType() [1/2]

template<typename T >
template<typename ResultType >
SharedPtr<IEnumerable<ResultType> > System::Collections::Generic::IEnumerable< T >::LINQ_OfType ( )

Filters the elements of the sequence based on the specified type.

Template Parameters
ResultTypeThe type to filter the elements of the sequence.
Returns
An IEnumerable that contains elements from the sequence of the ResultType.

◆ LINQ_OfType() [2/2]

template<typename T >
template<typename Result >
SharedPtr<IEnumerable<Result> > System::Collections::Generic::IEnumerable< T >::LINQ_OfType ( )

◆ LINQ_Select() [1/2]

template<typename T >
template<typename Result >
SharedPtr<IEnumerable<Result> > System::Collections::Generic::IEnumerable< T >::LINQ_Select ( const Func< Source, Result > &  selector)

◆ LINQ_Select() [2/2]

template<typename T >
template<typename ResultType >
SharedPtr<IEnumerable<ResultType> > System::Collections::Generic::IEnumerable< T >::LINQ_Select ( const Func< T, ResultType > &  selector)

Transforms elements of a sequence.

Template Parameters
ResultTypeThe type of the value returned by the selector.
Parameters
selectorA transform function.
Returns
An IEnumerable that contains elements returned by the selector function.

◆ LINQ_ToArray()

template<typename T >
System::ArrayPtr< T > System::Collections::Generic::IEnumerable< T >::LINQ_ToArray

Creates an array from a sequence.

Returns
Array that contains all elements of current sequence.

◆ LINQ_ToList()

Creates a List<T> from a sequence.

Returns
The list containing all elements of specified sequence.

◆ LINQ_Where()

template<typename T >
SharedPtr< IEnumerable< T > > System::Collections::Generic::IEnumerable< T >::LINQ_Where ( std::function< bool(T)>  predicate)

Filters a sequence based on the specified predicate.

Parameters
predicateA function that test each elements for some condition.
Returns
An IEnumerable that contains filtered elements.