Enum Class Limelight.Status

java.lang.Object

java.lang.Enum<Limelight.Status>

com.limelightvision.Limelight.Status

All Implemented Interfaces:

Serializable, Comparable<Limelight.Status>, Constable

Enclosing class:

Limelight

public static enum Limelight.Status
extends Enum<Limelight.Status>

Health of a camera.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DECODE_ERROR	The newest frame did not decode.
NO_DATA	The camera has not sent a results envelope.
OK	A decodable frame has been received recently.
STALE	The newest frame is older than the stale threshold.

Method Summary

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

OK

public static final Limelight.Status OK

A decodable frame has been received recently.

NO_DATA

public static final Limelight.Status NO_DATA

The camera has not sent a results envelope. Possible causes: the camera is off, the name is wrong, or MsgPack output is disabled

STALE

public static final Limelight.Status STALE

The newest frame is older than the stale threshold. The camera is disconnected or has stopped. The default threshold is Limelight.STALE_FRAME_SECONDS. See Limelight.withStaleFrameThreshold(double)

DECODE_ERROR

public static final Limelight.Status DECODE_ERROR

The newest frame did not decode. See Limelight.LimelightResults.error

Method Details

values

public static Limelight.Status[] 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 Limelight.Status 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