Package com.ctre.phoenix.motorcontrol

Enum Class DemandType

java.lang.Object

java.lang.Enum<DemandType>

com.ctre.phoenix.motorcontrol.DemandType

All Implemented Interfaces:

Serializable, Comparable<DemandType>, Constable

public enum DemandType
extends Enum<DemandType>

Choose the demand type for the 4 param set

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
ArbitraryFeedForward	When closed-looping, add demand arbitrarily to the closed-loop output.
AuxPID	When closed-looping, set the target of the aux PID loop to the demand value.
Neutral	Ignore the demand value and apply neutral/no-change.

Field Summary

Fields

Modifier and Type	Field	Description
int	value	Value of DemandType

Method Summary

Modifier and Type	Method	Description
static DemandType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DemandType[]	values()	Returns an array containing the constants of this enum class, 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

Neutral

public static final DemandType Neutral

Ignore the demand value and apply neutral/no-change.

AuxPID

public static final DemandType AuxPID

When closed-looping, set the target of the aux PID loop to the demand value. When following, follow the processed output of the combined primary/aux PID output of the master. The demand value is ignored. Although it is much cleaner to use the 2-param Follow() in such cases.

ArbitraryFeedForward

public static final DemandType ArbitraryFeedForward

When closed-looping, add demand arbitrarily to the closed-loop output.

Field Details

value

public int value

Value of DemandType

Method Details

values

public static DemandType[] values()

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

Returns:

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

valueOf

public static DemandType valueOf(String name)

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

NullPointerException - if the argument is null