org.usfirst.frc.team1736.lib.CasserolePID

Enum AdvancedCasserolePID.GainScheduleTypes

java.lang.Object

java.lang.Enum<AdvancedCasserolePID.GainScheduleTypes>

org.usfirst.frc.team1736.lib.CasserolePID.AdvancedCasserolePID.GainScheduleTypes

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AdvancedCasserolePID.GainScheduleTypes>

Enclosing class:

AdvancedCasserolePID

public static enum AdvancedCasserolePID.GainScheduleTypes
extends java.lang.Enum<AdvancedCasserolePID.GainScheduleTypes>

Supported types of Gain Scheduling

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR Schedule PID gains based on present Error value
EXTERNAL Schedule PID gains based on an external value, set by the setGainSchedulerVal() method
NONE Do not use gain scheduling.
SETPOINT Schedule PID gains based on present Setpoint value

Method Summary

Modifier and Type	Method and Description
static AdvancedCasserolePID.GainScheduleTypes	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AdvancedCasserolePID.GainScheduleTypes[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final AdvancedCasserolePID.GainScheduleTypes NONE

Do not use gain scheduling.

SETPOINT

public static final AdvancedCasserolePID.GainScheduleTypes SETPOINT

Schedule PID gains based on present Setpoint value

ERROR

public static final AdvancedCasserolePID.GainScheduleTypes ERROR

Schedule PID gains based on present Error value

EXTERNAL

public static final AdvancedCasserolePID.GainScheduleTypes EXTERNAL

Schedule PID gains based on an external value, set by the setGainSchedulerVal() method

Method Detail

values

public static AdvancedCasserolePID.GainScheduleTypes[] 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 (AdvancedCasserolePID.GainScheduleTypes c : AdvancedCasserolePID.GainScheduleTypes.values())
    System.out.println(c);

Returns:

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

valueOf

public static AdvancedCasserolePID.GainScheduleTypes 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