Enum Class HomingCheck.State

java.lang.Object

java.lang.Enum<HomingCheck.State>

frc.spectrumLib.checks.HomingCheck.State

All Implemented Interfaces:

Serializable, Comparable<HomingCheck.State>, Constable

Enclosing class:

HomingCheck

public static enum HomingCheck.State
extends Enum<HomingCheck.State>

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISCONNECTED	Its motor is not answering, so nothing it reports means anything.
FAILED	Its last homing attempt failed.
HOMED	Its position is known.
HOMES_WHEN_ENABLED	Not homed yet, and it homes by itself once enabled (e.g.
LOST	Its motor rebooted since it last homed: it holds until it re-homes.

Method Summary

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

HOMED

public static final HomingCheck.State HOMED

Its position is known.

HOMES_WHEN_ENABLED

public static final HomingCheck.State HOMES_WHEN_ENABLED

Not homed yet, and it homes by itself once enabled (e.g. at auto start).

LOST

public static final HomingCheck.State LOST

Its motor rebooted since it last homed: it holds until it re-homes.

FAILED

public static final HomingCheck.State FAILED

Its last homing attempt failed.

DISCONNECTED

public static final HomingCheck.State DISCONNECTED

Its motor is not answering, so nothing it reports means anything.

Method Details

values

public static HomingCheck.State[] 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 HomingCheck.State 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