Share

AcRxObject::comparedTo

C++

virtual ACBASE_PORT AcRx::Ordering comparedTo(
    const AcRxObject * other
) const;

Description

Function usage:

This function is intended to allow classes to provide a means to compare class objects much the way strcmp() compares character strings.

The object pointed to by other is compared with this object. The result of the comparison is returned.

The possible AcRx::Ordering types are:

AcRx::kLessThan

AcRx::kEqual

AcRx::kGreaterThan

AcRx::kNotOrderable

The AcRx::kNotOrderable type is there because C++ classes often cannot support object value comparison.

Function implementation in derived classes:

There are no restrictions or expectations on how this function is implemented. Each class will have its own requirements for comparison.

Default implementation:

Simply returns AcRx::kNotOrderable since many C++ classes cannot support object value comparison.

Parameters

Parameters Description
other Input pointer to object to compare with

Links

AcRxObject

Was this information helpful?