System::Globalization::SortKey Class Reference

Inherits System::Object.

Public Member Functions

 SortKey (const SortKey &)=delete
 
SortKeyoperator= (const SortKey &)=delete
 
virtual ASPOSECPP_SHARED_API String get_OriginalString ()
 
virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > get_KeyData ()
 
ASPOSECPP_SHARED_API bool Equals (SharedPtr< Object > value) override
 
ASPOSECPP_SHARED_API int GetHashCode () const override
 
ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST override
 
- 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 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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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)
 

Static Public Member Functions

static ASPOSECPP_SHARED_API int Compare (const SortKeyPtr &sortkey1, const SortKeyPtr &sortkey2)
 
- 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...
 

Additional Inherited Members

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

Detailed Description

Mapping of a string to its sort key. 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.

Constructor & Destructor Documentation

◆ SortKey()

System::Globalization::SortKey::SortKey ( const SortKey )
delete

Member Function Documentation

◆ Compare()

static ASPOSECPP_SHARED_API int System::Globalization::SortKey::Compare ( const SortKeyPtr sortkey1,
const SortKeyPtr sortkey2 
)
static

Compares two sort keys.

Parameters
sortkey1First sort key.
sortkey2Second sort key.
Returns
-1 if sortkey1 is less then sortkey2, 1 - if sortkey1 is greater then sortkey2, 0 - if sortkey1 is equal to sortkey2.

◆ Equals()

ASPOSECPP_SHARED_API bool System::Globalization::SortKey::Equals ( SharedPtr< Object value)
override

Checks if the specified object is equal to the current SortKey object.

Parameters
valueThe object to compare with the current SortKey object.
Returns
true if objects are equals, otherwise - false.

◆ get_KeyData()

virtual ASPOSECPP_SHARED_API ArrayPtr<uint8_t> System::Globalization::SortKey::get_KeyData ( )
virtual

Gets byte array representing current object.

Returns
A byte array representing current object.

◆ get_OriginalString()

virtual ASPOSECPP_SHARED_API String System::Globalization::SortKey::get_OriginalString ( )
virtual

Gets original string used to create this object.

Returns
Original string used to create this object.

◆ GetHashCode()

ASPOSECPP_SHARED_API int System::Globalization::SortKey::GetHashCode ( ) const
overridevirtual

Gets hash code for the current SortKey object.

Returns
A 32-signed integer hash code.

Reimplemented from System::Object.

◆ operator=()

SortKey& System::Globalization::SortKey::operator= ( const SortKey )
delete

◆ ToString()

ASPOSECPP_SHARED_API String System::Globalization::SortKey::ToString ( )
overridevirtual

Converts current object to its string representation.

Returns
A string that represents the current SortKey object.

Reimplemented from System::Object.