System::Collections::Generic::BaseDictionary< map_t > Class Template Referenceabstract

Inherits System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >.

Classes

struct  CheckValue
 Functor for values lookup. More...
 

Public Types

typedef ICollection< key_t > KeyCollection
 Make sure we use correct allocator with underlying storage type. More...
 
typedef ICollection< mapped_t > ValueCollection
 Collection of values. More...
 
typedef IDictionary< typename map_t::key_type, typename map_t::mapped_type > BaseType
 Implemented interface. More...
 
- Public Types inherited from System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >
typedef ICollection< KeyValuePair< map_t::key_type, map_t::mapped_type > > BaseType
 Base interface type. More...
 
typedef KeyValuePair< map_t::key_type, map_t::mapped_type > KeyValuePairType
 Key value pair type. More...
 
- Public Types inherited from System::Collections::Generic::ICollection< KeyValuePair< map_t::key_type, map_t::mapped_type > >
typedef KeyValuePair< map_t::key_type, map_t::mapped_type > ValueType
 Value type name. More...
 
typedef ICollection< KeyValuePair< map_t::key_type, map_t::mapped_type > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< KeyValuePair< map_t::key_type, map_t::mapped_type > >
typedef IEnumerator< KeyValuePair< map_t::key_type, map_t::mapped_type > > 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

 BaseDictionary ()
 Creates empty data structure. More...
 
template<class... Args>
 BaseDictionary (int, const Args &... args)
 
template<class... Args>
 BaseDictionary (BaseType *src, const Args &... args)
 
 BaseDictionary (BaseType *src)
 
SharedPtr< IEnumerator< KeyValuePair< key_t, mapped_t > > > GetEnumerator () override=0
 
int32_t get_Count () const override
 
void Clear () override
 Deletes all elements. More...
 
virtual mapped_t & operator[] (const key_t &key)
 
mapped_t idx_get (const key_t &key) const override
 
void idx_set (const key_t &key, mapped_t value) override
 
void Add (const key_t &key, const mapped_t &value) override
 
bool ContainsKey (const key_t &key) const override
 
bool Remove (const key_t &key) override
 
bool TryGetValue (const key_t &key, mapped_t &value) override
 
bool ContainsValue (const mapped_t &value)
 
map_t & data ()
 
const map_t & data () const
 
void _add_range (std::initializer_list< typename map_t::value_type > list)
 
void SetTemplateWeakPtr (unsigned int argument) override
 
mapped_t GetValueOrDefault (const key_t &key) const override
 Returns value if found; or Value() otherwise. More...
 
mapped_t GetValueOrDefault (const key_t &key, const mapped_t &defaultValue) const override
 Returns value if found; or defaultValue otherwise. More...
 
mapped_t GetValueOrNull (const key_t &key) const override
 Returns value if found; or null otherwise. Make sense only for reference types. More...
 
- Public Member Functions inherited from System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >
virtual SharedPtr< ICollection< map_t::key_type > > get_Keys () const
 
virtual SharedPtr< ICollection< map_t::mapped_type > > get_Values () const
 
bool get_IsFixedSize () const
 
bool get_IsSynchronized () const
 
SharedPtr< Objectget_SyncRoot ()
 
virtual void CopyTo (ArrayPtr< KeyValuePair< map_t::key_type, map_t::mapped_type >> arr, int index) override
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< KeyValuePair< map_t::key_type, map_t::mapped_type > >
virtual bool get_IsReadOnly () const
 
virtual void CopyTo (System::ArrayPtr< KeyValuePair< map_t::key_type, map_t::mapped_type > > array, int arrayIndex)=0
 
- 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)
 
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)
 

Protected Member Functions

bool Contains (const KeyValuePair< key_t, mapped_t > &item) const override
 
bool Remove (const KeyValuePair< key_t, mapped_t > &item) override
 
- Protected Member Functions inherited from System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >
virtual SharedPtr< ICollection< map_t::key_type > > get_KeysInternal () const
 Implementation of get_Keys() method. More...
 
virtual SharedPtr< ICollection< map_t::mapped_type > > get_ValuesInternal () const
 Implementation of get_Values() method. 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 map_t>
