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

Inherits System::Collections::ObjectModel::Collection< TItem >.

Public Member Functions

virtual void Add (const TItem &item) override
 
System::SharedPtr< System::Collections::Generic::IEqualityComparer< TKey > > get_Comparer ()
 
TItem idx_get (TKey key)
 
bool Contains (TKey key)
 
bool Remove (TKey key)
 
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...
 
 Collection (Generic::ListPtr< TItem > list)
 
Generic::ListPtr< TItem > get_Items ()
 
int get_Count () const override
 
virtual TItem idx_get (int index) const override
 
virtual void idx_set (int index, TItem value) override
 
TItem & operator[] (int index)
 
const TItem & operator[] (int index) const
 
void Clear () override
 Deletes all elements. More...
 
bool Contains (const TItem &item) const override
 
SharedPtr< Generic::IEnumerator< TItem > > GetEnumerator () override
 
int IndexOf (const TItem &item) const override
 
void Insert (int index, const TItem &item) override
 
bool Remove (const TItem &item) override
 
void RemoveAt (int index) override
 
virtual void CopyTo (ArrayPtr< TItem > arr, int index) override
 
void SetTemplateWeakPtr (unsigned int argument) override
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< TItem >
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...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< TItem >
TItem LINQ_ElementAt (int index)
 
TItem LINQ_First ()
 
System::SharedPtr< Collections::Generic::List< TItem > > LINQ_ToList ()
 
int LINQ_Count ()
 
System::ArrayPtr< TItem > LINQ_ToArray ()
 
- 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 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...
 

Protected Member Functions

 ~KeyedCollection () override=default
 Destructor. More...
 
System::SharedPtr< Generic::IDictionary< TKey, TItem > > get_Dictionary ()
 
 KeyedCollection ()
 Creates empty keyed collection. More...
 
 KeyedCollection (const System::SharedPtr< System::Collections::Generic::IEqualityComparer< TKey >> &comparer)
 
 KeyedCollection (const System::SharedPtr< System::Collections::Generic::IEqualityComparer< TKey >> &comparer, int dictionaryCreationThreshold)
 
void ChangeItemKey (TItem item, TKey newKey)
 
virtual void ClearItems () override
 Deletes all elements. More...
 
virtual TKey GetKeyForItem (TItem item)=0
 
virtual void InsertItem (int index, const TItem &item) override
 
virtual void RemoveItem (int index) override
 
virtual void SetItem (int index, TItem item)
 
- Protected Member Functions inherited from System::Collections::ObjectModel::Collection< TItem >
 ~Collection () override
 Destructor. More...
 
virtual void SetItem (int index, const TItem &item)
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< TItem >
 ~IEnumerable () override
 Destructor. 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.

Constructor & Destructor Documentation

◆ ~KeyedCollection()

template<typename TKey , typename TItem >
System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::~KeyedCollection ( )
overrideprotecteddefault

Destructor.

◆ KeyedCollection() [1/3]

template<typename TKey , typename TItem >
System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::KeyedCollection ( )
inlineprotected

Creates empty keyed collection.

◆ KeyedCollection() [2/3]

template<typename TKey , typename TItem >
System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::KeyedCollection ( const System::SharedPtr< System::Collections::Generic::IEqualityComparer< TKey >> &  comparer)
inlineprotected

Creates empty keyed collection.

Parameters
comparerComparer to use.

◆ KeyedCollection() [3/3]

template<typename TKey , typename TItem >
System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::KeyedCollection ( const System::SharedPtr< System::Collections::Generic::IEqualityComparer< TKey >> &  comparer,
int  dictionaryCreationThreshold 
)
inlineprotected

Creates empty keyed collection.

Parameters
comparerComparer to use.
dictionaryCreationThresholdNumber of elements to create lookup dictionary at.

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

◆ ChangeItemKey()

template<typename TKey , typename TItem >
void System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::ChangeItemKey ( TItem  item,
TKey  newKey 
)
inlineprotected

Changes item's key.

Parameters
itemItem to change key for.
newKeyNew key to set for item.

◆ ClearItems()

template<typename TKey , typename TItem >
virtual void System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::ClearItems ( )
inlineoverrideprotectedvirtual

Deletes all elements.

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.

◆ get_Dictionary()

template<typename TKey , typename TItem >
System::SharedPtr<Generic::IDictionary<TKey, TItem> > System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::get_Dictionary ( )
inlineprotected

Gets dictionary.

Returns
Lookup dictionary pointer (if created) or nullptr.

◆ GetKeyForItem()

template<typename TKey , typename TItem >
virtual TKey System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::GetKeyForItem ( TItem  item)
protectedpure virtual

Defines a way to extract key from item.

Parameters
itemItem to extract key from.
Returns
Extracted key value.

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

◆ InsertItem()

template<typename TKey , typename TItem >
virtual void System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::InsertItem ( int  index,
const TItem &  item 
)
inlineoverrideprotectedvirtual

Inserts item at specific index.

Parameters
indexIndex to insert item at.
itemItem to insert at specified index.

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

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

◆ RemoveItem()

template<typename TKey , typename TItem >
virtual void System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::RemoveItem ( int  index)
inlineoverrideprotectedvirtual

Removes item at specified index.

Parameters
indexIndex to remove item at.

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

◆ SetItem()

template<typename TKey , typename TItem >
virtual void System::Collections::ObjectModel::KeyedCollection< TKey, TItem >::SetItem ( int  index,
TItem  item 
)
inlineprotectedvirtual

Sets item at specified index.

Parameters
indexIndex to set item at.
itemItem to set.

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