Asposecpplib
System::Collections::ObjectModel::Collection< T > Class Template Reference

Base type for generic collection. 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::Collections::Generic::IList< T >.

Inherited by System::Net::Http::Headers::ObjectCollection< T >.

Classes

class  reverse_iterator_prototype
 Iterates elements of the sequence container in the reverse order. More...
 

Public Types

typedef reverse_iterator_prototype< T > reverse_iterator
 
typedef reverse_iterator_prototype< T > const_reverse_iterator
 
- Public Types inherited from System::Collections::Generic::IList< T >
typedef ICollection< T > BaseType
 Base type. More...
 
typedef IList< T > ThisType
 This type. More...
 
typedef T ValueType
 Value type. More...
 
- Public Types inherited from System::Collections::Generic::ICollection< T >
typedef T ValueType
 Value type name. More...
 
typedef ICollection< T > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< T >
typedef IEnumerator< T > IEnumeratorType
 Enumerator type. More...
 
using ValueType = T
 
using iterator = EnumeratorBasedIterator< T, IEnumerator< T > >
 
using const_iterator = iterator
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

 Collection ()
 Creates empty collection. More...
 
 Collection (SharedPtr< Generic::IList< T >> list)
 
SharedPtr< Generic::IList< T > > get_Items ()
 Internal data structure accessor. More...
 
const Generic::ListPtr< T > get_Items () const
 Internal data structure accessor. More...
 
int get_Count () const override
 Gets number of elements. More...
 
virtual T idx_get (int index) const override
 Gets value at specified index. More...
 
virtual void idx_set (int index, T value) override
 Sets value at specified index. More...
 
T & operator[] (int index)
 Gets value at specified index. More...
 
const T & operator[] (int index) const
 Gets value at specified index. More...
 
virtual void Add (const T &item) override
 Adds value to container. More...
 
void Clear () override
 Deletes all elements. More...
 
bool Contains (const T &item) const override
 Checks if item is present in collection. More...
 
SharedPtr< Generic::IEnumerator< T > > GetEnumerator () override
 Gets enumerator to iterate through collection. More...
 
int IndexOf (const T &item) const override
 Looks for element in collection. More...
 
void Insert (int index, const T &item) override
 Inserts item into specified position. More...
 
bool Remove (const T &item) override
 Removes specific item. More...
 
void RemoveAt (int index) override
 Removes item at specific position. More...
 
virtual void CopyTo (ArrayPtr< T > arr, int index) override
 Copies collection elements into existing array elements. More...
 
void SetTemplateWeakPtr (uint32_t argument) override
 Makes stored pointers weak (if applicable). More...
 
reverse_iterator rbegin () noexcept
 Gets a reverse iterator to the last element of collection (first in reverse). More...
 
reverse_iterator rend () noexcept
 Gets a reverse iterator for a non-existent element before the start of the collection. More...
 
const_reverse_iterator rbegin () const noexcept
 Gets a reverse iterator to the last element of the const-qualified collection (first in reverse). More...
 
const_reverse_iterator rend () const noexcept
 Gets a reverse iterator for a non-existent element before the start of the const-qualified collection. More...
 
const_reverse_iterator crbegin () const noexcept
 Gets a reverse iterator to the last const-qualified element of collection (first in reverse). More...
 
const_reverse_iterator crend () const noexcept
 Gets a reverse iterator for a non-existent const-qualified element before the start of the collection. More...
 
- Public Member Functions inherited from System::Collections::Generic::IList< T >
virtual bool get_IsFixedSize ()
 Checks whether the collection is of fixed size. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< T >
virtual bool get_IsReadOnly () const
 Checks if collection is read only. More...
 
ICollectionoperator= (ICollection &&)
 Move assignment operator. More...
 
