ICellComparator Class Reference

A comparator for comparing a custom data type. More...

Inherited by IBookmarkComparator.

List of all members.

Public Member Functions

virtual simba_int32 Compare (const simba_byte *in_left, simba_uint32 in_leftNumBytes, const simba_byte *in_right, simba_uint32 in_rightNumBytes) const =0
 Does comparison for the data type represented by this ICellComparator.
virtual ~ICellComparator ()
 Destructor.

Protected Member Functions

 ICellComparator ()
 Constructor.

Detailed Description

A comparator for comparing a custom data type.

This interface needs to be implemented for all custom data types when a particular operation is to be supported.

For example, if the DSII has a custom data type - say, CustomType1, and the DSII wishes to support the '=' operation on CustomType1, the DSII needs to do the following:

(1) Implement an ICellComparator to support comparisons for CustomType1. (2) Implement CellComparatorFactory such that the ICellComparator from (1) is returned when MakeNewCellComparator() is called with the appropriate parameters from SimbaEngine.


Constructor & Destructor Documentation

virtual ~ICellComparator (  )  [inline, virtual]

Destructor.

ICellComparator (  )  [inline, protected]

Constructor.


Member Function Documentation

virtual simba_int32 Compare ( const simba_byte *  in_left,
simba_uint32  in_leftNumBytes,
const simba_byte *  in_right,
simba_uint32  in_rightNumBytes 
) const [pure virtual]

Does comparison for the data type represented by this ICellComparator.

Parameters:
in_left The first byte buffer to compare. Cannot be NULL. (NOT OWN)
in_leftNumBytes The number of bytes in the left buffer. This length should be ignored if the underlying comparison type is fixed width, as the length should already be known.
in_right The second byte buffer to compare with in_left. Cannot be NULL. (NOT OWN)
in_rightNumBytes The number of bytes in the right buffer. This length should be ignored if the underlying comparison type is fixed width, as the length should already be known.
Returns:
0 if in_left is equal to in_right; negative integer if in_left is less than in_right; positive integer if in_left is greater than in_right.

Implemented in IBookmarkComparator.


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

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