CodePorting.Translator.Cs2Cpp.Framework
System::Collections::Generic::BaseDictionary< Map > 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...

#include <base_dictionary.h>

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

Public Types

typedef Map map_t
 Internal map type. More...
 
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::key_type, typename Map::mapped_type > BaseType
 Implemented interface. More...
 
typedef KVPairIterator< KVPair, Map > iterator
 Iterator type. More...
 
typedef KVPairIterator< KVPair, Map > const_iterator
 Const iterator type. More...
 
- Public Types inherited from System::Collections::Generic::IDictionary< Map::key_type, Map::mapped_type >
typedef ICollection< KeyValuePair< Map::key_type, Map::mapped_type > > BaseType
 Base interface type. More...
 
typedef KeyValuePair< Map::key_type, Map::mapped_type > KeyValuePairType
 Key value pair type. More...
 
- Public Types inherited from System::Collections::Generic::ICollection< KeyValuePair< Map::key_type, Map::mapped_type > >
typedef KeyValuePair< Map::key_type, Map::mapped_type > ValueType
 Value type name. More...
 
typedef ICollection< KeyValuePair< Map::key_type, Map::mapped_type > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< KeyValuePair< Map::key_type, Map::mapped_type > >
typedef IEnumerator< KeyValuePair< Map::key_type, Map::mapped_type > > IEnumeratorType
 Enumerator type. More...
 
using ValueType = KeyValuePair< Map::key_type, Map::mapped_type >
 
using iterator = System::Details::VirtualizedIterator< KeyValuePair< Map::key_type, Map::mapped_type > >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< KeyValuePair< Map::key_type, Map::mapped_type > >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< KeyValuePair< Map::key_type, Map::mapped_type > >
 Inner iterator base type. More...
 
using virtualized_iterator_element = KeyValuePair< Map::key_type, Map::mapped_type >
 Inner iterator element type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

void SetTemplateWeakPtr (unsigned int argument) override
 
 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 & data ()
 Underlying data storage accessor. More...
 
const Map & data () const
 Underlying data storage accessor. More...
 
void _add_range (std::initializer_list< typename Map::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...
 
System::Details::VirtualizedIteratorBase< KVPair > * virtualizeBeginIterator () override
 Gets the implementation of begin iterator for the current container. More...
 
System::Details::VirtualizedIteratorBase< KVPair > * virtualizeEndIterator () override
 Gets the implementation of end iterator for the current container. More...
 
System::Details::VirtualizedIteratorBase< KVPair > * virtualizeBeginConstIterator () const override
 Gets the implementation of begin const iterator for the current container. More...
 
System::Details::VirtualizedIteratorBase< KVPair > * virtualizeEndConstIterator () const override
 Gets the implementation of end const iterator for the current container. More...
 
- Public Member Functions inherited from System::Collections::Generic::IDictionary< Map::key_type, Map::mapped_type >
virtual void Add (const Map::key_type &key, const Map::mapped_type &value)=0
 Adds key-value pair into container. More...
 
virtual bool ContainsKey (const Map::key_type &key) const=0
 Checks if container contains key. More...
 
virtual bool Remove (const Map::key_type &key)=0
 Removes key from container. More...
 
virtual bool TryGetValue (const Map::key_type &key, Map::mapped_type &value) const=0
 Looks for value and retreives it if found. More...
 
virtual Map::mapped_type idx_get (const Map::key_type &key) const=0
 Getter function. More...
 
virtual void idx_set (const Map::key_type &key, Map::mapped_type value)=0
 Setter function. More...
 
virtual SharedPtr< ICollection< Map::key_type > > get_Keys () const
 Accesses key collection. More...
 
virtual SharedPtr< ICollection< Map::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::key_type, Map::mapped_type > > arr, int index) override
 Copies dictionary contents into existing array elements. More...
 
virtual Map::mapped_type GetValueOrDefault (const Map::key_type &key) const
 Returns value if found; or Value() otherwise. More...
 
virtual Map::mapped_type GetValueOrDefault (const Map::key_type &key, const Map::mapped_type &defaultValue) const
 Returns value if found; or defaultValue otherwise. More...
 
virtual Map::mapped_type GetValueOrNull (const Map::key_type &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< Map::key_type, Map::mapped_type > >
virtual int get_Count () const=0
 Gets number of elements in collection. More...
 
virtual void Add (const KeyValuePair< Map::key_type, Map::mapped_type > &item)=0
 Adds element into collection. More...
 
virtual void Clear ()=0
 Deletes all elements from collection. More...
 
virtual bool Contains (const KeyValuePair< Map::key_type, Map::mapped_type > &item) const=0
 Checks if element is present in collection. More...
 
virtual bool Remove (const KeyValuePair< Map::key_type, Map::mapped_type > &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< Map::key_type, Map::mapped_type > > array, int arrayIndex)=0
 Copies all collection elements to existing array elements. More...
 
ICollectionoperator= (ICollection &&) noexcept
 Move assignment operator. More...
 
ICollectionoperator= (const ICollection &)
 Move assignment operator. More...
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&) noexcept
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 
SharedPtr< Objectget_SyncRoot () const
 Gets the object the collection is being synchronized through. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< KeyValuePair< Map::key_type, Map::mapped_type > >
