System::Collections::CollectionBase< T > Class Template Reference

Provides an abstract base class for a strongly typed collection. More...

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

Classes

class  ListImpl
 Provides an interface for accessing the elements in the collection. More...
 

Public Types

using Ptr = SharedPtr< CollectionBase >
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< T >
typedef IEnumerator< T > IEnumeratorType
 Enumerator type. More...
 
using ValueType = T
 
using iterator = System::Details::VirtualizedIterator< T >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< T >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< T >
 Inner iterator base type. More...
 
using virtualized_iterator_element = T
 Inner iterator element type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

int32_t get_Capacity ()
 Returns the number of elements that the collection can contain. More...
 
void set_Capacity (int32_t value)
 Sets the number of elements that the collection can contain. More...
 
int32_t get_Count ()
 Returns the number of elements contained in the collection instance. This method cannot be overridden. More...
 
void Clear ()
 Removes all objects from the collection instance. This method cannot be overridden. More...
 
void RemoveAt (int32_t index)
 Removes the element at the specified index of the collection instance. This method is not overridable. More...
 
SharedPtr< Generic::IEnumerator< T > > GetEnumerator () override
 Returns an enumerator that iterates through the collection instance. More...
 
void SetTemplateWeakPtr (uint32_t argument) override
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< T > > LINQ_Concat (SharedPtr< IEnumerable< T >> sequence)
 Concatenates two sequences. More...
 
template<typename Key >
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, T > > > > LINQ_GroupBy (System::Func< T, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< T, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. 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...
 
virtual virtualized_iteratorvirtualizeBeginIterator ()
 Gets the implementation of begin iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndIterator ()
 Gets the implementation of end iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeBeginConstIterator () const
 Gets the implementation of begin const iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndConstIterator () const
 Gets the implementation of end const iterator for the current container. 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 Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, 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)
 
template<typename Key >
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< 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 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 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

SharedPtr< System::Collections::Generic::List< T > > get_InnerList ()
 Returns a List containing the list of elements in the collection instance. More...
 
SharedPtr< ListImplget_List ()
 Returns a ListImpl containing the list of elements in the collection instance. More...
 
 CollectionBase ()
 Initializes a new instance of the Collections::CollectionBase class with the default initial capacity. More...
 
 CollectionBase (int32_t capacity)
 Initializes a new instance of the Collections::CollectionBase class with the specified capacity. More...
 
virtual void OnSet (int32_t index, const T &oldValue, const T &newValue)
 Performs additional custom processes before setting a value in the collection instance. More...
 
virtual void OnInsert (int32_t index, const T &value)
 Performs additional custom processes before inserting a new element into the collection instance. More...
 
virtual void OnClear ()
 Performs additional custom processes when clearing the contents of the collection instance. More...
 
virtual void OnRemove (int32_t index, const T &value)
 Performs additional custom processes when removing an element from the collection instance. More...
 
virtual void OnValidate (const T &value)
 Performs additional custom processes when validating a value. More...
 
virtual void OnSetComplete (int32_t index, const T &oldValue, const T &newValue)
 Performs additional custom processes after setting a value in the collection instance. More...
 
virtual void OnInsertComplete (int32_t index, const T &value)
 Performs additional custom processes after inserting a new element into the collection instance. More...
 
virtual void OnClearComplete ()
 Performs additional custom processes after clearing the contents of the collection instance. More...
 
virtual void OnRemoveComplete (int32_t index, const T &value)
 Performs additional custom processes after removing an element from the collection instance. More...
 
virtual ~CollectionBase ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator ()
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator () const
 Gets enumerator instance and prepares it to be used as iterator kernel. 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::CollectionBase< T >

Provides an abstract base class for a strongly typed collection.

Template Parameters
TType of elements of the collection

Member Typedef Documentation

◆ Ptr

template<typename T>
using System::Collections::CollectionBase< T >::Ptr = SharedPtr<CollectionBase>

An alias for shared pointer to an instance of this class.

Constructor & Destructor Documentation

◆ CollectionBase() [1/2]

template<typename T>
System::Collections::CollectionBase< T >::CollectionBase ( )
inlineprotected

Initializes a new instance of the Collections::CollectionBase class with the default initial capacity.

◆ CollectionBase() [2/2]

template<typename T>
System::Collections::CollectionBase< T >::CollectionBase ( int32_t  capacity)
inlineprotected

Initializes a new instance of the Collections::CollectionBase class with the specified capacity.

Parameters
capacityThe number of elements that the new list can initially store.

◆ ~CollectionBase()

template<typename T>
virtual System::Collections::CollectionBase< T >::~CollectionBase ( )
inlineprotectedvirtual

Member Function Documentation

◆ Clear()

template<typename T>
void System::Collections::CollectionBase< T >::Clear ( )
inline

Removes all objects from the collection instance. This method cannot be overridden.

◆ get_Capacity()

template<typename T>
int32_t System::Collections::CollectionBase< T >::get_Capacity ( )
inline

Returns the number of elements that the collection can contain.

Returns
The number of elements that the collection can contain.

◆ get_Count()

template<typename T>
int32_t System::Collections::CollectionBase< T >::get_Count ( )
inline

Returns the number of elements contained in the collection instance. This method cannot be overridden.