class System::Collections::Generic::BaseDictionary< map_t >

Implements common code for various dictionary-alike data structures (e. g. Dictionary, SortedDictionary). Shouldn't be used directly, except for inheritance when defining 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
map_tUnderlying map type.

Member Typedef Documentation

◆ BaseType

template<typename map_t>
typedef IDictionary<typename map_t::key_type, typename map_t::mapped_type> System::Collections::Generic::BaseDictionary< map_t >::BaseType

Implemented interface.

◆ KeyCollection

template<typename map_t>
typedef ICollection<key_t> System::Collections::Generic::BaseDictionary< map_t >::KeyCollection

Make sure we use correct allocator with underlying storage type.

Collection of keys.

◆ ValueCollection

template<typename map_t>
typedef ICollection<mapped_t> System::Collections::Generic::BaseDictionary< map_t >::ValueCollection

Collection of values.

Constructor & Destructor Documentation

◆ BaseDictionary() [1/4]

template<typename map_t>
System::Collections::Generic::BaseDictionary< map_t >::BaseDictionary ( )
inline

Creates empty data structure.

◆ BaseDictionary() [2/4]

template<typename map_t>
template<class... Args>
System::Collections::Generic::BaseDictionary< map_t >::BaseDictionary ( int  ,
const Args &...  args 
)
inline

Forwarding constructor to push arguments into underlying map constructor.

Template Parameters
ArgsTypes of arguments to forward to map.
Parameters
argsArguments to forward to underlying map.

◆ BaseDictionary() [3/4]

template<typename map_t>
template<class... Args>
System::Collections::Generic::BaseDictionary< map_t >::BaseDictionary ( BaseType src,
const Args &...  args 
)
inline

Copying constructor.

Template Parameters
ArgsTypes of map constructor arguments.
Parameters
srcObject to copy data from.
argsArguments to forward to underlying map constructor.

◆ BaseDictionary() [4/4]

template<typename map_t>
System::Collections::Generic::BaseDictionary< map_t >::BaseDictionary ( BaseType src)
inline

Copying constructor.

Parameters
srcObject to copy data from.

Member Function Documentation

◆ _add_range()

template<typename map_t>
void System::Collections::Generic::BaseDictionary< map_t >::_add_range ( std::initializer_list< typename map_t::value_type >  list)
inline

C++ specific

Parameters
listRange to insert into container.

◆ Add()

template<typename map_t>
void System::Collections::Generic::BaseDictionary< map_t >::Add ( const key_t &  key,
const mapped_t &  value 
)
inlineoverridevirtual

Adds key-value pair into dictionary.

Parameters
keyKey to insert value for.
valueValue to insert.
Exceptions
ArgumentExceptionIf key already exists.

Implements System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >.

◆ Clear()

template<typename map_t>
void System::Collections::Generic::BaseDictionary< map_t >::Clear ( )
inlineoverridevirtual

◆ Contains()

template<typename map_t>
bool System::Collections::Generic::BaseDictionary< map_t >::Contains ( const KeyValuePair< key_t, mapped_t > &  item) const
inlineoverrideprotectedvirtual

Checks if key-value pair is present in dictionary, comparing both keys and values.

Parameters
itemItem to look for.
Returns
true if item is found, false otherwise.

Implements System::Collections::Generic::ICollection< KeyValuePair< map_t::key_type, map_t::mapped_type > >.

◆ ContainsKey()

template<typename map_t>
bool System::Collections::Generic::BaseDictionary< map_t >::ContainsKey ( const key_t &  key) const
inlineoverridevirtual

Checks if key is present in dictionary.

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

Implements System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >.

◆ ContainsValue()

template<typename map_t>
bool System::Collections::Generic::BaseDictionary< map_t >::ContainsValue ( const mapped_t &  value)
inline

Checks if value is present in dictionary. Uses operator == to compare values.

Parameters
valueValue to look for.
Returns
true if value is found, false otherwise.

◆ data() [1/2]

template<typename map_t>
map_t& System::Collections::Generic::BaseDictionary< map_t >::data ( )
inline

