Class: TOrderedComparator

Declaration: Comparator.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TComparator

Inherited By:

TKnownCanonicalObjectComparator TMOrderableCollectibleComparator TOrderedOperatorComparator TTextOrderComparator TOrderNewestEntityFirst TOrderOldestEntityFirst

Purpose:

TOrderedComparator is an abstract class that performs comparison and hash operations on comparator objects.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TOrderedComparator.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TOrderedComparator::OrderedCompare

virtual EComparisonResult OrderedCompare (const AType & leftObj, const AType & rightObj) const

Interface Category:

API.

Purpose:

Compares two objects of the same type.

Calling Context:

Call this function directly to compare two objects. Normally called internally. Could be called by anyone to do an ordered compare of two AType objects.

Parameters:

const AType & leftObj -The left-hand object.
const AType & 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: TOrderedComparator::TypeSafeCompare

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

Interface Category:

API.

Purpose:

Compares two objects of different types.

Calling Context:

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

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: TOrderedComparator::TOrderedComparator

TOrderedComparator ()
TOrderedComparator (const TOrderedComparator < AType > &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Call this function directly anywhere the creation of a TOrderedComparator is desired.
Call this function directly to copy an object.

Parameters:

Takes no parameters.
const TOrderedComparator < AType > & -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: TOrderedComparator::operator=

const TOrderedComparator < AType > & operator =(const TOrderedComparator < AType > &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TOrderedComparator < AType > & -The TOrderedComparator to be copied.

Return Value:

A reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TOrderedComparator::Compare

virtual EComparisonResult Compare (const AType & leftObj, const AType & rightObj) const

Interface Category:

API.

Purpose:

Compares two objects of the same type.

Calling Context:

Not called on this object. See OrderedCompare().

Parameters:

const AType & leftObj -The left-hand object.
const AType & 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: TOrderedComparator::GetHash

virtual HashResult GetHash (const AType & obj) const

Interface Category:

API.

Purpose:

Generates a hash value for an object.

Calling Context:

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

Parameters:

const AType & obj -The object for which the hash value is to be generated.

Return Value:

The hash value generated.

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.