Returns
The number of elements contained in the collection instance. Retrieving the value of this method is an O(1) operation.

◆ get_InnerList()

template<typename T>
SharedPtr<System::Collections::Generic::List<T> > System::Collections::CollectionBase< T >::get_InnerList ( )
inlineprotected

Returns a List containing the list of elements in the collection instance.

Returns
A List representing the collection instance itself. Retrieving the value of this method is an O(1) operation.

◆ get_List()

template<typename T>
SharedPtr<ListImpl> System::Collections::CollectionBase< T >::get_List ( )
inlineprotected

Returns a ListImpl containing the list of elements in the collection instance.

Returns
A ListImpl representing the collection instance itself.

◆ GetEnumerator()

template<typename T>
SharedPtr<Generic::IEnumerator<T> > System::Collections::CollectionBase< T >::GetEnumerator ( )
inlineoverridevirtual

Returns an enumerator that iterates through the collection instance.

Returns
An IEnumerator for the collection instance.

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

◆ OnClear()

template<typename T>
virtual void System::Collections::CollectionBase< T >::OnClear ( )
inlineprotectedvirtual

Performs additional custom processes when clearing the contents of the collection instance.

Reimplemented in System::Xml::Schema::XmlSchemaObjectCollection.

◆ OnClearComplete()

template<typename T>
virtual void System::Collections::CollectionBase< T >::OnClearComplete ( )
inlineprotectedvirtual

Performs additional custom processes after clearing the contents of the collection instance.

◆ OnInsert()

template<typename T>
virtual void System::Collections::CollectionBase< T >::OnInsert ( int32_t  index,
const T &  value 
)
inlineprotectedvirtual

Performs additional custom processes before inserting a new element into the collection instance.

Parameters
indexThe zero-based index at which to insert value.
valueThe new value of the element at index.

Reimplemented in System::Xml::Schema::XmlSchemaObjectCollection.

◆ OnInsertComplete()

template<typename T>
virtual void System::Collections::CollectionBase< T >::OnInsertComplete ( int32_t  index,
const T &  value 
)
inlineprotectedvirtual

Performs additional custom processes after inserting a new element into the collection instance.

Parameters
indexThe zero-based index at which to insert value.
valueThe new value of the element at index.

◆ OnRemove()

template<typename T>
virtual void System::Collections::CollectionBase< T >::OnRemove ( int32_t  index,
const T &  value 
)
inlineprotectedvirtual

Performs additional custom processes when removing an element from the collection instance.

Parameters
indexThe zero-based index at which value can be found.
valueThe value of the element to remove from index.

Reimplemented in System::Xml::Schema::XmlSchemaObjectCollection.

◆ OnRemoveComplete()

template<typename T>
virtual void System::Collections::CollectionBase< T >::OnRemoveComplete ( int32_t  index,
const T &  value 
)
inlineprotectedvirtual

Performs additional custom processes after removing an element from the collection instance.

Parameters
indexThe zero-based index at which value can be found.
valueThe value of the element to remove from index.

◆ OnSet()

template<typename T>
virtual void System::Collections::CollectionBase< T >::OnSet ( int32_t  index,
const T &  oldValue,
const T &  newValue 
)
inlineprotectedvirtual

Performs additional custom processes before setting a value in the collection instance.

Parameters
indexThe zero-based index at which oldValue can be found.
oldValueThe value to replace with newValue.
newValueThe new value of the element at index.

Reimplemented in System::Xml::Schema::XmlSchemaObjectCollection.

◆ OnSetComplete()

template<typename T>
virtual void System::Collections::CollectionBase< T >::OnSetComplete ( int32_t  index,
const T &  oldValue,
const T &  newValue 
)
inlineprotectedvirtual

Performs additional custom processes after setting a value in the collection instance.

Parameters
indexThe zero-based index at which oldValue can be found.
oldValueThe value to replace with newValue.
newValueThe new value of the element at index.

◆ OnValidate()

template<typename T>
virtual void System::Collections::CollectionBase< T >::OnValidate ( const T &  value)
inlineprotectedvirtual

Performs additional custom processes when validating a value.

Parameters
valueThe object to validate.
Exceptions
ArgumentNullExceptionvalue is nullptr.

◆ RemoveAt()

template<typename T>
void System::Collections::CollectionBase< T >::RemoveAt ( int32_t  index)
inline

Removes the element at the specified index of the collection instance. This method is not overridable.

Parameters
indexThe zero-based index of the element to remove.
Exceptions
ArgumentOutOfRangeExceptionindex is less than zero. -or- index is equal to or greater than CollectionBase::Count.

◆ set_Capacity()

template<typename T>
void System::Collections::CollectionBase< T >::set_Capacity ( int32_t  value)
inline

Sets the number of elements that the collection can contain.

Parameters
valueThe value to set.
Exceptions
ArgumentOutOfRangeExceptionThe value is set to a value that is less than CollectionBase::get_Count.
OutOfMemoryExceptionThere is not enough memory available on the system.

◆ SetTemplateWeakPtr()

template<typename T>
void System::Collections::CollectionBase< T >::SetTemplateWeakPtr ( uint32_t  argument)
inlineoverridevirtual

Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.

Parameters
argumentIndex of template argument to treat as weak poiner.

Reimplemented from System::Object.