com.inductiveautomation.ignition.common.model.values

Enum QualityCode.Level

java.lang.Object

java.lang.Enum<QualityCode.Level>

com.inductiveautomation.ignition.common.model.values.QualityCode.Level

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<QualityCode.Level>

Enclosing class:

QualityCode

public static enum QualityCode.Level
extends java.lang.Enum<QualityCode.Level>

Enum Constant Summary

Enum Constants

Enum Constant and Description
Bad
Error
Good
Uncertain

Method Summary

Modifier and Type	Method and Description
int	code(int userCode)
static QualityCode.Level	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static QualityCode.Level[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Good

public static final QualityCode.Level Good

Uncertain

public static final QualityCode.Level Uncertain

Bad

public static final QualityCode.Level Bad

Error

public static final QualityCode.Level Error

Method Detail

values

public static QualityCode.Level[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (QualityCode.Level c : QualityCode.Level.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static QualityCode.Level valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

code

public int code(int userCode)

Parameters:

userCode - the user code to turn into a quality code. Only the lover 16 bits will be used

Returns:

an integer code that will be set to this severity level