Package com.ctre.phoenix.sensors

Enum MagnetFieldStrength

java.lang.Object

java.lang.Enum<MagnetFieldStrength>

com.ctre.phoenix.sensors.MagnetFieldStrength

All Implemented Interfaces:

Serializable, Comparable<MagnetFieldStrength>, java.lang.constant.Constable

public enum MagnetFieldStrength
extends Enum<MagnetFieldStrength>

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
Adequate_OrangeLED	Magnet field is adequate, sensor can be used in this range with slightly reduced accuracy.
BadRange_RedLED	Magnet field is far too low (too far) or far too high (too close).
Good_GreenLED	Magnet field is ideal
Invalid_Unknown	Magnet Field strength cannot be determined

Field Summary

Fields

Modifier and Type	Field	Description
int	value

Method Summary

Modifier and Type	Method	Description
static MagnetFieldStrength	valueOf(int value)	public lookup to convert int to enum
static MagnetFieldStrength	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MagnetFieldStrength[]	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, 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

Invalid_Unknown

public static final MagnetFieldStrength Invalid_Unknown

Magnet Field strength cannot be determined

BadRange_RedLED

public static final MagnetFieldStrength BadRange_RedLED

Magnet field is far too low (too far) or far too high (too close).

Adequate_OrangeLED

public static final MagnetFieldStrength Adequate_OrangeLED

Magnet field is adequate, sensor can be used in this range with slightly reduced accuracy.

Good_GreenLED

public static final MagnetFieldStrength Good_GreenLED

Magnet field is ideal

Field Details

value

public final int value

Method Details

values

public static MagnetFieldStrength[] values()

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

Returns:

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

valueOf

public static MagnetFieldStrength valueOf(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:

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

NullPointerException - if the argument is null

valueOf

public static MagnetFieldStrength valueOf(int value)

public lookup to convert int to enum