edu.wpi.first.wpilibj

Enum PIDSourceType

java.lang.Object

java.lang.Enum<PIDSourceType>

edu.wpi.first.wpilibj.PIDSourceType

All Implemented Interfaces:

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

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

A description for the type of output value to provide to a PIDController.

Enum Constant Summary

Enum Constants

Enum Constant and Description
kDisplacement
kRate

Field Summary

Fields

Modifier and Type	Field and Description
int	value The integer value representing this enumeration.

Method Summary

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

kDisplacement

public static final PIDSourceType kDisplacement

kRate

public static final PIDSourceType kRate

Field Detail

value

public final int value

The integer value representing this enumeration.

Method Detail

values

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

Returns:

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

valueOf

public static PIDSourceType 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