Package com.ctre.phoenix6.signals

Enum MotorOutputStatusValue

java.lang.Object

java.lang.Enum<MotorOutputStatusValue>

com.ctre.phoenix6.signals.MotorOutputStatusValue

All Implemented Interfaces:

Serializable, Comparable<MotorOutputStatusValue>, java.lang.constant.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. Off means that motor output is disabled. StaticBraking typically means the motor is in neutral-brake. Motoring means motor is loaded in a typical fashion, drawing current from the supply, and successfully turning the rotor in the direction of applied voltage. Discordant Motoring is the same as Motoring, expect the rotor is being backdriven as the motor output is not enough to defeat load forces. RegenBraking means the motor is braking in such a way where motor current is traveling back to the supply (typically a battery).

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
DiscordantMotoring
Motoring
Off
RegenBraking
StaticBraking
Unknown

Field Summary

Fields

Modifier and Type	Field	Description
int	value

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 type with the specified name.
static MotorOutputStatusValue[]	values()	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

Unknown

public static final MotorOutputStatusValue Unknown

Off

public static final MotorOutputStatusValue Off

StaticBraking

public static final MotorOutputStatusValue StaticBraking

Motoring

public static final MotorOutputStatusValue Motoring

DiscordantMotoring

public static final MotorOutputStatusValue DiscordantMotoring

RegenBraking

public static final MotorOutputStatusValue RegenBraking

Field Details

value

public final int value

Method Details

values

public static MotorOutputStatusValue[] values()

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 MotorOutputStatusValue valueOf(String name)

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 MotorOutputStatusValue valueOf(int value)

Gets MotorOutputStatusValue from specified value

Parameters:

value - Value of MotorOutputStatusValue

Returns:

MotorOutputStatusValue of specified value