Package com.playingwithfusion

Enum Class CANVenom.BrakeCoastMode

java.lang.Object

java.lang.Enum<CANVenom.BrakeCoastMode>

com.playingwithfusion.CANVenom.BrakeCoastMode

All Implemented Interfaces:

Serializable, Comparable<CANVenom.BrakeCoastMode>, Constable

Enclosing class:

CANVenom

public static enum CANVenom.BrakeCoastMode
extends Enum<CANVenom.BrakeCoastMode>

Enumeration to specify motor break or coast behavior when no current is commanded

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
Brake	The motor is shorted when the porportional or vlotage command is zero.
Coast	The motor is open circuited when the porportional or volatage command is zero, causing the motor to coast or free-wheel

Method Summary

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

Coast

public static final CANVenom.BrakeCoastMode Coast

The motor is open circuited when the porportional or volatage command is zero, causing the motor to coast or free-wheel

Brake

public static final CANVenom.BrakeCoastMode Brake

The motor is shorted when the porportional or vlotage command is zero. This acts to brake/slow the motor to a stop.

Method Details

values

public static CANVenom.BrakeCoastMode[] 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 CANVenom.BrakeCoastMode 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