System::Collections::Generic::ArrayList< T > Class Template Reference

Inherits System::Object, and System::Collections::Generic::IList< T >.

Classes

class  Enumerator
 

Public Types

typedef IList< T > BaseType
 Implemented interface considered basetype. More...
 
typedef SharedPtr< ICollection< T > > ICollectionPtr
 Pointer to collection; used by copy constructor. More...
 
typedef SharedPtr< ArrayList< T > > ThisPtr
 Poiinter to this type. More...
 
typedef System::Details::CollectionHelpers::ContainerPointerMode< T > pointer_mode_t
 Service class to control contained pointer mode (shared/weak) via allocator. More...
 
typedef std::vector< T, typename pointer_mode_t::allocator_type > storage_type
 Underlying data type. More...
 
- 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::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...
 

Public Member Functions

 ArrayList ()
 Constructs empty array. More...
 
 ArrayList (ICollectionPtr source)
 
 ArrayList (int capacity)
 
int get_Capacity () const
 
void set_Capacity (int newCapacity)
 
void AddRange (const SharedPtr< IEnumerable< T >> &values)
 
SharedPtr< ArrayList< T > > GetRange (int index, int count)
 
virtual int IndexOf (const T &item) const override
 
virtual void Insert (int index, const T &item) override
 
virtual void RemoveAt (int index) override
 
storage_type::const_reference operator[] (int index) const
 
storage_type::reference operator[] (int index)
 
virtual T idx_get (int index) const override
 
virtual void idx_set (int index, T value) override
 
virtual int get_Count () const override
 
virtual void Add (const T &item) override
 
virtual void Clear () override
 Deletes all elements from container, sets its size to zero. More...
 
virtual bool Contains (const T &item) const override
 
virtual bool Remove (const T &item) override
 
virtual void CopyTo (System::ArrayPtr< T > arr, int index) override
 
virtual SharedPtr< IEnumerator< T > > GetEnumerator () override
 
void SetTemplateWeakPtr (unsigned int argument) override
 
- 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_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...
 
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::ICollection< T >
virtual bool get_IsReadOnly () const
 
ICollectionoperator= (ICollection &&)
 
ICollectionoperator= (const ICollection &)
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&)
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 

Protected Member Functions

 DEFINE_GET_SHARED_MEMBERS (m_data)
 Provides GetSharedMember() function for container. 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...
 

Detailed Description

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

Array with dynamic resize. 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

◆ BaseType

template<typename T>
typedef IList<T> System::Collections::Generic::ArrayList< T >::BaseType

Implemented interface considered basetype.

◆ ICollectionPtr

Pointer to collection; used by copy constructor.

◆ pointer_mode_t

template<typename T>
typedef System::Details::CollectionHelpers::ContainerPointerMode<T> System::Collections::Generic::ArrayList< T >::pointer_mode_t

Service class to control contained pointer mode (shared/weak) via allocator.

◆ storage_type

template<typename T>
typedef std::vector<T, typename pointer_mode_t::allocator_type> System::Collections::Generic::ArrayList< T >::storage_type

Underlying data type.

◆ ThisPtr

template<typename T>
typedef SharedPtr<ArrayList<T> > System::Collections::Generic::ArrayList< T >::ThisPtr

Poiinter to this type.

Constructor & Destructor Documentation

◆ ArrayList() [1/3]

template<typename T>
System::Collections::Generic::ArrayList< T >::ArrayList ( )
inline

Constructs empty array.

◆ ArrayList() [2/3]

template<typename T>
System::Collections::Generic::ArrayList< T >::ArrayList ( ICollectionPtr  source)
inline

Copy constructor.

Parameters
sourceCollection to copy data from.

◆ ArrayList() [3/3]

template<typename T>
System::Collections::Generic::ArrayList< T >::ArrayList ( int  capacity)
inline

Creates ArrayList of pre-defined capacity and zero size.

Parameters
capacityContainer capacity.

Member Function Documentation

◆ Add()

template<typename T>
virtual void System::Collections::Generic::ArrayList< T >::Add ( const T &  item)
inlineoverridevirtual

Puts element to the end of container.

Parameters
itemElement to push.

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

◆ AddRange()

template<typename T>
void System::Collections::Generic::ArrayList< T >::AddRange ( const SharedPtr< IEnumerable< T >> &  values)
inline

Copies elements to the end of container.

Parameters
valuesEnumerable object to copy elements from.

◆ Clear()

template<typename T>
virtual void System::Collections::Generic::ArrayList< T >::Clear ( )
inlineoverridevirtual