ICollectionoperator= (const ICollection &)
 Move assignment operator. More...
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&)
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 
virtual SharedPtr< Objectget_SyncRoot () const
 Gets the object the collection is being synchronized through. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< T >
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_First (const Func< T, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. 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...
 
int LINQ_Count (const Func< T, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. 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 Key >
SharedPtr< IEnumerable< T > > LINQ_OrderBy (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderByDescending (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. 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...
 
SharedPtr< IEnumerable< T > > LINQ_Concat (SharedPtr< IEnumerable< T >> sequence)
 Concatenates two sequences. More...
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) 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)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
- 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 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 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...
 
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...
 

Protected Member Functions

 ~Collection () override
 Destructor. More...
 
virtual void ClearItems ()
 Deletes all items. More...
 
virtual void InsertItem (int index, const T &item)
 Inserts item into specified position. More...
 
virtual void RemoveItem (int index)
 Removes item from specified position. More...
 
virtual void SetItem (int index, const T &item)
 Sets item at specified position. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. 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...
 
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<class T>
class System::Collections::ObjectModel::Collection< T >

Base type for generic collection. 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

◆ const_reverse_iterator

◆ reverse_iterator

Constructor & Destructor Documentation

◆ Collection() [1/2]

template<class T >
System::Collections::ObjectModel::Collection< T >::Collection ( )
inline

Creates empty collection.

◆ Collection() [2/2]

template<class T >
System::Collections::ObjectModel::Collection< T >::Collection ( SharedPtr< Generic::IList< T >>  list)
inline

◆ ~Collection()

template<class T >
System::Collections::ObjectModel::Collection< T >::~Collection ( )
inlineoverrideprotected

Destructor.

Member Function Documentation

◆ Add()

template<class T >
virtual void System::Collections::ObjectModel::Collection< T >::Add ( const T &  item)
inlineoverridevirtual

Adds value to container.

Parameters
itemItem to add.

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

Reimplemented in System::Collections::ObjectModel::KeyedCollection< TKey, TItem >.

◆ Clear()

template<class T >
void System::Collections::ObjectModel::Collection< T >::Clear ( )
inlineoverridevirtual

Deletes all elements.

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

◆ ClearItems()

template<class T >
virtual void System::Collections::ObjectModel::Collection< T >::ClearItems ( )
inlineprotectedvirtual

◆ Contains()

template<class T >
bool System::Collections::ObjectModel::Collection< T >::Contains ( const T &  item) const
inlineoverridevirtual

Checks if item is present in collection.

Parameters
itemto look for.
Returns
True if item is present, false otherwise.

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

◆ CopyTo()

template<class T >
virtual void System::Collections::ObjectModel::Collection< T >::CopyTo ( ArrayPtr< T >  arr,
int  index 
)
inlineoverridevirtual

Copies collection elements into existing array elements.

Parameters
arrDestination array.
indexDestination array start index.

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

◆ crbegin()

template<class T >
const_reverse_iterator System::Collections::ObjectModel::Collection< T >::crbegin ( ) const
inlinenoexcept

Gets a reverse iterator to the last const-qualified element of collection (first in reverse).

Returns
A reverse iterator pointing to the last const-qualified element in the list (first in reverse).

◆ crend()

template<class T >
const_reverse_iterator System::Collections::ObjectModel::Collection< T >::crend ( ) const
inlinenoexcept

Gets a reverse iterator for a non-existent const-qualified element before the start of the collection.

Returns
A reverse iterator pointing to the theoretical const-qualified element preceding the first element in the list (last in reverse).

◆ get_Count()

template<class T >
int System::Collections::ObjectModel::Collection< T >::get_Count ( ) const
inlineoverridevirtual

Gets number of elements.

Returns
Active element count.

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

◆ get_Items() [1/2]

template<class T >
SharedPtr<Generic::IList<T> > System::Collections::ObjectModel::Collection< T >::get_Items ( )
inline

Internal data structure accessor.

Returns
Pointer to internal list.

◆ get_Items() [2/2]

template<class T >
const Generic::ListPtr<T> System::Collections::ObjectModel::Collection< T >::get_Items ( ) const
inline

Internal data structure accessor.

Returns
Pointer to internal list.

◆ GetEnumerator()

template<class T >
SharedPtr<Generic::IEnumerator<T> > System::Collections::ObjectModel::Collection< T >::GetEnumerator ( )
inlineoverridevirtual

Gets enumerator to iterate through collection.

Returns
Created enumerator iterating through current collection.

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

◆ idx_get()

template<class T >
virtual T System::Collections::ObjectModel::Collection< T >::idx_get ( int  index) const
inlineoverridevirtual

Gets value at specified index.

Parameters
indexIndex to get value from.
Returns
Copy of value at specified index.

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

◆ idx_set()

template<class T >
virtual void System::Collections::ObjectModel::Collection< T >::idx_set ( int  index,
value 
)
inlineoverridevirtual

Sets value at specified index.

Parameters
indexIndex to set value at.
valueValue to set at specified index.

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

◆ IndexOf()

template<class T >
int System::Collections::ObjectModel::Collection< T >::IndexOf ( const T &  item) const
inlineoverridevirtual

Looks for element in collection.

Parameters
itemItem to look for.
Returns
Index of first occurrence of specified item or -1 if not found.

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

◆ Insert()

template<class T >
void System::Collections::ObjectModel::Collection< T >::Insert ( int  index,
const T &  item 
)
inlineoverridevirtual

Inserts item into specified position.

Parameters
indexIndex to insert item into.
itemItem to insert into specified position.

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

◆ InsertItem()

template<class T >
virtual void System::Collections::ObjectModel::Collection< T >::InsertItem ( int  index,
const T &  item 
)
inlineprotectedvirtual

Inserts item into specified position.

Parameters
indexIndex to insert item into.
itemItem to insert into specified position.

Reimplemented in System::Collections::ObjectModel::KeyedCollection< TKey, TItem >.

◆ operator[]() [1/2]

template<class T >
T& System::Collections::ObjectModel::Collection< T >::operator[] ( int  index)
inline

Gets value at specified index.

Parameters
indexIndex to get value from.
Returns
Reference to existing value at specified index.

◆ operator[]() [2/2]

template<class T >
const T& System::Collections::ObjectModel::Collection< T >::operator[] ( int  index) const
inline

Gets value at specified index.

Parameters
indexIndex to get value from.
Returns
Const reference to existing value at specified index.

◆ rbegin() [1/2]

template<class T >
const_reverse_iterator System::Collections::ObjectModel::Collection< T >::rbegin ( ) const
inlinenoexcept

Gets a reverse iterator to the last element of the const-qualified collection (first in reverse).

Returns
A reverse iterator pointing to the last element in the const-qualified list (first in reverse).

◆ rbegin() [2/2]

template<class T >
reverse_iterator System::Collections::ObjectModel::Collection< T >::rbegin ( )
inlinenoexcept

Gets a reverse iterator to the last element of collection (first in reverse).

Returns
A reverse iterator pointing to the last element in the list (first in reverse).

◆ Remove()

template<class T >
bool System::Collections::ObjectModel::Collection< T >::Remove ( const T &  item)
inlineoverridevirtual

Removes specific item.

Parameters
itemItem to remove.
Returns
True if item was found and removed, false otherwise.

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

◆ RemoveAt()

template<class T >
void System::Collections::ObjectModel::Collection< T >::RemoveAt ( int  index)
inlineoverridevirtual

Removes item at specific position.

Parameters
indexIndex to remove item at.

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

◆ RemoveItem()

template<class T >
virtual void System::Collections::ObjectModel::Collection< T >::RemoveItem ( int  index)
inlineprotectedvirtual

Removes item from specified position.

Parameters
indexIndex to remove item from.

Reimplemented in System::Collections::ObjectModel::KeyedCollection< TKey, TItem >.

◆ rend() [1/2]

template<class T >
const_reverse_iterator System::Collections::ObjectModel::Collection< T >::rend ( ) const
inlinenoexcept

Gets a reverse iterator for a non-existent element before the start of the const-qualified collection.

Returns
A reverse iterator pointing to the theoretical element preceding the first element in the const-qualified list (last in reverse).

◆ rend() [2/2]

template<class T >
reverse_iterator System::Collections::ObjectModel::Collection< T >::rend ( )
inlinenoexcept

Gets a reverse iterator for a non-existent element before the start of the collection.

Returns
A reverse iterator pointing to the theoretical element preceding the first element in the list (last in reverse).

◆ SetItem()

template<class T >
virtual void System::Collections::ObjectModel::Collection< T >::SetItem ( int  index,
const T &  item 
)
inlineprotectedvirtual

Sets item at specified position.

Parameters
indexIndex to set item at.
itemValue to set at specified position.

◆ SetTemplateWeakPtr()

template<class T >
void System::Collections::ObjectModel::Collection< T >::SetTemplateWeakPtr ( uint32_t  argument)
inlineoverridevirtual

Makes stored pointers weak (if applicable).

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

Reimplemented from System::Object.