forceQuality

This function is used by Ignition's Expression language.

Description

Returns the given value, but overwrites the quality of that value. See the quality codes for a list of potential quality codes. If the quality argument is omitted, the quality will be GOOD (192). This is a way to have expressions opt-out of the quality overlay system. You can also force a specific quality code here by including the quality argument.

caution

Be aware the quality codes linked in the description above access the 7.9 quality codes, which are the codes the forceQuality function uses. For an option using the 8.1 quality codes, see the qualifiedValue function page.

Syntax

forceQuality(value[, qualityCode])

• Parameters

  • object value - The value to force a quality on.

  • int qualityCode - Optional. The qualityCode to force on the value.

• Results

  • object - The value with a forced quality.

Examples

Code Snippet

forceQuality({Tanks/Tank15})   //returns the value of the Tank15 tag, but always with a good quality code.

Code Snippet

forceQuality({Tanks/Tank15}, 410) //returns the value of the Tank15 tag, but always with a TAG_DISABLED quality.