Asposecpplib
System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue > Class Template Reference

Thread-safe dictionary implementation. More...

Inherits System::Collections::Generic::Dictionary< TKey, TValue >.

Public Types

using ThisType = ConcurrentDictionary< TKey, TValue >
 This type. More...
 
using BaseType = System::Collections::Generic::Dictionary< TKey, TValue >
 Implementation type. More...
 
- Public Types inherited from System::Collections::Generic::Dictionary< TKey, TValue >
typedef ICollection< TKey > KeyCollection
 Collection of keys to extract. More...
 
typedef ICollection< TValue > ValueCollection
 Collection of values to extract. More...
 
typedef std::unordered_map< TKey, TValue, EqualityComparerHashAdapter< TKey >, EqualityComparerAdapter< TKey >, typename System::Details::CollectionHelpers::MapPointerMode< TKey, TValue >::allocator_type > map_t
 Underlying data type. More...
 
typedef SharedPtr< Dictionary< TKey, TValue > > Ptr
 Pointer type. More...
 
typedef KeyValuePair< TKey, TValue > KVPair
 Key-value pair type. More...
 
typedef SharedPtr< IEnumerable< KVPair > > IEnumerablePtr
 Pointer to enumerable interface. More...
 
typedef SharedPtr< IEnumerator< KVPair > > IEnumeratorPtr
 Pointer to enumerator. 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 Member Functions

virtual void idx_set (const TKey &key, TValue value) override
 Sets element at specific position. More...
 
virtual SharedPtr< typename ThisType::KeyCollectionget_KeysInternal () const override
 Gets wrapper collection to access dictionary keys. More...
 
virtual void Add (const TKey &key, const TValue &value) override
 Adds value into dictionary. More...
 
virtual void Clear () override
 Deletes all elements in container. More...
 
virtual void CopyTo (ArrayPtr< System::Collections::Generic::KeyValuePair< TKey, TValue >> arr, int index) override
 Copies container elements to existing array elements. More...
 
virtual bool Remove (const TKey &key) override
 Removes element from container. More...
 
- Public Member Functions inherited from System::Collections::Generic::Dictionary< TKey, TValue >
 Dictionary ()
 Creates empty dictionary. More...
 
 Dictionary (const map_t &map)
 Copies data from map. More...
 
 Dictionary (int capacity)
 Overload which corresponds to creating pre-allocated dictionary; does no allocation, actually. More...
 
 Dictionary (const SharedPtr< IDictionary< TKey, TValue > > &src)
 Copy constructor. More...
 
 Dictionary (const SharedPtr< IDictionary< TKey, TValue > > &src, const SharedPtr< IEqualityComparer< TKey > > &comparer)
 Copy constructor. More...
 
 Dictionary (const SharedPtr< IEqualityComparer< TKey > > &comparer)
 Creates empty dictionary. More...
 
 Dictionary (int capacity, const SharedPtr< IEqualityComparer< TKey > > &comparer)
 Creates empty dictionary. More...
 
virtual IEnumeratorPtr GetEnumerator () override
 Creates enumerator object. More...
 
KVPairIterator< KVPair, map_tbegin () noexcept
 Returns an iterator to the first element of the container. If the container is empty, the returned iterator will be equal to end(). More...
 
KVPairIterator< KVPair, map_tend () noexcept
 Returns an iterator to the element following the last element of the container. This element acts as a placeholder; attempting to access it results in undefined behavior. 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...
 

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<class TKey, class TValue>
class System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >

Thread-safe dictionary implementation.

Template Parameters
TKeyKey type.
TValueValue type. 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.

Member Typedef Documentation

◆ BaseType

template<class TKey , class TValue >
using System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::BaseType = System::Collections::Generic::Dictionary<TKey, TValue>

Implementation type.

◆ ThisType

template<class TKey , class TValue >
using System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::ThisType = ConcurrentDictionary<TKey, TValue>

This type.

Member Function Documentation

◆ Add()

template<class TKey , class TValue >
virtual void System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::Add ( const TKey &  key,
const TValue &  value 
)
inlineoverridevirtual

Adds value into dictionary.

Parameters
keyKey to add.
valueValue to add.

◆ Clear()

◆ CopyTo()

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

Copies container elements to existing array elements.

Parameters
arrDestination array.
indexIndex in destination array.

◆ get_KeysInternal()

◆ idx_set()

template<class TKey , class TValue >
virtual void System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::idx_set ( const TKey &  key,
TValue  value 
)
inlineoverridevirtual

Sets element at specific position.

Parameters
keyPosition to set element at.
valueValue to set at specific position.

◆ Remove()

template<class TKey , class TValue >
virtual bool System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::Remove ( const TKey &  key)
inlineoverridevirtual

Removes element from container.

Parameters
keyKey to remove element at.
Returns
True if element was found and removed, false otherwise.