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

Wraps specific container to access it in read-only mode. 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::Object, and System::Collections::Generic::IList< T >.

Public Types

typedef T ValueType
 Value type. More...
 
typedef Generic::IList< T > BaseType
 Implemented interface. More...
 
typedef SharedPtr< System::Collections::Generic::IEnumerator< T > > IEnumeratorPtr
 Container of same elements. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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...
 
using ValueType = T
 
using iterator = EnumeratorBasedIterator< T, IEnumerator< T > >
 
using const_iterator = iterator
 

Public Member Functions

 ReadOnlyCollection (const SharedPtr< Generic::IList< T >> &list)
 Wraps read-only collection around specific collection. More...
 
virtual IEnumeratorPtr GetEnumerator () override
 Gets collection enumerator. More...
 
virtual int get_Count () const override
 Gets count of container elements. More...
 
virtual bool Contains (const T &item) const override
 Checks if container contains specific item. More...
 
virtual int IndexOf (const T &item) const override
 Looks for specific item in collection. More...
 
virtual T idx_get (int index) const override
 Gets item at specific position. More...
 
virtual void CopyTo (System::ArrayPtr< T > array, int index) override
 Copies container elements to existing array elements. More...
 
void SetTemplateWeakPtr (uint32_t argument) override
 Does nothing as read-only collection only wraps data and stores nothing. More...
 
- 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...
 
- 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...
 
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...
 
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)
 

Protected Types

typedef SharedPtr< ReadOnlyCollection< T > > ThisPtr
 This pointer. More...
 

Protected Member Functions

 ~ReadOnlyCollection () override
 Destructor. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. More...
 

Protected Attributes

SharedPtr< Generic::IList< T > > m_list
 Wrapped 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 ()
 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<typename T>
class System::Collections::ObjectModel::ReadOnlyCollection< T >

Wraps specific container to access it in read-only mode. 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

Implemented interface.

◆ IEnumeratorPtr

◆ ThisPtr

This pointer.

◆ ValueType

template<typename T >
typedef T System::Collections::ObjectModel::ReadOnlyCollection< T >::ValueType

Value type.

Constructor & Destructor Documentation

◆ ReadOnlyCollection()

template<typename T >
System::Collections::ObjectModel::ReadOnlyCollection< T >::ReadOnlyCollection ( const SharedPtr< Generic::IList< T >> &  list)
inline

Wraps read-only collection around specific collection.

Parameters
listCollection to wrap.

◆ ~ReadOnlyCollection()

template<typename T >
System::Collections::ObjectModel::ReadOnlyCollection< T >::~ReadOnlyCollection ( )
inlineoverrideprotected

Destructor.

Member Function Documentation

◆ Contains()

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

Checks if container contains specific item.

Parameters
itemItem to look for.
Returns
true if item is found, false otherwise.

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

◆ CopyTo()

template<typename T >
virtual void System::Collections::ObjectModel::ReadOnlyCollection< T >::CopyTo ( System::ArrayPtr< T >  array,
int  index 
)
inlineoverridevirtual

Copies container elements to existing array elements.

Parameters
arrayDestination array.
indexDestination array beginning index.

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

◆ get_Count()

template<typename T >
virtual int System::Collections::ObjectModel::ReadOnlyCollection< T >::get_Count ( ) const
inlineoverridevirtual

Gets count of container elements.

Returns
Actual elements count.

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

◆ GetEnumerator()

template<typename T >
virtual IEnumeratorPtr System::Collections::ObjectModel::ReadOnlyCollection< T >::GetEnumerator ( )
inlineoverridevirtual

Gets collection enumerator.

Returns
Pointer to newly created enumerator.

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

◆ idx_get()

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

Gets item at specific position.

Parameters
indexIndex to get element from.
Returns
Copy of element at specified position.

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

◆ IndexOf()

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

Looks for specific item in collection.

Parameters
itemItem to look for.
Returns
Index of the first occurrence of specified item or negative value if not found.

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

◆ SetTemplateWeakPtr()

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

Does nothing as read-only collection only wraps data and stores nothing.

Reimplemented from System::Object.

Member Data Documentation

◆ m_list

template<typename T >
SharedPtr<Generic::IList<T> > System::Collections::ObjectModel::ReadOnlyCollection< T >::m_list
protected

Wrapped container.