Class: TAbstractKeyValuePairComparator

Declaration: KeyValuePairComparator.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

An abstract class that allows you to perform comparison and hash operations on TKeyValuePair objects by comparing their keys.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TAbstractKeyValuePairComparator::~

TAbstractKeyValuePairComparator ; virtual ~ TAbstractKeyValuePairComparator ()

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: TAbstractKeyValuePairComparator::TypeSafeCompare

virtual EComparisonResult TypeSafeCompare (void * leftObj, void * rightObj) const

Interface Category:

API.

Purpose:

Compares two object keys with respect to their types.

Calling Context:

Call this function directly to compare two objects, possibly of different types.

Parameters:

void * leftObj -The left-hand object.
void * rightObj -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: TAbstractKeyValuePairComparator::TypeSafeGetHash

virtual HashResult TypeSafeGetHash (void * obj) const

Interface Category:

API.

Purpose:

Generates a hash value for an object key with respect to its type.

Calling Context:

Call this function directly to generate a hash value for an object.

Parameters:

void * obj -The object for which a hash value is to be generated.

Return Value:

Returns the hash result.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractKeyValuePairComparator::TypeSafeCompareValue

virtual EComparisonResult TypeSafeCompareValue (void * leftObj, void * rightObj) const

Interface Category:

API.

Purpose:

Compares the values of two object keys with respect to their types.

Calling Context:

Call this function directly to compare the values of two objects, possibly of different types.

Parameters:

void * leftObj -The left-hand object.
void * rightObj -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: TAbstractKeyValuePairComparator::operator>>=

virtual TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Call this function directly to stream out data.

Parameters:

TStream & towhere -The stream to which the object streams itself.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractKeyValuePairComparator::operator<<=

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Call this function directly to stream in data.

Parameters:

TStream & fromwhere -The stream from which the object streams itself.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None

Member Function: TAbstractKeyValuePairComparator::TAbstractKeyValuePairComparator

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Call this function directly.
Call this function directly to copy an object.

Parameters:

Takes no parameters.
const TAbstractKeyValuePairComparator & -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractKeyValuePairComparator::operator=

const TAbstractKeyValuePairComparator & operator =(const TAbstractKeyValuePairComparator &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly when an object is assigned to another compatible object.

Parameters:

const TAbstractKeyValuePairComparator & -The object to be copied.

Return Value:

A non-const reference to the left-hand side object.

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.