Enum Class MagnetHealthValue

java.lang.Object

java.lang.Enum<MagnetHealthValue>

com.ctre.phoenix6.signals.MagnetHealthValue

All Implemented Interfaces:

Serializable, Comparable<MagnetHealthValue>, Constable

public enum MagnetHealthValue
extends Enum<MagnetHealthValue>

Magnet health as measured by CANcoder.

Red indicates too close or too far, Orange is adequate but with reduced accuracy, green is ideal. Invalid means the accuracy cannot be determined.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Magnet_Green	Magnet health is ideal.
Magnet_Invalid	The accuracy cannot be determined.
Magnet_Orange	Magnet health is adequate but with reduced accuracy.
Magnet_Red	The magnet is too close or too far from the CANcoder.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value	Unique integer value of this MagnetHealthValue.

Method Summary

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

Magnet_Red

public static final MagnetHealthValue Magnet_Red

The magnet is too close or too far from the CANcoder.

Magnet_Orange

public static final MagnetHealthValue Magnet_Orange

Magnet health is adequate but with reduced accuracy.

Magnet_Green

public static final MagnetHealthValue Magnet_Green

Magnet health is ideal.

Magnet_Invalid

public static final MagnetHealthValue Magnet_Invalid

The accuracy cannot be determined.

Field Details

value

public final int value

Unique integer value of this MagnetHealthValue.

Method Details

values

public static MagnetHealthValue[] 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 MagnetHealthValue 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

valueOf

public static MagnetHealthValue valueOf(int value)

Gets MagnetHealthValue from specified value

Parameters:

value - Value of MagnetHealthValue

Returns:

MagnetHealthValue of specified value