Syntax

String CheckLimits(Number value, Number high, Number low, String comparisonType, Boolean doNotCopyToResults = True, Number nominal = 0, String thresholdType = "")

Return Value

String

"Passed" if the value is within the limits or if the comparison type is LOG. Returns "Failed" otherwise.

Purpose

This function evaluates whether a value is within the specified limits

Parameters

value as Number

A number to compare against limits.

high as Number

A number that specifies the upper limit.

low as Number

A number that specifies the lower limit.

comparisonType as String

Specifies how to compare the value against the limits. The valid values are EQ, NE, GT, LT, GE, LE, GTLT, GELE, GELT, GTLE, LTGT, LEGE, LTGE, LEGT and LOG. The comparisons are identical to the corresponding comparisons of the Numeric Limit Test step.

doNotCopyToResults as Boolean

(Optional) Pass True to set the DontCopyToResults property flag on the properties you pass to the high and low arguments that are not used in the comparison. This default is True.

nominal as Number

(Optional) A number that specifies the nominal value. This parameter is used only with the EQT (==+/-) comparison type.

thresholdType as String

(Optional) Specifies how to compute the upper and lower limits for the EQT (==+/-) comparison type. The valid values are PERCENTAGE, PPM, and DELTA. The threshold types are identical to the corresponding threshold types of the Numeric Limit Test step.