Back to Aurora Vision Library website

You are here: Start » Function Reference » All Functions » Common » TestObjectEqualTo

TestObjectEqualTo


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: STD.h
Namespace: avl
Module: FoundationLite

Checks whether the input object is equal to another object.

Syntax

void avl::TestObjectEqualTo
(
	const Type& inObject,
	const Type& inReferenceObject,
	bool& outIsEqual
)

Parameters

Name Type Default Description
Input value inObject const Type& First of the objects being compared
Input value inReferenceObject const Type& Second of the objects being compared
Output value outIsEqual bool& 'True' if the objects are equal, 'False' otherwise

Remarks

Please note, that this filter can be concretized only with basic data types and structures of such types. Concretizing the filter with a non-comparable complex data type, such as Image or Region, will raise a Domain Error. For complex types you can use appropriate non-generic filters that work with such types.

Using this filter to compare data of type Real (or structures with this type) may be tricky. It is caused by the fact that very small (unnoticeable) differences in values of such types may lead to unpredictable negative results in comparison of these values.

Errors

Non-comparable complex data type "TypeName" used in TestObjectEqualTo.

See Also