Enum Class MPCVariable.MPCVariableType

java.lang.Object

java.lang.Enum<MPCVariable.MPCVariableType>

neqsim.process.mpc.MPCVariable.MPCVariableType

All Implemented Interfaces:

Serializable, Comparable<MPCVariable.MPCVariableType>, Constable

Enclosing class:

MPCVariable

public static enum MPCVariable.MPCVariableType
extends Enum<MPCVariable.MPCVariableType>

Enumeration of MPC variable types.

Since:

3.0

Version:

1.0

Author:

Even Solbraa

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTROLLED	Controlled Variable - target to be controlled to setpoint.
DISTURBANCE	Disturbance Variable - measured but not controlled (feedforward).
MANIPULATED	Manipulated Variable - can be adjusted by the controller.
STATE	State Variable - internal model state for nonlinear MPC.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MPCVariableType()

Method Summary

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

MANIPULATED

public static final MPCVariable.MPCVariableType MANIPULATED

Manipulated Variable - can be adjusted by the controller.

CONTROLLED

public static final MPCVariable.MPCVariableType CONTROLLED

Controlled Variable - target to be controlled to setpoint.

DISTURBANCE

public static final MPCVariable.MPCVariableType DISTURBANCE

Disturbance Variable - measured but not controlled (feedforward).

STATE

public static final MPCVariable.MPCVariableType STATE

State Variable - internal model state for nonlinear MPC.

Constructor Details

MPCVariableType

private MPCVariableType()

Method Details

values

public static MPCVariable.MPCVariableType[] 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 MPCVariable.MPCVariableType 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