Enum Class MotorOutputStatusValue

java.lang.Object

java.lang.Enum<MotorOutputStatusValue>

com.ctre.phoenix6.signals.MotorOutputStatusValue

All Implemented Interfaces:

Serializable, Comparable<MotorOutputStatusValue>, Constable

public enum MotorOutputStatusValue
extends Enum<MotorOutputStatusValue>

Assess the status of the motor output with respect to load and supply.

This routine can be used to determine the general status of motor commutation.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DiscordantMotoring	The same as Motoring, except the rotor is being backdriven as the motor output is not enough to defeat load forces.
Motoring	The motor is loaded in a typical fashion, drawing current from the supply, and successfully turning the rotor in the direction of applied voltage.
Off	Motor output is disabled.
RegenBraking	The motor is braking in such a way where motor current is traveling back to the supply (typically a battery).
StaticBraking	The motor is in neutral-brake.
Unknown	The status of motor output could not be determined.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value	Unique integer value of this MotorOutputStatusValue.

Method Summary

Modifier and Type	Method	Description
static MotorOutputStatusValue	valueOf(int value)	Gets MotorOutputStatusValue from specified value
static MotorOutputStatusValue	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MotorOutputStatusValue[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Unknown

public static final MotorOutputStatusValue Unknown

The status of motor output could not be determined.

Off

public static final MotorOutputStatusValue Off

Motor output is disabled.

StaticBraking

public static final MotorOutputStatusValue StaticBraking

The motor is in neutral-brake.

Motoring

public static final MotorOutputStatusValue Motoring

The motor is loaded in a typical fashion, drawing current from the supply, and successfully turning the rotor in the direction of applied voltage.

DiscordantMotoring

public static final MotorOutputStatusValue DiscordantMotoring

The same as Motoring, except the rotor is being backdriven as the motor output is not enough to defeat load forces.

RegenBraking

public static final MotorOutputStatusValue RegenBraking

The motor is braking in such a way where motor current is traveling back to the supply (typically a battery).

Field Details

value

public final int value

Unique integer value of this MotorOutputStatusValue.

Method Details

values

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

valueOf

public static MotorOutputStatusValue valueOf(int value)

Gets MotorOutputStatusValue from specified value

Parameters:

value - Value of MotorOutputStatusValue

Returns:

MotorOutputStatusValue of specified value