System::Collections::Generic::BaseDictionary class

BaseDictionary class

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<typename Map>class BaseDictionary : public System::Collections::Generic::IDictionary<Map::key_type, Map::mapped_type>

Parameter	Description
Map	Underlying map type.

Methods

Method	Description
_add_range(std::initializer_list<typename Map::value_type>)	C++ specific.
Add(const key_t&, const mapped_t&) override	Adds key-value pair into dictionary.
BaseDictionary()	Creates empty data structure.
BaseDictionary(int, const Args&…)	Forwarding constructor to push arguments into underlying map constructor.
BaseDictionary(BaseType *, const Args&…)	Copying constructor.
BaseDictionary(BaseType *)	Copying constructor.
begin() const	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().
cbegin() const	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().
cend() const	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.
Clear() override	Deletes all elements.
ContainsKey(const key_t&) const override	Checks if key is present in dictionary.
ContainsValue(const mapped_t&)	Checks if value is present in dictionary. Uses operator == to compare values.
data()	Underlying data storage accessor.
data() const	Underlying data storage accessor.
end() const	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.
get_Count() const override	Gets elements count.
virtual GetEnumerator()	Creates enumerator instance, should be implemented by subclass.
GetValueOrDefault(const key_t&) const override	Returns value if found; or Value() otherwise.
GetValueOrDefault(const key_t&, const mapped_t&) const override	Returns value if found; or defaultValue otherwise.
GetValueOrNull(const key_t&) const override	Returns value if found; or null otherwise. Make sense only for reference types.
idx_get(const key_t&) const override	Keyed getter function.
idx_set(const key_t&, mapped_t) override	Keyed setter function. Alters or creates element.
virtual operator[](const key_t&)	Accessor function.
Remove(const key_t&) override	Removes specific key from dictionary.
SetTemplateWeakPtr(unsigned int) override
TryGetValue(const key_t&, mapped_t&) const override	Looks for keyed value and retreives it if found.
virtualizeBeginConstIterator() const override	Gets the implementation of begin const iterator for the current container.
virtualizeBeginIterator() override	Gets the implementation of begin iterator for the current container.
virtualizeEndConstIterator() const override	Gets the implementation of end const iterator for the current container.
virtualizeEndIterator() override	Gets the implementation of end iterator for the current container.

Typedefs

Typedef	Description
BaseType	Implemented interface.
const_iterator	Const iterator type.
iterator	Iterator type.
KeyCollection	Make sure we use correct allocator with underlying storage type.
KVPair	Key-value pair type.
map_t	Internal map type.
ValueCollection	Collection of values.

See Also

• Class IDictionary
• Namespace System::Collections::Generic
• Library Aspose.PDF for C++