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>, java.lang.constant.Constable

@Deprecated(since="2020",
            forRemoval=true)
public enum PIDSourceType
extends Enum<PIDSourceType>

Deprecated, for removal: This API element is subject to removal in a future version.

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
kDisplacement	Deprecated, for removal: This API element is subject to removal in a future version.
kRate	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
static PIDSourceType	valueOf(String name)	Deprecated, for removal: This API element is subject to removal in a future version. Returns the enum constant of this type with the specified name.
static PIDSourceType[]	values()	Deprecated, for removal: This API element is subject to removal in a future version. 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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

kDisplacement

public static final PIDSourceType kDisplacement

Deprecated, for removal: This API element is subject to removal in a future version.

kRate

public static final PIDSourceType kRate

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

values

public static PIDSourceType[] values()

Deprecated, for removal: This API element is subject to removal in a future version.

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

Returns:

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

valueOf

public static PIDSourceType valueOf(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

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 name

NullPointerException - if the argument is null