Package com.ctre.phoenix.sensors
Enum Class MagnetFieldStrength
- All Implemented Interfaces:
Serializable
,Comparable<MagnetFieldStrength>
,java.lang.constant.Constable
@Deprecated(since="2024",
forRemoval=true)
public enum MagnetFieldStrength
extends Enum<MagnetFieldStrength>
Deprecated, for removal: This API element is subject to removal in a future version.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDeprecated, for removal: This API element is subject to removal in a future version.Magnet field is adequate, sensor can be used in this range with slightly reduced accuracy.Deprecated, for removal: This API element is subject to removal in a future version.Magnet field is far too low (too far) or far too high (too close).Deprecated, for removal: This API element is subject to removal in a future version.Magnet field is idealDeprecated, for removal: This API element is subject to removal in a future version.Magnet Field strength cannot be determined -
Field Summary
FieldsModifier and TypeFieldDescriptionfinal int
Deprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescriptionstatic MagnetFieldStrength
valueOf
(int value) Deprecated, for removal: This API element is subject to removal in a future version.public lookup to convert int to enumstatic MagnetFieldStrength
Deprecated, for removal: This API element is subject to removal in a future version.Returns the enum constant of this class with the specified name.static MagnetFieldStrength[]
values()
Deprecated, for removal: This API element is subject to removal in a future version.Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
Invalid_Unknown
Deprecated, for removal: This API element is subject to removal in a future version.Magnet Field strength cannot be determined -
BadRange_RedLED
Deprecated, for removal: This API element is subject to removal in a future version.Magnet field is far too low (too far) or far too high (too close). -
Adequate_OrangeLED
Deprecated, for removal: This API element is subject to removal in a future version.Magnet field is adequate, sensor can be used in this range with slightly reduced accuracy. -
Good_GreenLED
Deprecated, for removal: This API element is subject to removal in a future version.Magnet field is ideal
-
-
Field Details
-
value
Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Method Details
-
values
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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 nameNullPointerException
- if the argument is null
-
valueOf
Deprecated, for removal: This API element is subject to removal in a future version.public lookup to convert int to enum
-
If the Phoenix 5 API must be used for this device, the device must have 22.X firmware. This firmware is available in Tuner X after selecting Phoenix 5 in the firmware year dropdown.