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...
 
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

 ReadOnlyCollection (const SharedPtr< Generic::IList< T >> &list)
 Wraps read-only collection around specific collection. More...
 
virtual ~ReadOnlyCollection () override
 Destructor. 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 (unsigned int argument) override
 Does nothing as read-only collection only wraps data and stores nothing. More...
 
- 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 () ASPOSE_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...
 
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...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< T >
virtual bool get_IsReadOnly () const
 Checks if collection is read only. 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::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

◆ 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 >
virtual System::Collections::ObjectModel::ReadOnlyCollection< T >::~ReadOnlyCollection ( )
inlineoverridevirtual

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 ( unsigned int  argument)
inlineoverridevirtual

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

Reimplemented from System::Object.