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< KeyValuePair< TKey, TValue > >
typedef IEnumerator< KeyValuePair< TKey, TValue > > 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...
 

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)=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...
 
SharedPtr< Objectget_SyncRoot ()
 Gets object to use for collection synchronization. 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...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< KeyValuePair< TKey, TValue > >
virtual SharedPtr< IEnumerator< KeyValuePair< TKey, TValue > > > GetEnumerator ()=0
 Gets enumerator. 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...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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<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.

Member Function Documentation

◆ Add()

template<typename TKey, typename TValue>
virtual void System::Collections::Generic::IDictionary< TKey, TValue >::Add ( const TKey &  key,
const TValue &  value 
)
pure virtual

Adds key-value pair into container.

Parameters
keyKey to add.
valueValue to add.

Implemented in System::Collections::Generic::BaseDictionary< map_t >.

◆ ContainsKey()

template<typename TKey, typename TValue>
virtual bool System::Collections::Generic::IDictionary< TKey, TValue >::ContainsKey ( const TKey &  key) const
pure virtual

Checks if container contains key.

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

Implemented in System::Collections::Generic::BaseDictionary< map_t >.

◆ 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_SyncRoot()

template<typename TKey, typename TValue>
SharedPtr<Object> System::Collections::Generic::IDictionary< TKey, TValue >::get_SyncRoot ( )
inline

Gets object to use for collection synchronization.

Returns
Pointer to object to use for synchronization.

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

◆ GetValueOrDefault() [1/2]

template<typename TKey, typename TValue>
virtual TValue System::Collections::Generic::IDictionary< TKey, TValue >::GetValueOrDefault ( const TKey &  key) const
inlinevirtual

Returns value if found; or Value() otherwise.

Reimplemented in System::Collections::Generic::BaseDictionary< map_t >.

◆ GetValueOrDefault() [2/2]

template<typename TKey, typename TValue>
virtual TValue System::Collections::Generic::IDictionary< TKey, TValue >::GetValueOrDefault ( const TKey &  key,
const TValue &  defaultValue 
) const
inlinevirtual

Returns value if found; or defaultValue otherwise.

Reimplemented in System::Collections::Generic::BaseDictionary< map_t >.

◆ GetValueOrNull()

template<typename TKey, typename TValue>
virtual TValue System::Collections::Generic::IDictionary< TKey, TValue >::GetValueOrNull ( const TKey &  key) const
inlinevirtual

Returns value if found; or null otherwise, make sense only for reference types.

Reimplemented in System::Collections::Generic::BaseDictionary< map_t >.

◆ idx_get()

template<typename TKey, typename TValue>
virtual TValue System::Collections::Generic::IDictionary< TKey, TValue >::idx_get ( const TKey &  key) const
pure virtual

Getter function.

Parameters
keyKey to look for.
Returns
Value at specified key.

Implemented in System::Collections::Generic::BaseDictionary< map_t >.

◆ idx_set()

template<typename TKey, typename TValue>
virtual void System::Collections::Generic::IDictionary< TKey, TValue >::idx_set ( const TKey &  key,
TValue  value 
)
pure virtual

Setter function.

Parameters
keyKey to look for.
valueValue to set to specified key.

Implemented in System::Collections::Generic::BaseDictionary< map_t >.

◆ Remove()

template<typename TKey, typename TValue>
virtual bool System::Collections::Generic::IDictionary< TKey, TValue >::Remove ( const TKey &  key)
pure virtual

Removes key from container.

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

Implemented in System::Collections::Generic::BaseDictionary< map_t >.

◆ TryGetValue()

template<typename TKey, typename TValue>
virtual bool System::Collections::Generic::IDictionary< TKey, TValue >::TryGetValue ( const TKey &  key,
TValue &  value 
)
pure virtual

Looks for value and retreives it if found.

Parameters
keyKey to look for.
valueReference to store retreived value into.
Returns
True if value was found and retreived, false otherwise.

Implemented in System::Collections::Generic::BaseDictionary< map_t >.