System::Collections::Generic::SortedDictionary< TKey, TValue > Class Template Reference

Sorted dictionary type forward declaration. More...

Inherits System::Object, and System::Collections::Generic::BaseDictionary< std::map< TKey, TValue, ComparerAdapter< TKey >, System::Details::CollectionHelpers::MapPointerMode< TKey, TValue >::allocator_type > >.

Classes

class  Enumerator
 

Public Types

typedef ICollection< TKey > KeyCollection
 Key collection type. More...
 
typedef ICollection< TValue > ValueCollection
 Value collection type. More...
 
typedef std::map< TKey, TValue, ComparerAdapter< TKey >, typename System::Details::CollectionHelpers::MapPointerMode< TKey, TValue >::allocator_type > map_t
 Underlying data type. More...
 
typedef SortedDictionary< TKey, TValue > this_t
 Self type. More...
 
typedef SharedPtr< this_tPtr
 Pointer type. More...
 
typedef KeyValuePair< TKey, TValue > KVPair
 Key-value pair type. More...
 
typedef SharedPtr< IEnumerable< KVPair > > IEnumerablePtr
 Collection of same elements. More...
 
typedef SharedPtr< IEnumerator< KVPair > > IEnumeratorPtr
 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

 SortedDictionary ()
 Constructs empty dictionary. More...
 
 SortedDictionary (const SharedPtr< IComparer< TKey > > &comparer)
 
 SortedDictionary (const SharedPtr< IDictionary< TKey, TValue > > &src)
 
IEnumeratorPtr GetEnumerator () override
 
KVPairIterator< KVPair, map_tbegin () noexcept
 
KVPairIterator< KVPair, map_tend () noexcept
 
- 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

SharedPtr< KeyCollectionget_KeysInternal () const override
 
SharedPtr< ValueCollectionget_ValuesInternal () const override
 

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::SortedDictionary< TKey, TValue >

Sorted dictionary type forward declaration.

Sorted dictionary class wrapping STL map. 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

◆ IEnumerablePtr

template<typename TKey , typename TValue >
typedef SharedPtr< IEnumerable<KVPair> > System::Collections::Generic::SortedDictionary< TKey, TValue >::IEnumerablePtr

Collection of same elements.

◆ IEnumeratorPtr

template<typename TKey , typename TValue >
typedef SharedPtr< IEnumerator<KVPair> > System::Collections::Generic::SortedDictionary< TKey, TValue >::IEnumeratorPtr

Enumerator type.

◆ KeyCollection

template<typename TKey , typename TValue >
typedef ICollection<TKey> System::Collections::Generic::SortedDictionary< TKey, TValue >::KeyCollection

Key collection type.

◆ KVPair

template<typename TKey , typename TValue >
typedef KeyValuePair<TKey, TValue> System::Collections::Generic::SortedDictionary< TKey, TValue >::KVPair

Key-value pair type.

◆ map_t

template<typename TKey , typename TValue >
typedef std::map<TKey, TValue, ComparerAdapter<TKey>, typename System::Details::CollectionHelpers::MapPointerMode<TKey, TValue>::allocator_type > System::Collections::Generic::SortedDictionary< TKey, TValue >::map_t

Underlying data type.

◆ Ptr

template<typename TKey , typename TValue >
typedef SharedPtr<this_t> System::Collections::Generic::SortedDictionary< TKey, TValue >::Ptr

Pointer type.

◆ this_t

template<typename TKey , typename TValue >
typedef SortedDictionary<TKey, TValue> System::Collections::Generic::SortedDictionary< TKey, TValue >::this_t

Self type.

◆ ValueCollection

template<typename TKey , typename TValue >
typedef ICollection<TValue> System::Collections::Generic::SortedDictionary< TKey, TValue >::ValueCollection

Value collection type.

Constructor & Destructor Documentation

◆ SortedDictionary() [1/3]

template<typename TKey , typename TValue >
System::Collections::Generic::SortedDictionary< TKey, TValue >::SortedDictionary ( )
inline

Constructs empty dictionary.

◆ SortedDictionary() [2/3]

template<typename TKey , typename TValue >
System::Collections::Generic::SortedDictionary< TKey, TValue >::SortedDictionary ( const SharedPtr< IComparer< TKey > > &  comparer)
inline

Constructs empty dictionary.

Parameters
comparerComparer to use.

◆ SortedDictionary() [3/3]

template<typename TKey , typename TValue >
System::Collections::Generic::SortedDictionary< TKey, TValue >::SortedDictionary ( const SharedPtr< IDictionary< TKey, TValue > > &  src)
inline

Copy constructor.

Parameters
srcSource dictionary to copy data from.

Member Function Documentation

◆ begin()

template<typename TKey , typename TValue >
KVPairIterator<KVPair, map_t> System::Collections::Generic::SortedDictionary< TKey, TValue >::begin ( )
inlinenoexcept

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

◆ end()

template<typename TKey , typename TValue >
KVPairIterator<KVPair, map_t> System::Collections::Generic::SortedDictionary< TKey, TValue >::end ( )
inlinenoexcept

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

◆ get_KeysInternal()

◆ get_ValuesInternal()

◆ GetEnumerator()

template<typename TKey , typename TValue >
IEnumeratorPtr System::Collections::Generic::SortedDictionary< TKey, TValue >::GetEnumerator ( )
inlineoverridevirtual