Package com.crossbotics.ftchelper.drive

Enum Class AutoDrive.Result

java.lang.Object

java.lang.Enum<AutoDrive.Result>

com.crossbotics.ftchelper.drive.AutoDrive.Result

All Implemented Interfaces:

Serializable, Comparable<AutoDrive.Result>, Constable

Enclosing class:

AutoDrive

public static enum AutoDrive.Result
extends Enum<AutoDrive.Result>

How a move ended. Every move and turn returns one of these, so your autonomous can react (for example, skip the next step if the robot got stuck). An enum is a fixed list of named choices; a variable of this type can only be one of them.

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
DONE	Reached the target.
NO_ODOMETRY	Did not move, or stopped: the odometry is not working (a cable, a fault).
STALLED	Stopped early because the robot was stuck.
STOPPED	Stopped because the OpMode was stopped.
TIMED_OUT	Stopped because it took longer than actionTimeoutSec.

Method Summary

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

DONE

public static final AutoDrive.Result DONE

Reached the target.

NO_ODOMETRY

public static final AutoDrive.Result NO_ODOMETRY

Did not move, or stopped: the odometry is not working (a cable, a fault).

STALLED

public static final AutoDrive.Result STALLED

Stopped early because the robot was stuck.

TIMED_OUT

public static final AutoDrive.Result TIMED_OUT

Stopped because it took longer than actionTimeoutSec.

STOPPED

public static final AutoDrive.Result STOPPED

Stopped because the OpMode was stopped.

Method Details

values

public static AutoDrive.Result[] 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 AutoDrive.Result 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