Enum Class ControllerDeviceInterface.ControllerMode

java.lang.Object

java.lang.Enum<ControllerDeviceInterface.ControllerMode>

neqsim.process.controllerdevice.ControllerDeviceInterface.ControllerMode

All Implemented Interfaces:

Serializable, Comparable<ControllerDeviceInterface.ControllerMode>, Constable

Enclosing interface:

ControllerDeviceInterface

public static enum ControllerDeviceInterface.ControllerMode
extends Enum<ControllerDeviceInterface.ControllerMode>

Operating modes for a feedback controller. These mirror the standard modes found in commercial DCS and simulator products (AUTO, MANUAL, CASCADE).

Version:

$Id: $Id

Author:

Even Solbraa

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	Controller output is computed by the PID algorithm.
CASCADE	Controller receives its set-point from an upstream (primary) controller rather than from a fixed value.
MANUAL	Controller output is set manually by the operator; PID computation is bypassed.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ControllerMode()

Method Summary

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

AUTO

public static final ControllerDeviceInterface.ControllerMode AUTO

Controller output is computed by the PID algorithm.

MANUAL

public static final ControllerDeviceInterface.ControllerMode MANUAL

Controller output is set manually by the operator; PID computation is bypassed.

CASCADE

public static final ControllerDeviceInterface.ControllerMode CASCADE

Controller receives its set-point from an upstream (primary) controller rather than from a fixed value.

Constructor Details

ControllerMode

private ControllerMode()

Method Details

values

public static ControllerDeviceInterface.ControllerMode[] 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 ControllerDeviceInterface.ControllerMode 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