Package com.inductiveautomation.historian.gateway.api.storage.realtime

Enum Class ValueOrigin

java.lang.Object

java.lang.Enum<ValueOrigin>

com.inductiveautomation.historian.gateway.api.storage.realtime.ValueOrigin

All Implemented Interfaces:

Serializable, Comparable<ValueOrigin>, Constable

public enum ValueOrigin
extends Enum<ValueOrigin>

Enum representing the origin of values for the data collection.

See Also:

• CollectionContext

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
OBSERVED_VALUE	Indicates that the collection is presenting values generated by the collector itself.
SOURCE_VALUE	Indicates that the collection is only presenting values that originated at the source.

Method Summary

Modifier and Type	Method	Description
static ValueOrigin	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ValueOrigin[]	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

SOURCE_VALUE

public static final ValueOrigin SOURCE_VALUE

Indicates that the collection is only presenting values that originated at the source.

OBSERVED_VALUE

public static final ValueOrigin OBSERVED_VALUE

Indicates that the collection is presenting values generated by the collector itself. These "observed values" are created by the collector during the collection process, based on its observations, which are typically useful for periodic snapshots.

Method Details

values

public static ValueOrigin[] 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 ValueOrigin 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