Enum Class AppliedRotorPolarityValue

java.lang.Object

java.lang.Enum<AppliedRotorPolarityValue>

com.ctre.phoenix6.signals.AppliedRotorPolarityValue

All Implemented Interfaces:

Serializable, Comparable<AppliedRotorPolarityValue>, Constable

public enum AppliedRotorPolarityValue
extends Enum<AppliedRotorPolarityValue>

The applied rotor polarity as seen from the front of the motor. This typically is determined by the Inverted config, but can be overridden if using Follower features.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PositiveIsClockwise	Positive motor output results in clockwise motion.
PositiveIsCounterClockwise	Positive motor output results in counter-clockwise motion.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static AppliedRotorPolarityValue	valueOf(int value)	Gets AppliedRotorPolarityValue from specified value
static AppliedRotorPolarityValue	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AppliedRotorPolarityValue[]	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

PositiveIsCounterClockwise

public static final AppliedRotorPolarityValue PositiveIsCounterClockwise

Positive motor output results in counter-clockwise motion.

PositiveIsClockwise

public static final AppliedRotorPolarityValue PositiveIsClockwise

Positive motor output results in clockwise motion.

Field Details

value

public final int value

Unique integer value of this AppliedRotorPolarityValue.

Method Details

values

public static AppliedRotorPolarityValue[] 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 AppliedRotorPolarityValue 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 AppliedRotorPolarityValue valueOf(int value)

Gets AppliedRotorPolarityValue from specified value

Parameters:

value - Value of AppliedRotorPolarityValue

Returns:

AppliedRotorPolarityValue of specified value