Asposecpplib
System::Collections::ObjectModel::KeyedCollection< TKey, TItem > Class Template Referenceabstract

Abstract collection of elements with embedded keys. 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::ObjectModel::Collection< TItem >.

Public Member Functions

virtual void Add (const TItem &item) override
 Add item to container end. More...
 
System::SharedPtr< System::Collections::Generic::IEqualityComparer< TKey > > get_Comparer ()
 Gets comparer. More...
 
TItem idx_get (TKey key)
 Gets item at specific index. More...
 
bool Contains (TKey key)
 Checks if key is present in container. More...
 
bool Remove (TKey key)
 Removes key from container. More...
 
void SetTemplateWeakPtr (unsigned int argument) override
 Makes specific template argument to be treated as weak pointer instead of shared pointer (if applicable). More...
 
- Public Member Functions inherited from System::Collections::ObjectModel::Collection< TItem >
 Collection ()
 Createes empty collection. More...
 
Generic::ListPtr< TItem > get_Items ()
 Internal data structure accessor. More...
 
int get_Count () const override
 Gets number of elements. More...
 
virtual TItem idx_get (int index) const override
 Gets value at specified index. More...
 
virtual void idx_set (int index, TItem value) override
 Sets value at specified index. More...
 
TItem & operator[] (int index)
 Gets value at specified index. More...
 
const TItem & operator[] (int index) const
 Gets value at specified index. More...
 
void Clear () override
 Deletes all elements. More...
 
bool Contains (const TItem &item) const override
 Checks if item is present in collection. More...
 
SharedPtr< Generic::IEnumerator< TItem > > GetEnumerator () override
 Gets enumerator to iterate through collection. More...
 
int IndexOf (const TItem &item) const override
 Looks for element in collection. More...
 
void Insert (int index, const TItem &item) override
 Inserts item into specified position. More...
 
bool Remove (const TItem &item) override
 Removes specific item. More...
 
void RemoveAt (int index) override
 Removes item at specific position. More...
 
virtual void CopyTo (ArrayPtr< TItem > arr, int index) override
 Copies collection elements into existing array elements. More...
 
void SetTemplateWeakPtr (unsigned int argument) override
 Makes stored pointers weak (if applicable). More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< TItem >
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...
 
- 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 Attributes

System::SharedPtr< System::Collections::Generic::IEqualityComparer< TKey > > comparer
 Comparer to use. More...
 
System::SharedPtr< System::Collections::Generic::Dictionary< TKey, TItem > > dict
 Wrapped dictionary. More...
 
int keyCount
 Number of keys inserted into collection. More...
 
int threshold
 Lookup dictionary creation threshold, local. More...
 

Static Public Attributes

static const int defaultThreshold = 0
 Lookup dictionary creation threshold, default. More...
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::IList< TItem >
typedef ICollection< TItem > BaseType
 Base type. More...
 
typedef IList< TItem > ThisType
 This type. More...
 
typedef TItem ValueType
 Value type. More...
 
- Public Types inherited from System::Collections::Generic::ICollection< TItem >
typedef TItem ValueType
 Value type name. More...
 
typedef ICollection< TItem > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< TItem >
typedef IEnumerator< TItem > IEnumeratorType
 Enumerator 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...
 
- 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 TKey, typename TItem>
class System::Collections::ObjectModel::KeyedCollection< TKey, TItem >

Abstract collection of elements with embedded keys. 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
TKeyKey type.
TItemvalue type.

Member Function Documentation

◆ Add()

template<typename TKey , typename TItem >
virtual void System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::Add ( const TItem &  item)
inlineoverridevirtual

Add item to container end.

Parameters
itemItem to add.

Reimplemented from System::Collections::ObjectModel::Collection< TItem >.

◆ Contains()

template<typename TKey , typename TItem >
bool System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::Contains ( TKey  key)
inline

Checks if key is present in container.

Parameters
keyKey to look for.
Returns
True if key is found, false otherwise.

◆ get_Comparer()

template<typename TKey , typename TItem >
System::SharedPtr<System::Collections::Generic::IEqualityComparer<TKey> > System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::get_Comparer ( )
inline

Gets comparer.

Returns
Pointer to comparer in use.

◆ idx_get()

template<typename TKey , typename TItem >
TItem System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::idx_get ( TKey  key)
inline

Gets item at specific index.

Parameters
keyKey to look for.
Returns
Copy of keyed value.

◆ Remove()

template<typename TKey , typename TItem >
bool System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::Remove ( TKey  key)
inline

Removes key from container.

Parameters
keyKey to remove.
Returns
True if key is found and removed, false otherwise.

◆ SetTemplateWeakPtr()

template<typename TKey , typename TItem >
void System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::SetTemplateWeakPtr ( unsigned int  argument)
inlineoverridevirtual

Makes specific template argument to be treated as weak pointer instead of shared pointer (if applicable).

Reimplemented from System::Object.

Member Data Documentation

◆ comparer

template<typename TKey , typename TItem >
System::SharedPtr<System::Collections::Generic::IEqualityComparer<TKey> > System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::comparer

Comparer to use.

◆ defaultThreshold

template<typename TKey , typename TItem >
const int System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::defaultThreshold = 0
static

Lookup dictionary creation threshold, default.

Sets default lookup dictionary creation threshold to zero, can be overwrited for concrete types.

◆ dict

template<typename TKey , typename TItem >
System::SharedPtr<System::Collections::Generic::Dictionary<TKey, TItem> > System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::dict

Wrapped dictionary.

◆ keyCount

template<typename TKey , typename TItem >
int System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::keyCount

Number of keys inserted into collection.

◆ threshold

template<typename TKey , typename TItem >
int System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::threshold

Lookup dictionary creation threshold, local.