Underlying data storage accessor.

Returns
Reference to underlying data storage.

◆ data() [2/2]

template<typename map_t>
const map_t& System::Collections::Generic::BaseDictionary< map_t >::data ( ) const
inline

Underlying data storage accessor.

Returns
Const reference to underlying data storage.

◆ get_Count()

template<typename map_t>
int32_t System::Collections::Generic::BaseDictionary< map_t >::get_Count ( ) const
inlineoverridevirtual

Gets elements count.

Returns
Number of elements (key-value pairs) being held currently.

Implements System::Collections::Generic::ICollection< KeyValuePair< map_t::key_type, map_t::mapped_type > >.

◆ GetEnumerator()

◆ GetValueOrDefault() [1/2]

template<typename map_t>
mapped_t System::Collections::Generic::BaseDictionary< map_t >::GetValueOrDefault ( const key_t &  key) const
inlineoverridevirtual

Returns value if found; or Value() otherwise.

Reimplemented from System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >.

◆ GetValueOrDefault() [2/2]

template<typename map_t>
mapped_t System::Collections::Generic::BaseDictionary< map_t >::GetValueOrDefault ( const key_t &  key,
const mapped_t &  defaultValue 
) const
inlineoverridevirtual

Returns value if found; or defaultValue otherwise.

Reimplemented from System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >.

◆ GetValueOrNull()

template<typename map_t>
mapped_t System::Collections::Generic::BaseDictionary< map_t >::GetValueOrNull ( const key_t &  key) const
inlineoverridevirtual

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

Reimplemented from System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >.

◆ idx_get()

template<typename map_t>
mapped_t System::Collections::Generic::BaseDictionary< map_t >::idx_get ( const key_t &  key) const
inlineoverridevirtual

Keyed getter function.

Parameters
keyKey to get value at.
Returns
Copy of element at key position.
Exceptions
KeyNotFoundExceptionif element is not found.

Implements System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >.

◆ idx_set()

template<typename map_t>
void System::Collections::Generic::BaseDictionary< map_t >::idx_set ( const key_t &  key,
mapped_t  value 
)
inlineoverridevirtual

Keyed setter function. Alters or creates element.

Parameters
keyKey to set value at.
valueValue to set.

Implements System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >.

◆ operator[]()

template<typename map_t>
virtual mapped_t& System::Collections::Generic::BaseDictionary< map_t >::operator[] ( const key_t &  key)
inlinevirtual

Accessor function.

Parameters
keyDictionary key to access.
Returns
Reference to existing (or created) value keyed by key.

◆ Remove() [1/2]

template<typename map_t>
bool System::Collections::Generic::BaseDictionary< map_t >::Remove ( const key_t &  key)
inlineoverridevirtual

Removes specific key from dictionary.

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

Implements System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >.

◆ Remove() [2/2]

template<typename map_t>
bool System::Collections::Generic::BaseDictionary< map_t >::Remove ( const KeyValuePair< key_t, mapped_t > &  item)
inlineoverrideprotectedvirtual

Removes specified key-value pair from dictionary, compares both keys and values.

Parameters
itemItem to remove.
Returns
true if pair was found and deleted, false otherwise.

Implements System::Collections::Generic::ICollection< KeyValuePair< map_t::key_type, map_t::mapped_type > >.

◆ SetTemplateWeakPtr()

template<typename map_t>
void System::Collections::Generic::BaseDictionary< map_t >::SetTemplateWeakPtr ( unsigned int  argument)
inlineoverridevirtual

Forces treating specified template class argument as weak pointer instead of shared pointer (if applicable).

Parameters
argument0 to make keys stored by weak pointers; 1 to make values stored by weak pointers.

Reimplemented from System::Object.

◆ TryGetValue()

template<typename map_t>
bool System::Collections::Generic::BaseDictionary< map_t >::TryGetValue ( const key_t &  key,
mapped_t &  value 
)
inlineoverridevirtual

Looks for keyed value and retreives it if found.

Parameters
keyKey to look for.
valueReference to store found value at.
Returns
true if value is found and retreived, false otherwise.

Implements System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >.