IPM
ComparisonAdaptor Class Reference

Handles code generation of a grab bag of useful functions to be code generated, such as the following: More...

Inheritance diagram for ComparisonAdaptor:
Inheritance graph

Static Public Member Functions

_.Library.Boolean CompareToSkipCondition (_.Dictionary.CompiledProperty pCompiledProperty)
 Condition under which a given property is skipped when generating code for the. More...
 
_.Library.List FindAllSuperClasses (_.Dictionary.Classname pClassname)
 Returns a list of all super classes for a given class pClassname
 
_.Library.List IgnoreKeywordList ()
 Returns a list of keywords such that, if a property contains any of these,. More...
 

Static Public Attributes

 SkipCodeGeneration = None
 Handles code generation of a grab bag of useful functions to be code generated, such as the following: More...
 

Private Member Functions

_.Library.Boolean CompareTo (_.IPM.Utils.ComparisonAdaptor pObj, _.Library.List pIgnorePropertyList, _.Library.List pDifferingPropertyArray)
 Compares the properties of the existing object to the provided object of the same type. More...
 

Detailed Description

Handles code generation of a grab bag of useful functions to be code generated, such as the following:

  • Comparison functions that compare instances of a class by comparing their properties.

Member Function Documentation

◆ CompareTo()

_.Library.Boolean CompareTo ( _.IPM.Utils.ComparisonAdaptor  pObj,
_.Library.List  pIgnorePropertyList,
_.Library.List  pDifferingPropertyArray 
)
private

Compares the properties of the existing object to the provided object of the same type.


If comparison of certain properties is to be skipped, the property names can be listed in pIgnorePropertyList.
Returns 1 if all properties match. Else 0. pDifferingPropertyArray returns in an array, the values of the properties that differed in the following format:
pDifferingPropertyArray("property name", "any nested property names or indices/keys for iterable properties") = $ListBuild("value in calling object", "value in pObj").

◆ CompareToSkipCondition()

_.Library.Boolean CompareToSkipCondition ( _.Dictionary.CompiledProperty  pCompiledProperty)
static

Condition under which a given property is skipped when generating code for the.

<method>CompareTo</method>. The instance of the compiled property is provided in pCompiledProperty.
This is intended to be used only if the properties to be skipped match a certain pattern. To hardcode specific properties to be skipped, use the property parameters.
Returns 1 if the property should be skipped. 0 otherwise.

◆ IgnoreKeywordList()

_.Library.List IgnoreKeywordList ( )
static

Returns a list of keywords such that, if a property contains any of these,.

code generation of the property is ignored. @API.Overrideable

Member Data Documentation

◆ SkipCodeGeneration

SkipCodeGeneration = None
static

Handles code generation of a grab bag of useful functions to be code generated, such as the following:

  • Comparison functions that compare instances of a class by comparing their properties.

Set to true to skip code generation in this class