Package com.ctre.phoenix.motorcontrol

Enum Class TalonFXControlMode

java.lang.Object

java.lang.Enum<TalonFXControlMode>

com.ctre.phoenix.motorcontrol.TalonFXControlMode

All Implemented Interfaces:

Serializable, Comparable<TalonFXControlMode>, Constable

public enum TalonFXControlMode
extends Enum<TalonFXControlMode>

Choose the control mode for a TalonFX / Falcon 500.

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
Current	Input current closed loop
Disabled	Disable Motor Controller
Follower	Follow other motor controller
MotionMagic	Motion Magic
MotionProfile	Motion Profile
MotionProfileArc	Motion Profile with auxiliary output
MusicTone	Plays a single tone.
PercentOutput	Percent output [-1,1]
Position	Position closed loop
Velocity	Velocity closed loop

Field Summary

Fields

Modifier and Type	Field	Description
final int	value	Value of control mode

Method Summary

Modifier and Type	Method	Description
ControlMode	toControlMode()	Helper method to convert to generic ControlMode enum.
static TalonFXControlMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TalonFXControlMode[]	values()	Returns an array containing the constants of this enum class, 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

PercentOutput

public static final TalonFXControlMode PercentOutput

Percent output [-1,1]

Position

public static final TalonFXControlMode Position

Position closed loop

Velocity

public static final TalonFXControlMode Velocity

Velocity closed loop

Current

public static final TalonFXControlMode Current

Input current closed loop

Follower

public static final TalonFXControlMode Follower

Follow other motor controller

MotionProfile

public static final TalonFXControlMode MotionProfile

Motion Profile

MotionMagic

public static final TalonFXControlMode MotionMagic

Motion Magic

MotionProfileArc

public static final TalonFXControlMode MotionProfileArc

Motion Profile with auxiliary output

MusicTone

public static final TalonFXControlMode MusicTone

Plays a single tone. Frequency (hz) is passed into set.

Disabled

public static final TalonFXControlMode Disabled

Disable Motor Controller

Field Details

value

public final int value

Value of control mode

Method Details

values

public static TalonFXControlMode[] values()

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

public static TalonFXControlMode valueOf(String name)

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 name

NullPointerException - if the argument is null

toControlMode

public ControlMode toControlMode()

Helper method to convert to generic ControlMode enum.

Returns:

value cast as ControlMode