ICollator Class Reference

Defines an interface that does collation-aware string comparison. More...

Inherited by DSIBinaryCollator, and DSIUnicodeCollator.

List of all members.

Public Member Functions

virtual simba_int32 Compare (const simba_byte *in_string1, simba_uint32 in_length1, const simba_byte *in_string2, simba_uint32 in_length2) const =0
 Compare two strings.
virtual ~ICollator ()
 Destructor.

Detailed Description

Defines an interface that does collation-aware string comparison.


Constructor & Destructor Documentation

virtual ~ICollator (  )  [inline, virtual]

Destructor.


Member Function Documentation

virtual simba_int32 Compare ( const simba_byte *  in_string1,
simba_uint32  in_length1,
const simba_byte *  in_string2,
simba_uint32  in_length2 
) const [pure virtual]

Compare two strings.

The collations of the two given strings are already known at the creation time of the Collator.

Parameters:
in_string1 Pointer to the first string.
in_length1 The length of the first string in bytes.
in_string2 Pointer to the second string.
in_length2 The length of the second string in bytes.
Returns:
0 if the two strings are equal, negative if the first string is less than the second, positive if the first string is greater than the second.

Implemented in DSIBinaryCollator, and DSIUnicodeCollator.


The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:15 2017 for SimbaEngine 10.1.3.1011 by simba