Deletes all elements from container, sets its size to zero.

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

◆ Contains()

template<typename T>
virtual bool System::Collections::Generic::ArrayList< T >::Contains ( const T &  item) const
inlineoverridevirtual

Checks if container contains specified element, uses operator == for elements comparison.

Parameters
itemItem to look for.
Returns
true if element is present, false otherwise.

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

◆ CopyTo()

template<typename T>
virtual void System::Collections::Generic::ArrayList< T >::CopyTo ( System::ArrayPtr< T >  arr,
int  index 
)
inlineoverridevirtual

Copies container contents to existing array positions.

Parameters
arrPointer to destination array.
indexDestination array position.

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

◆ DEFINE_GET_SHARED_MEMBERS()

template<typename T>
System::Collections::Generic::ArrayList< T >::DEFINE_GET_SHARED_MEMBERS ( m_data  )
protected

Provides GetSharedMember() function for container.

◆ get_Capacity()

template<typename T>
int System::Collections::Generic::ArrayList< T >::get_Capacity ( ) const
inline

Gets container capacity.

Returns
Actual capacity.

◆ get_Count()

template<typename T>
virtual int System::Collections::Generic::ArrayList< T >::get_Count ( ) const
inlineoverridevirtual

Gets current container size.

Returns
Actual container size.

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

◆ GetEnumerator()

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

Gets enumerator to iterate through container.

Returns
Enumerator associated with current container.

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

◆ GetRange()

template<typename T>
SharedPtr<ArrayList<T> > System::Collections::Generic::ArrayList< T >::GetRange ( int  index,
int  count 
)
inline

Gets a slice of container.

Parameters
indexSlice beginning position.
countSlice size.
Returns
Created slice.

◆ idx_get()

template<typename T>
virtual T System::Collections::Generic::ArrayList< T >::idx_get ( int  index) const
inlineoverridevirtual

Element getter.

Parameters
indexIndex of element to access in range of [0, size).
Returns
Copy of specified element.

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

◆ idx_set()

template<typename T>
virtual void System::Collections::Generic::ArrayList< T >::idx_set ( int  index,
value 
)
inlineoverridevirtual

Element setter.

Parameters
indexIndex of element to access in range of [0, size).
valueValue to set to specified element.

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

◆ IndexOf()

template<typename T>
virtual int System::Collections::Generic::ArrayList< T >::IndexOf ( const T &  item) const
inlineoverridevirtual

Linear search for element using operator ==.

Parameters
itemItem to look for.
Returns
Index of element (if found) or -1.

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

◆ Insert()

template<typename T>
virtual void System::Collections::Generic::ArrayList< T >::Insert ( int  index,
const T &  item 
)
inlineoverridevirtual

Inserts item into container position.

Parameters
indexInsertion position, must be in range [0, size].
itemElement to insert.

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

◆ operator[]() [1/2]

template<typename T>
storage_type::const_reference System::Collections::Generic::ArrayList< T >::operator[] ( int  index) const
inline

Element accessor.

Parameters
indexIndex of element to access in range of [0, size).
Returns
const reference to selected element.

◆ operator[]() [2/2]

template<typename T>
storage_type::reference System::Collections::Generic::ArrayList< T >::operator[] ( int  index)
inline

Element accessor.

Parameters
indexIndex of element to access in range of [0, size).
Returns
Reference to selected element.

◆ Remove()

template<typename T>
virtual bool System::Collections::Generic::ArrayList< T >::Remove ( const T &  item)
inlineoverridevirtual

Removes first instance of passed element found in container.

Parameters
itemElement to remove.
Returns
true if element was found and removed, false otherwise.

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

◆ RemoveAt()

template<typename T>
virtual void System::Collections::Generic::ArrayList< T >::RemoveAt ( int  index)
inlineoverridevirtual

Removes element at specified position.

Parameters
indexIndex to delete element from, must be in range [0, size).

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

◆ set_Capacity()

template<typename T>
void System::Collections::Generic::ArrayList< T >::set_Capacity ( int  newCapacity)
inline

Sets container capacity. Has no effect on its size.

Parameters
newCapacityRequested capacity. Must be greater or equal to zero.

◆ SetTemplateWeakPtr()

template<typename T>
void System::Collections::Generic::ArrayList< T >::SetTemplateWeakPtr ( unsigned int  argument)
inlineoverridevirtual

Makes specified template argument to be treated as weak pointer instead of shared one.

Parameters
argumentTemplate argument index (should be 0).

Reimplemented from System::Object.