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
@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.
This device's Phoenix 5 API is deprecated for removal in the 2025 season. Users should update to Phoenix 6 firmware and migrate to the Phoenix 6 API. A migration guide is available at https://v6.docs.ctr-electronics.com/en/stable/docs/migration/migration-guide/index.html.

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.

  • 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
    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.
    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).
    Good_GreenLED
    Deprecated, for removal: This API element is subject to removal in a future version.
    Magnet field is ideal
    Invalid_Unknown
    Deprecated, for removal: This API element is subject to removal in a future version.
    Magnet Field strength cannot be determined

  • Field Summary

    Fields 
    Modifier and Type Field Description
    int value
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type Method Description
    static MagnetFieldStrength valueOf​(int value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    public lookup to convert int to enum
    static MagnetFieldStrength valueOf​(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the enum constant of this type 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 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

  • Field Details

    • value

      public final int value
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • values

      public 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 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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      public lookup to convert int to enum