com.inductiveautomation.ignition.common.sqltags.history

Enum AggregationMode

java.lang.Object

java.lang.Enum<AggregationMode>

com.inductiveautomation.ignition.common.sqltags.history.AggregationMode

All Implemented Interfaces:

Aggregate, java.io.Serializable, java.lang.Comparable<AggregationMode>

public enum AggregationMode
extends java.lang.Enum<AggregationMode>
implements Aggregate

Dictates how multiple history values are "aggregated" together in order to form a result for a given time slice.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Average Returns the time-weighted average value during the period.
Count Returns the number of "good", non-interpolated values per window.
CountOff Returns the number of times that the value has transitioned to boolean false in the window.
CountOn Returns the number of times that the value has transitioned to boolean true in the window.
DurationOff Returns the time, in seconds, that a value has been boolean false.
DurationOn Returns the time, in seconds, that a value has been boolean true.
LastValue Returns the value closest to the window boundary
Maximum
Minimum
MinMax Returns the min and max values for the period.
PctBad
PctGood
Range Returns the difference between min and max
SimpleAverage Returns the simple numerical average (sum(values)/count)
StdDev Returns the standard deviation for "good", non-interpolated values.
Sum Returns the sum of the values contained in the window.
Variance Returns the variance for "good", non-interpolated values.

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.sqltags.history.Aggregate

AD_HOC_PYTHON_ID, CUSTOM_RESERVED_ID, PYTHON_LIB_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDesc() A possible description for how the aggregate behaves.
int	getId() Returns the identifier for the aggregate.
java.lang.String	getName() A display name for the aggregate.
static AggregationMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AggregationMode	valueOfCaseInsensitive(java.lang.String name)
static AggregationMode[]	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

Average

public static final AggregationMode Average

Returns the time-weighted average value during the period.

MinMax

public static final AggregationMode MinMax

Returns the min and max values for the period.

LastValue

public static final AggregationMode LastValue

Returns the value closest to the window boundary

SimpleAverage

public static final AggregationMode SimpleAverage

Returns the simple numerical average (sum(values)/count)

Sum

public static final AggregationMode Sum

Returns the sum of the values contained in the window.

Minimum

public static final AggregationMode Minimum

Maximum

public static final AggregationMode Maximum

DurationOn

public static final AggregationMode DurationOn

Returns the time, in seconds, that a value has been boolean true.

DurationOff

public static final AggregationMode DurationOff

Returns the time, in seconds, that a value has been boolean false.

CountOn

public static final AggregationMode CountOn

Returns the number of times that the value has transitioned to boolean true in the window.

CountOff

public static final AggregationMode CountOff

Returns the number of times that the value has transitioned to boolean false in the window.

Count

public static final AggregationMode Count

Returns the number of "good", non-interpolated values per window.

Range

public static final AggregationMode Range

Returns the difference between min and max

Variance

public static final AggregationMode Variance

Returns the variance for "good", non-interpolated values. Does not time weight.

StdDev

public static final AggregationMode StdDev

Returns the standard deviation for "good", non-interpolated values. Does not time weight.

PctGood

public static final AggregationMode PctGood

PctBad

public static final AggregationMode PctBad

Method Detail

values

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

Returns:

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

valueOf

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

valueOfCaseInsensitive

public static AggregationMode valueOfCaseInsensitive(java.lang.String name)

getId

public int getId()

Description copied from interface: Aggregate

Returns the identifier for the aggregate. This is the only true identifier for the aggregate, name and description should not be taken into account for equality.

Specified by:

getId in interface Aggregate

getName

public java.lang.String getName()

Description copied from interface: Aggregate

A display name for the aggregate.

Specified by:

getName in interface Aggregate

getDesc

public java.lang.String getDesc()

Description copied from interface: Aggregate

A possible description for how the aggregate behaves.

Specified by:

getDesc in interface Aggregate