Package com.ctre.phoenix.motorcontrol

Enum TalonFXInvertType

java.lang.Object
java.lang.Enum<TalonFXInvertType>
com.ctre.phoenix.motorcontrol.TalonFXInvertType
All Implemented Interfaces:
Serializable, Comparable<TalonFXInvertType>, java.lang.constant.Constable
@Deprecated(since="2024",
            forRemoval=true)
public enum TalonFXInvertType
extends Enum<TalonFXInvertType>
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.

Choose the invert type of the motor controller. None is the equivalent of SetInverted(false), where positive request yields positive voltage on M+. InvertMotorOutput is the equivelant of SetInverted(true), where positive request yields positive voltage on M-. FollowMaster/OpposeMaster will match/oppose a master Talon/Victor. This requires device to be configured as a follower.

  • 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
    Clockwise
    Deprecated, for removal: This API element is subject to removal in a future version.
    Same as SetInverted(true)
    CounterClockwise
    Deprecated, for removal: This API element is subject to removal in a future version.
    Same as SetInverted(false)
    FollowMaster
    Deprecated, for removal: This API element is subject to removal in a future version.
    Follow the invert of the master this MC is following
    OpposeMaster
    Deprecated, for removal: This API element is subject to removal in a future version.
    Oppose the invert of the master this MC is following

  • Field Summary

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

  • Method Summary

    Modifier and Type Method Description
    InvertType toInvertType()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Helper method to convert to generic InvertType enum.
    static TalonFXInvertType 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 TalonFXInvertType[] 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 int value
      Deprecated, for removal: This API element is subject to removal in a future version.
      Value of Invert Type

  • Method Details

    • values

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

    • toInvertType

      public InvertType toInvertType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Helper method to convert to generic InvertType enum.
      Returns:
      value cast as InvertType