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

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

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

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 KeyValuePair< key_t, mapped_t > KVPair
 Key-value pair type. More...
 
typedef IDictionary< typename map_t::key_type, typename map_t::mapped_type > BaseType
 Implemented interface. More...
 
typedef KVPairIterator< KVPair, map_t > iterator
 Iterator type. More...
 
typedef KVPairIterator< KVPair, map_t > const_iterator
 Const iterator type. 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< 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...
 

Public Member Functions

 BaseDictionary ()
 Creates empty data structure. More...
 
template<class... Args>
 BaseDictionary (int, const Args &... args)
 Forwarding constructor to push arguments into underlying map constructor. More...
 
template<class... Args>
 BaseDictionary (BaseType *src, const Args &... args)
 Copying constructor. More...
 
 BaseDictionary (BaseType *src)
 Copying constructor. More...
 
SharedPtr< IEnumerator< KeyValuePair< key_t, mapped_t > > > GetEnumerator () override=0
 Creates enumerator instance, should be implemented by subclass. More...
 
int32_t get_Count () const override
 Gets elements count. More...
 
void Clear () override
 Deletes all elements. More...
 
virtual mapped_t & operator[] (const key_t &key)
 Accessor function. More...
 
mapped_t idx_get (const key_t &key) const override
 Keyed getter function. More...
 
void idx_set (const key_t &key, mapped_t value) override
 Keyed setter function. Alters or creates element. More...
 
void Add (const key_t &key, const mapped_t &value) override
 Adds key-value pair into dictionary. More...
 
bool ContainsKey (const key_t &key) const override
 Checks if key is present in dictionary. More...
 
bool Remove (const key_t &key) override
 Removes specific key from dictionary. More...
 
bool TryGetValue (const key_t &key, mapped_t &value) const override
 Looks for keyed value and retreives it if found. More...
 
bool ContainsValue (const mapped_t &value)
 Checks if value is present in dictionary. Uses operator == to compare values. More...
 
map_t & data ()
 Underlying data storage accessor. More...
 
const map_t & data () const
 Underlying data storage accessor. More...
 
void _add_range (std::initializer_list< typename map_t::value_type > list)
 C++ specific. More...
 
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...
 
const_iterator begin () const noexcept
 Returns an iterator to the KVPair-wrapper for key-value-element of the container. Implemented in C# style - iterator should be return the KVPair-object with get_Key() and get_Value() interface. If the container is empty, the returned iterator will be equal to end(). More...
 
const_iterator end () const noexcept
 Returns an iterator to the KVPair-wrapper for key-value-element following the last element of the container. Implemented in C# style - iterator should be return the KVPair-object with get_Key() and get_Value() interface. This element acts as a placeholder; attempting to access it results in undefined behavior. More...
 
stl_const_iterator cbegin () const noexcept
 Returns an iterator to the first element of the container. Implemented in STL-style. If the container is empty, the returned iterator will be equal to end(). More...
 
stl_const_iterator cend () const noexcept
 Returns an iterator to the element following the last element of the container. Implemented in STL-style. This element acts as a placeholder; attempting to access it results in undefined behavior. 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
 Accesses key collection. More...
 
virtual SharedPtr< ICollection< map_t::mapped_type > > 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< map_t::key_type, map_t::mapped_type >> arr, int index) override
 Copies dictionary contents into existing array elements. 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 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

bool Contains (const KeyValuePair< key_t, mapped_t > &item) const override
 Checks if key-value pair is present in dictionary, comparing both keys and values. More...
 
bool Remove (const KeyValuePair< key_t, mapped_t > &item) override
 Removes specified key-value pair from dictionary, compares both keys and values. More...
 
 ~BaseDictionary () override
 Destructor. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >
 ~IDictionary () override
 Destructor. More...
 
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...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. More...
 

Protected Attributes

map_t m_map
 Underlying C++ data structure. 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 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.

◆ const_iterator

template<typename map_t >
typedef KVPairIterator<KVPair, map_t> System::Collections::Generic::BaseDictionary< map_t >::const_iterator

Const iterator type.

◆ iterator

template<typename map_t >
typedef KVPairIterator<KVPair, map_t> System::Collections::Generic::BaseDictionary< map_t >::iterator

Iterator type.

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

◆ KVPair

template<typename map_t >
typedef KeyValuePair<key_t, mapped_t> System::Collections::Generic::BaseDictionary< map_t >::KVPair

Key-value pair type.

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

◆ ~BaseDictionary()

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

Destructor.

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

◆ begin()

template<typename map_t >
const_iterator System::Collections::Generic::BaseDictionary< map_t >::begin ( ) const
inlinenoexcept

Returns an iterator to the KVPair-wrapper for key-value-element of the container. Implemented in C# style - iterator should be return the KVPair-object with get_Key() and get_Value() interface. If the container is empty, the returned iterator will be equal to end().

Returns
An iterator pointing to the first element of collection.

◆ cbegin()

template<typename map_t >
stl_const_iterator System::Collections::Generic::BaseDictionary< map_t >::cbegin ( ) const
inlinenoexcept

Returns an iterator to the first element of the container. Implemented in STL-style. If the container is empty, the returned iterator will be equal to end().

Returns
An iterator pointing to the first const-qualified element of collection.

◆ cend()

template<typename map_t >
stl_const_iterator System::Collections::Generic::BaseDictionary< map_t >::cend ( ) const
inlinenoexcept

Returns an iterator to the element following the last element of the container. Implemented in STL-style. This element acts as a placeholder; attempting to access it results in undefined behavior.

Returns
An iterator pointing to the theoretical const-qualified element placed after the end element of collection.

◆ Clear()

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

Deletes all elements.

Implements System::Collections::Generic::ICollection< T >.

◆ Contains()

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

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.

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

◆ end()

template<typename map_t >
const_iterator System::Collections::Generic::BaseDictionary< map_t >::end ( ) const
inlinenoexcept

Returns an iterator to the KVPair-wrapper for key-value-element following the last element of the container. Implemented in C# style - iterator should be return the KVPair-object with get_Key() and get_Value() interface. This element acts as a placeholder; attempting to access it results in undefined behavior.

Returns
An iterator pointing to the theoretical element placed after the end element of collection.

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

◆ GetEnumerator()

template<typename map_t >
SharedPtr< IEnumerator<KeyValuePair<key_t, mapped_t> > > System::Collections::Generic::BaseDictionary< map_t >::GetEnumerator ( )
overridepure virtual

◆ 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)
inlineoverrideprotected

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.

◆ TryGetValue()

template<typename map_t >
bool System::Collections::Generic::BaseDictionary< map_t >::TryGetValue ( const key_t &  key,
mapped_t &  value 
) const
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 >.

Member Data Documentation

◆ m_map

template<typename map_t >
map_t System::Collections::Generic::BaseDictionary< map_t >::m_map
protected

Underlying C++ data structure.