Package com.ctre.phoenixpro.signals

Enum MagnetHealthValue

java.lang.Object
java.lang.Enum<MagnetHealthValue>
com.ctre.phoenixpro.signals.MagnetHealthValue
All Implemented Interfaces:
Serializable, Comparable<MagnetHealthValue>, java.lang.constant.Constable
@Deprecated(forRemoval=true)
public enum MagnetHealthValue
extends Enum<MagnetHealthValue>
Deprecated, for removal: This API element is subject to removal in a future version.
Classes in the phoenixpro package will be removed in 2024. Users should instead use classes from the phoenix6 package.
Magnet health as measured by CANcoder.

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 java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    Magnet_Green
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Magnet_Invalid
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Magnet_Orange
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Magnet_Red
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • 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 MagnetHealthValue valueOf​(int value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets MagnetHealthValue from specified value
    static MagnetHealthValue 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 MagnetHealthValue[] 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 MagnetHealthValue[] 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 MagnetHealthValue 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 MagnetHealthValue valueOf​(int value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets MagnetHealthValue from specified value
      Parameters:
      value - Value of MagnetHealthValue
      Returns:
      MagnetHealthValue of specified value