io.github.robolib.module.actuator

Enum CANJaguar.NeutralMode

java.lang.Object

java.lang.Enum<CANJaguar.NeutralMode>

io.github.robolib.module.actuator.CANJaguar.NeutralMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CANJaguar.NeutralMode>

Enclosing class:

CANJaguar

public static enum CANJaguar.NeutralMode
extends java.lang.Enum<CANJaguar.NeutralMode>

Determines how the Jaguar behaves when sending a zero signal.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Brake Stop the motor's rotation by applying a force.
Coast Do not attempt to stop the motor.
Jumper Use the NeutralMode that is set by the jumper wire on the CAN device

Method Summary

Modifier and Type	Method and Description
static CANJaguar.NeutralMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CANJaguar.NeutralMode[]	values() 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Jumper

public static final CANJaguar.NeutralMode Jumper

Use the NeutralMode that is set by the jumper wire on the CAN device

Brake

public static final CANJaguar.NeutralMode Brake

Stop the motor's rotation by applying a force.

Coast

public static final CANJaguar.NeutralMode Coast

Do not attempt to stop the motor. Instead allow it to coast to a stop without applying resistance.

Method Detail

values

public static CANJaguar.NeutralMode[] 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 (CANJaguar.NeutralMode c : CANJaguar.NeutralMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static CANJaguar.NeutralMode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null