Package com.inductiveautomation.ignition.gateway.sqltags.history.query

Enum Class BlockMode

java.lang.Object

java.lang.Enum<BlockMode>

com.inductiveautomation.ignition.gateway.sqltags.history.query.BlockMode

All Implemented Interfaces:

Serializable, Comparable<BlockMode>, Constable

public enum BlockMode
extends Enum<BlockMode>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Defined	The specified number of data points will be returned.
Natural	Data will be returned for each scan class execution.
Raw	Data will be returned as it is in the database.

Method Summary

Modifier and Type	Method	Description
static BlockMode	getForReturnSize(int size)	Returns the proper enum value for the given return size (each of the values is currently mapped to a requested size)
static BlockMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BlockMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Raw

public static final BlockMode Raw

Data will be returned as it is in the database.

Natural

public static final BlockMode Natural

Data will be returned for each scan class execution.

Defined

public static final BlockMode Defined

The specified number of data points will be returned.

Method Details

values

public static BlockMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static BlockMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getForReturnSize

public static BlockMode getForReturnSize(int size)

Returns the proper enum value for the given return size (each of the values is currently mapped to a requested size)