Package edu.wpi.first.wpilibj
Enum PIDSourceType
- java.lang.Object
-
- java.lang.Enum<PIDSourceType>
-
- edu.wpi.first.wpilibj.PIDSourceType
-
- All Implemented Interfaces:
Serializable
,Comparable<PIDSourceType>
public enum PIDSourceType extends Enum<PIDSourceType>
A description for the type of output value to provide to a PIDController.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description kDisplacement
kRate
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static PIDSourceType
valueOf(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.
-
-
-
Enum Constant Detail
-
kDisplacement
public static final PIDSourceType kDisplacement
-
kRate
public static final PIDSourceType kRate
-
-
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(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-