com.inductiveautomation.ignition.common.sqltags.history

Enum InterpolationMode

java.lang.Object

java.lang.Enum<InterpolationMode>

com.inductiveautomation.ignition.common.sqltags.history.InterpolationMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<InterpolationMode>

public enum InterpolationMode
extends java.lang.Enum<InterpolationMode>

Describes how values are interpolated/extrapolated in the history system.
Set on the tag level, it handles the situation when data is more sparse than the time frame requested.
The opposite is AggregationMode, which handles the situation where data is too dense.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Analog Same as Analog_Deadband, but the legacy value.
Analog_Compressed Compressed with the SLIM algorithm.
Analog_Deadband The last known value, interpolated between values during the transition period (1 scan class rate before new value).
Discrete The last known value, no interpolation between value changes.

Method Summary

Modifier and Type	Method and Description
int	getIntValue()
static InterpolationMode	getTypeForValue(int value)
static InterpolationMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static InterpolationMode[]	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

Discrete

public static final InterpolationMode Discrete

The last known value, no interpolation between value changes.

Analog

public static final InterpolationMode Analog

Same as Analog_Deadband, but the legacy value. For 7.3, we had to be able to distinguish between the old analog and the new version. Everything that was previously using this will now used the Compressed analog.

Analog_Deadband

public static final InterpolationMode Analog_Deadband

The last known value, interpolated between values during the transition period (1 scan class rate before new value).

Analog_Compressed

public static final InterpolationMode Analog_Compressed

Compressed with the SLIM algorithm. The trajectory of the value is tracked, and the deadband is used to form a corridor. A value is only logged when it goes outside the current corridor.

Method Detail

values

public static InterpolationMode[] 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 (InterpolationMode c : InterpolationMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static InterpolationMode 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

getIntValue

public int getIntValue()

getTypeForValue

public static InterpolationMode getTypeForValue(int value)