Enum Class InstrumentTagRole

java.lang.Object

java.lang.Enum<InstrumentTagRole>

neqsim.process.measurementdevice.InstrumentTagRole

All Implemented Interfaces:

Serializable, Comparable<InstrumentTagRole>, Constable

public enum InstrumentTagRole
extends Enum<InstrumentTagRole>

Defines the role of a measurement device when used in a digital-twin or field-data integration context.

• INPUT — field data drives the model input (boundary condition). The instrument reads a value from the field historian and applies it to its connected stream or equipment.
• BENCHMARK — field data is compared against the model prediction for validation and parameter optimisation. The deviation between model and field is tracked.
• VIRTUAL — the model provides a calculated value as a virtual (soft) sensor. No field data is expected; the model output IS the measurement.

Version:

1.0

Author:

ESOL

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BENCHMARK	Field data is compared against the model value for validation, calibration, and optimisation.
INPUT	Field data sets the model input.
VIRTUAL	Model-calculated value serves as a virtual measurement (soft sensor).

Constructor Summary

Constructors

Modifier	Constructor	Description
private	InstrumentTagRole()

Method Summary

Modifier and Type	Method	Description
static InstrumentTagRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InstrumentTagRole[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INPUT

public static final InstrumentTagRole INPUT

Field data sets the model input. The instrument pushes received field values into its connected stream or equipment as boundary conditions.

BENCHMARK

public static final InstrumentTagRole BENCHMARK

Field data is compared against the model value for validation, calibration, and optimisation.

VIRTUAL

public static final InstrumentTagRole VIRTUAL

Model-calculated value serves as a virtual measurement (soft sensor). No field data is needed.

Constructor Details

InstrumentTagRole

private InstrumentTagRole()

Method Details

values

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