Enum Class ControlMode

java.lang.Object

java.lang.Enum<ControlMode>

yams.core.motorcontrollers.enums.ControlMode

All Implemented Interfaces:

Serializable, Comparable<ControlMode>, Constable

public enum ControlMode
extends Enum<ControlMode>

Control mode for a motor controller.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSED_LOOP	Use the PID controller.
OPEN_LOOP	Open loop control mode.

Method Summary

Modifier and Type	Method	Description
static ControlMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ControlMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OPEN_LOOP

public static final ControlMode OPEN_LOOP

Open loop control mode. Does not use the PID controller.

CLOSED_LOOP

public static final ControlMode CLOSED_LOOP

Use the PID controller.

Method Details

values

public static ControlMode[] 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 ControlMode 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