Package org.wildstang.framework.pid.controller

Enum PidStateType

java.lang.Object

java.lang.Enum<PidStateType>

org.wildstang.framework.pid.controller.PidStateType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PidStateType>

public enum PidStateType
extends java.lang.Enum<PidStateType>

Represents PID states

Enum Constant Summary

Enum Constants

Enum Constant	Description
PID_ABOVE_TARGET_STATE
PID_BELOW_TARGET_STATE
PID_DISABLED_STATE
PID_INITIALIZE_STATE
PID_ON_TARGET_STATE
PID_STABILIZED_STATE

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PID_DISABLED_STATE

public static final PidStateType PID_DISABLED_STATE

PID_INITIALIZE_STATE

public static final PidStateType PID_INITIALIZE_STATE

PID_BELOW_TARGET_STATE

public static final PidStateType PID_BELOW_TARGET_STATE

PID_ON_TARGET_STATE

public static final PidStateType PID_ON_TARGET_STATE

PID_STABILIZED_STATE

public static final PidStateType PID_STABILIZED_STATE

PID_ABOVE_TARGET_STATE

public static final PidStateType PID_ABOVE_TARGET_STATE

Method Detail

values

public static PidStateType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PidStateType c : PidStateType.values())
    System.out.println(c);

Returns:

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

valueOf

public static PidStateType valueOf(java.lang.String name)

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

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Returns the name of the state.

Overrides:

toString in class java.lang.Enum<PidStateType>

Returns:

Name of the state.