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 (uint32_t 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 ()
 Creates empty collection. More...
 
 Collection (SharedPtr< Generic::IList< TItem >> list)
 
SharedPtr< Generic::IList< TItem > > get_Items ()
 Internal data structure accessor. More...
 
const Generic::ListPtr< TItem > get_Items () const
 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 (uint32_t argument) override
 Makes stored pointers weak (if applicable). More...
 
reverse_iterator rbegin () noexcept
 Gets a reverse iterator to the last element of collection (first in reverse). More...
 
const_reverse_iterator rbegin () const noexcept
 Gets a reverse iterator to the last element of the const-qualified collection (first in reverse). More...
 
reverse_iterator rend () noexcept
 Gets a reverse iterator for a non-existent element before the start of the collection. More...
 
const_reverse_iterator rend () const noexcept
 Gets a reverse iterator for a non-existent element before the start of the const-qualified collection. More...
 
const_reverse_iterator crbegin () const noexcept
 Gets a reverse iterator to the last const-qualified element of collection (first in reverse). More...
 
const_reverse_iterator crend () const noexcept
 Gets a reverse iterator for a non-existent const-qualified element before the start of the collection. More...
 
- Public Member Functions inherited from System::Collections::Generic::IList< TItem >
virtual bool get_IsFixedSize ()
 Checks whether the collection is of fixed size. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< T >
virtual void Add (const T &item)=0
 Adds element into collection. More...
 
virtual bool Contains (const T &item) const =0
 Checks if element is present in collection. More...
 
virtual bool Remove (const T &item)=0
 Deletes element from collection. More...
 
virtual bool get_IsReadOnly () const
 Checks if collection is read only. More...
 
virtual void CopyTo (System::ArrayPtr< T > array, int arrayIndex)=0
 Copies all collection elements to existing array elements. 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...
 
SharedPtr< IEnumerable< T > > LINQ_Concat (SharedPtr< IEnumerable< T >> sequence)
 Concatenates two sequences. 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 Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
- 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 reference 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 int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () 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...
 
virtual ASPOSECPP_SHARED_API 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 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 ()
 Gets dictionary. More...
 
 KeyedCollection ()
 Creates empty keyed collection. More...
 
 KeyedCollection (const System::SharedPtr< System::Collections::Generic::IEqualityComparer< TKey >> &comparer)
 Creates empty keyed collection. More...
 
 KeyedCollection (const System::SharedPtr< System::Collections::Generic::IEqualityComparer< TKey >> &comparer, int dictionaryCreationThreshold)
 Creates empty keyed collection. More...
 
void ChangeItemKey (TItem item, TKey newKey)
 Changes item's key. More...
 
virtual void ClearItems () override
 Deletes all elements. More...
 
virtual TKey GetKeyForItem (TItem item)=0
 Defines a way to extract key from item. More...
 
virtual void InsertItem (int index, const TItem &item) override
 Inserts item at specific index. More...
 
virtual void RemoveItem (int index) override
 Removes item at specified index. More...
 
virtual void SetItem (int index, TItem item)
 Sets item at specified index. More...
 
- Protected Member Functions inherited from System::Collections::ObjectModel::Collection< TItem >
 ~Collection () override
 Destructor. More...
 
virtual void SetItem (int index, const TItem &item)
 Sets item at specified position. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from System::Collections::ObjectModel::Collection< TItem >
typedef reverse_iterator_prototype< TItem > reverse_iterator
 
typedef reverse_iterator_prototype< TItem > const_reverse_iterator
 
- 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< 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 Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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 ()
 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 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 ( uint32_t  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.