CatchLowConfidence()

Format

CatchLowConfidence(Expr ,DefaultValue [,Cutoff])

Returns

Returns the value of Expr, unless it has a low confidence value, in which case the value of Default is returned instead.

Note: From v4.9.6, the confidence of the replaced value uses the confidence of the replacement value (which is likely to be 100 since it's a single value variable). Prior to this, the replaced value kept the confidence of the source value (i.e. the low confidence).

Inputs

Expr: The expression being evaluated. Must evaluate to the same type as Cutoff.
Behaviour: Required
Dimension: Collection, MultiCollection
Valid data types: Null, Boolean, DateTime, Decimal, Integer, String, Duration

Cutoff: Overrides the configured CalculationConfidenceCutoffThreshold. A value is regarded as bad if it is less than this value. Must evaluate to the same type as Expr.
Behaviour: Required 
Dimension: SingleValue
Valid data types: Boolean, DateTime, Decimal, Integer, String, Duration, Error, Null

DefaultValue: The value to be returned if the confidence value is less than the Cutoff value.
Behaviour: Optional
Dimension: SingleValue
Valid data types: Integer

How to format data types

Examples

Expression: CatchLowConfidence({tagname}, 0, 20)
Result: Returns 0 if the confidence of the tag is less than or equal to 20.

Release History

• CatchLowConfidence() 4.9.6
  • The confidence of the replaced value will now use the confidence of the replacement value. Originally, the replaced value kept the confidence of the source value (i.e. the low confidence).
• CatchLowConfidence() 4.6.5
  • Changed Expr parameter to support MultiCollection values.
• CatchLowConfidence() 4.0
  • Initial version