Asposecpplib
System::Collections::Generic::IDictionary< TKey, TValue > Class Template Referenceabstract

Interface for dictionary-alike containers. 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::Generic::ICollection< KeyValuePair< TKey, TValue > >.

Public Types

typedef ICollection< KeyValuePair< TKey, TValue > > BaseType
 Base interface type. More...
 
typedef KeyValuePair< TKey, TValue > KeyValuePairType
 Key value pair type. More...
 
- Public Types inherited from System::Collections::Generic::ICollection< KeyValuePair< TKey, TValue > >
typedef KeyValuePair< TKey, TValue > ValueType
 Value type name. More...
 
typedef ICollection< KeyValuePair< TKey, TValue > > 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...
 

Public Member Functions

virtual void Add (const TKey &key, const TValue &value)=0
 Adds key-value pair into container. More...
 
virtual bool ContainsKey (const TKey &key) const =0
 Checks if container contains key. More...
 
virtual bool Remove (const TKey &key)=0
 Removes key from container. More...
 
virtual bool TryGetValue (const TKey &key, TValue &value) const =0
 Looks for value and retreives it if found. More...
 
virtual TValue idx_get (const TKey &key) const =0
 Getter function. More...
 
virtual void idx_set (const TKey &key, TValue value)=0
 Setter function. More...
 
virtual SharedPtr< ICollection< TKey > > get_Keys () const
 Accesses key collection. More...
 
virtual SharedPtr< ICollection< TValue > > get_Values () const
 Accesses value collection. More...
 
bool get_IsFixedSize () const
 Checks if collection size is fixed. More...
 
bool get_IsSynchronized () const
 Checks if container is thread-safe. More...
 
virtual void CopyTo (ArrayPtr< KeyValuePair< TKey, TValue >> arr, int index) override
 Copies dictionary contents into existing array elements. More...
 
virtual TValue GetValueOrDefault (const TKey &key) const
 Returns value if found; or Value() otherwise. More...
 
virtual TValue GetValueOrDefault (const TKey &key, const TValue &defaultValue) const
 Returns value if found; or defaultValue otherwise. More...
 
virtual TValue GetValueOrNull (const TKey &key) const
 Returns value if found; or null otherwise, make sense only for reference types. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< KeyValuePair< TKey, TValue > >
virtual int get_Count () const=0
 Gets number of elements in collection. More...
 
virtual void Add (const KeyValuePair< TKey, TValue > &item)=0
 Adds element into collection. More...
 
virtual void Clear ()=0
 Deletes all elements from collection. More...
 
virtual bool Contains (const KeyValuePair< TKey, TValue > &item) const=0
 Checks if element is present in collection. More...
 
virtual bool Remove (const KeyValuePair< TKey, TValue > &item)=0
 Deletes element from collection. More...
 
virtual bool get_IsReadOnly () const
 Checks if collection is read only. More...
 
virtual void CopyTo (System::ArrayPtr< KeyValuePair< TKey, TValue > > 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 >
virtual SharedPtr< IEnumerator< T > > GetEnumerator ()=0
 Gets enumerator. More...
 
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 void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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...
 

Protected Member Functions

 ~IDictionary () override
 Destructor. More...
 
virtual SharedPtr< ICollection< TKey > > get_KeysInternal () const
 Implementation of get_Keys() method. More...
 
virtual SharedPtr< ICollection< TValue > > get_ValuesInternal () const
 Implementation of get_Values() method. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. 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 TKey, typename TValue>
class System::Collections::Generic::IDictionary< TKey, TValue >

Interface for dictionary-alike containers. 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.
TValueValue type.

Member Typedef Documentation

◆ BaseType

template<typename TKey , typename TValue >
typedef ICollection<KeyValuePair<TKey, TValue> > System::Collections::Generic::IDictionary< TKey, TValue >::BaseType

Base interface type.

◆ KeyValuePairType

template<typename TKey , typename TValue >
typedef KeyValuePair<TKey, TValue> System::Collections::Generic::IDictionary< TKey, TValue >::KeyValuePairType

Key value pair type.

Constructor & Destructor Documentation

◆ ~IDictionary()

template<typename TKey , typename TValue >
System::Collections::Generic::IDictionary< TKey, TValue >::~IDictionary ( )
inlineoverrideprotected

Destructor.

Member Function Documentation

◆ Add()

◆ ContainsKey()

◆ CopyTo()

template<typename TKey , typename TValue >
virtual void System::Collections::Generic::IDictionary< TKey, TValue >::CopyTo ( ArrayPtr< KeyValuePair< TKey, TValue >>  arr,
int  index 
)
inlineoverridevirtual

Copies dictionary contents into existing array elements.

Parameters
arrDestination array.
indexDestination array start index.

◆ get_IsFixedSize()

template<typename TKey , typename TValue >
bool System::Collections::Generic::IDictionary< TKey, TValue >::get_IsFixedSize ( ) const
inline

Checks if collection size is fixed.

Returns
True if size is fixed, false otherwise.

◆ get_IsSynchronized()

template<typename TKey , typename TValue >
bool System::Collections::Generic::IDictionary< TKey, TValue >::get_IsSynchronized ( ) const
inline

Checks if container is thread-safe.

Returns
True if container access methods are thread-safe, false otherwise.

◆ get_Keys()

template<typename TKey , typename TValue >
virtual SharedPtr<ICollection<TKey> > System::Collections::Generic::IDictionary< TKey, TValue >::get_Keys ( ) const
inlinevirtual

Accesses key collection.

Returns
Pointer to interface providing access to stored keys via ICollection interface.

◆ get_KeysInternal()

◆ get_Values()

template<typename TKey , typename TValue >
virtual SharedPtr<ICollection<TValue> > System::Collections::Generic::IDictionary< TKey, TValue >::get_Values ( ) const
inlinevirtual

Accesses value collection.

Returns
Pointer to interface providing access to stored values via ICollection interface.

◆ get_ValuesInternal()

◆ GetValueOrDefault() [1/2]

◆ GetValueOrDefault() [2/2]

◆ GetValueOrNull()

◆ idx_get()

◆ idx_set()

◆ Remove()

◆ TryGetValue()