virtual SharedPtr< IEnumerator< KeyValuePair< Map::key_type, Map::mapped_type > > > GetEnumerator ()=0
 Gets enumerator. More...
 
KeyValuePair< Map::key_type, Map::mapped_type > LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
KeyValuePair< Map::key_type, Map::mapped_type > LINQ_First ()
 Returns the first element of a sequence. More...
 
KeyValuePair< Map::key_type, Map::mapped_type > LINQ_First (const Func< KeyValuePair< Map::key_type, Map::mapped_type >, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
KeyValuePair< Map::key_type, Map::mapped_type > LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
KeyValuePair< Map::key_type, Map::mapped_type > LINQ_FirstOrDefault (std::function< bool(KeyValuePair< Map::key_type, Map::mapped_type >)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
KeyValuePair< Map::key_type, Map::mapped_type > LINQ_Last ()
 Returns the last element of a sequence. More...
 
KeyValuePair< Map::key_type, Map::mapped_type > LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< KeyValuePair< Map::key_type, Map::mapped_type > > > 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< KeyValuePair< Map::key_type, Map::mapped_type >, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< KeyValuePair< Map::key_type, Map::mapped_type > > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(KeyValuePair< Map::key_type, Map::mapped_type >)> 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(KeyValuePair< Map::key_type, Map::mapped_type >)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< KeyValuePair< Map::key_type, Map::mapped_type > > > LINQ_Where (std::function< bool(KeyValuePair< Map::key_type, Map::mapped_type >)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (KeyValuePair< Map::key_type, Map::mapped_type > value)
 Determines if a sequence contains a specified value. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
SharedPtr< IEnumerable< KeyValuePair< Map::key_type, Map::mapped_type > > > LINQ_OrderBy (const Func< KeyValuePair< Map::key_type, Map::mapped_type >, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< KeyValuePair< Map::key_type, Map::mapped_type > > > LINQ_OrderByDescending (const Func< KeyValuePair< Map::key_type, Map::mapped_type >, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< KeyValuePair< Map::key_type, Map::mapped_type >, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< KeyValuePair< Map::key_type, Map::mapped_type >, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
SharedPtr< IEnumerable< KeyValuePair< Map::key_type, Map::mapped_type > > > LINQ_Concat (SharedPtr< IEnumerable< KeyValuePair< Map::key_type, Map::mapped_type > > > sequence)
 Concatenates two sequences. More...
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, KeyValuePair< Map::key_type, Map::mapped_type > > > > > LINQ_GroupBy (System::Func< KeyValuePair< Map::key_type, Map::mapped_type >, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< KeyValuePair< Map::key_type, Map::mapped_type >, SharedPtr< IEnumerable< ResultType > > > &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result > > > &selector)
 
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...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. 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 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...
 
virtual virtualized_iteratorvirtualizeBeginIterator ()
 Gets the implementation of begin iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndIterator ()
 Gets the implementation of end iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeBeginConstIterator () const
 Gets the implementation of begin const iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndConstIterator () const
 Gets the implementation of end const iterator for the current container. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual 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 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::key_type, Map::mapped_type >
 ~IDictionary () override
 Destructor. More...
 
virtual SharedPtr< ICollection< Map::key_type > > get_KeysInternal () const
 Implementation of get_Keys() method. More...
 
virtual SharedPtr< ICollection< Map::mapped_type > > get_ValuesInternal () const
 Implementation of get_Values() method. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< KeyValuePair< Map::key_type, Map::mapped_type > >
 ~IEnumerable () override
 Destructor. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator ()
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator () const
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 

Protected Attributes

pointer_mode_t m_pointer_mode
 
Map 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>
class System::Collections::Generic::BaseDictionary< Map >

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
MapUnderlying map type.

Member Typedef Documentation

◆ BaseType

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

Implemented interface.

◆ const_iterator

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

Const iterator type.

◆ iterator

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

Iterator type.

◆ KeyCollection

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

Make sure we use correct allocator with underlying storage type.

Collection of keys.

◆ KVPair

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

Key-value pair type.

◆ map_t

template<typename Map >
typedef Map System::Collections::Generic::BaseDictionary< Map >::map_t

Internal map type.

◆ ValueCollection

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

Collection of values.

Constructor & Destructor Documentation

◆ BaseDictionary() [1/4]

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

Creates empty data structure.

◆ BaseDictionary() [2/4]

template<typename Map >
template<class... Args>
System::Collections::Generic::BaseDictionary< Map >::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 >
template<class... Args>
System::Collections::Generic::BaseDictionary< Map >::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 >
System::Collections::Generic::BaseDictionary< Map >::BaseDictionary ( BaseType src)
inline

Copying constructor.

Parameters
srcObject to copy data from.

◆ ~BaseDictionary()

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

Destructor.

Member Function Documentation

◆ _add_range()

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

C++ specific.

Parameters
listRange to insert into container.

◆ Add()

template<typename Map >
void System::Collections::Generic::BaseDictionary< Map >::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::key_type, Map::mapped_type >.

◆ begin()

template<typename Map >
const_iterator System::Collections::Generic::BaseDictionary< Map >::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 >
stl_const_iterator System::Collections::Generic::BaseDictionary< Map >::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 >
stl_const_iterator System::Collections::Generic::BaseDictionary< Map >::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 >
void System::Collections::Generic::BaseDictionary< Map >::Clear ( )
inlineoverridevirtual

◆ Contains()

template<typename Map >
bool System::Collections::Generic::BaseDictionary< Map >::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::key_type, Map::mapped_type > >.

◆ ContainsKey()

template<typename Map >
bool System::Collections::Generic::BaseDictionary< Map >::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::key_type, Map::mapped_type >.

◆ ContainsValue()

template<typename Map >
bool System::Collections::Generic::BaseDictionary< Map >::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 >
Map & System::Collections::Generic::BaseDictionary< Map >::data ( )
inline

Underlying data storage accessor.

Returns
Reference to underlying data storage.

◆ data() [2/2]

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

Underlying data storage accessor.

Returns
Const reference to underlying data storage.

◆ end()

template<typename Map >
const_iterator System::Collections::Generic::BaseDictionary< Map >::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 >
int32_t System::Collections::Generic::BaseDictionary< Map >::get_Count ( ) const
inlineoverridevirtual

Gets elements count.

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

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

◆ GetEnumerator()

◆ GetValueOrDefault() [1/2]

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

Returns value if found; or Value() otherwise.

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

◆ GetValueOrDefault() [2/2]

template<typename Map >
mapped_t System::Collections::Generic::BaseDictionary< Map >::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::key_type, Map::mapped_type >.

◆ GetValueOrNull()

template<typename Map >
mapped_t System::Collections::Generic::BaseDictionary< Map >::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::key_type, Map::mapped_type >.

◆ idx_get()

template<typename Map >
mapped_t System::Collections::Generic::BaseDictionary< Map >::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::key_type, Map::mapped_type >.

◆ idx_set()

template<typename Map >
void System::Collections::Generic::BaseDictionary< Map >::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::key_type, Map::mapped_type >.

◆ operator[]()

template<typename Map >
virtual mapped_t & System::Collections::Generic::BaseDictionary< Map >::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 >
bool System::Collections::Generic::BaseDictionary< Map >::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::key_type, Map::mapped_type >.

◆ Remove() [2/2]

template<typename Map >
bool System::Collections::Generic::BaseDictionary< Map >::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::key_type, Map::mapped_type > >.

◆ SetTemplateWeakPtr()

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

◆ TryGetValue()

template<typename Map >
bool System::Collections::Generic::BaseDictionary< Map >::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::key_type, Map::mapped_type >.

◆ virtualizeBeginConstIterator()

template<typename Map >
System::Details::VirtualizedIteratorBase< KVPair > * System::Collections::Generic::BaseDictionary< Map >::virtualizeBeginConstIterator ( ) const
inlineoverridevirtual

Gets the implementation of begin const iterator for the current container.

Returns
Pointer to the newly created iterator kernel object.

Reimplemented from System::Collections::Generic::IEnumerable< KeyValuePair< Map::key_type, Map::mapped_type > >.

◆ virtualizeBeginIterator()

template<typename Map >
System::Details::VirtualizedIteratorBase< KVPair > * System::Collections::Generic::BaseDictionary< Map >::virtualizeBeginIterator ( )
inlineoverridevirtual

Gets the implementation of begin iterator for the current container.

Returns
Pointer to the newly created iterator kernel object.

Reimplemented from System::Collections::Generic::IEnumerable< KeyValuePair< Map::key_type, Map::mapped_type > >.

◆ virtualizeEndConstIterator()

template<typename Map >
System::Details::VirtualizedIteratorBase< KVPair > * System::Collections::Generic::BaseDictionary< Map >::virtualizeEndConstIterator ( ) const
inlineoverridevirtual

Gets the implementation of end const iterator for the current container.

Returns
Pointer to the newly created iterator kernel object.

Reimplemented from System::Collections::Generic::IEnumerable< KeyValuePair< Map::key_type, Map::mapped_type > >.

◆ virtualizeEndIterator()

template<typename Map >
System::Details::VirtualizedIteratorBase< KVPair > * System::Collections::Generic::BaseDictionary< Map >::virtualizeEndIterator ( )
inlineoverridevirtual

Gets the implementation of end iterator for the current container.

Returns
Pointer to the newly created iterator kernel object.

Reimplemented from System::Collections::Generic::IEnumerable< KeyValuePair< Map::key_type, Map::mapped_type > >.

Member Data Documentation

◆ m_map

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

Underlying C++ data structure.

◆ m_pointer_mode

template<typename Map >
pointer_mode_t System::Collections::Generic::BaseDictionary< Map >::m_pointer_mode
protected