Class: TOperatorKeyValuePairComparator

Declaration: KeyValuePairComparator.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

A class that you can use to perform comparison and hash operations on comparator objects. It uses operator== on the object.

Instantiation:

Always allocate on the heap.

Deriving Classes:

Do not derive any classes from TOperatorKeyValuePairComparator.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TOperatorKeyValuePairComparator::TOperatorKeyValuePairComparator

TOperatorKeyValuePairComparator ()

Interface Category:

API.

Purpose:

Default constructor.

Calling Context:

Call this function directly to construct an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TOperatorKeyValuePairComparator::~

TOperatorKeyValuePairComparator ; virtual ~ TOperatorKeyValuePairComparator ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TOperatorKeyValuePairComparator::CompareKey

virtual EComparisonResult CompareKey (const AKey & leftKeyObj, const AKey & rightKeyObj) const

Interface Category:

API.

Purpose:

Compares two objects of the type AKey.

Calling Context:

Call this function directly to compare two objects of the type AKey.

Parameters:

const AKey & leftKeyObj -The left-hand object.
const AKey & rightKeyObj -The right-hand object.

Return Value:

Returns kLessThan, kGreaterThan, kEqual, kNotEqual, or kUndefined.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TOperatorKeyValuePairComparator::CompareValue

virtual EComparisonResult CompareValue (const AValue & leftValObj, const AValue & rightValObj) const

Interface Category:

API.

Purpose:

Compares two objects of the type AKey.

Calling Context:

Call this function directly to compare two objects of the type AKey.

Parameters:

const AValue & leftValObj- The left-hand object.
const AValue & rightValObj- The right-hand object.

Return Value:

Returns kLessThan, kGreaterThan, kEqual, kNotEqual, or kUndefined.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TOperatorKeyValuePairComparator::GetKeyHash

virtual HashResult GetKeyHash (const AKey & keyObj) const

Interface Category:

API.

Purpose:

Computes the hash value of the object of type AKey.

Calling Context:

Call this function directly to computes the hash value of the object of type AKey.

Parameters:

const AKey & keyObj -The object for which a hash value in to be computed.

Return Value:

The hash value computed.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.