com.inductiveautomation.ignition.common.model.values

Class QualityUtils

java.lang.Object

com.inductiveautomation.ignition.common.model.values.QualityUtils

public class QualityUtils
extends java.lang.Object

This class provides some basic functions for creating derived QualityCodes and values.

Constructor Summary

Constructors

Constructor and Description
QualityUtils()

Method Summary

Modifier and Type	Method and Description
static QualityCode	derive(QualityCode base, LocalizedString description) Creates a new quality with the same ID and severity as the provided one, but with a new description.
static QualityCode	derive(QualityCode base, java.lang.String descKey, java.lang.Object... descParams)
static QualityCode	makeInternalError(java.lang.Exception e) Returns an error quality based of the "Error_Exception" quality, for the given exception.
static QualifiedValue	valueFrom(QualityCode badQuality)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QualityUtils

public QualityUtils()

Method Detail

derive

public static QualityCode derive(QualityCode base,
                                 LocalizedString description)

Creates a new quality with the same ID and severity as the provided one, but with a new description.

derive

public static QualityCode derive(QualityCode base,
                                 java.lang.String descKey,
                                 java.lang.Object... descParams)

makeInternalError

public static QualityCode makeInternalError(java.lang.Exception e)

Returns an error quality based of the "Error_Exception" quality, for the given exception. Currently uses the exceptions message as the details, in the future we may introduce a special exception quality with more information.

valueFrom

public static QualifiedValue valueFrom(QualityCode badQuality)