Enum Class MotorAlignmentValue

java.lang.Object

java.lang.Enum<MotorAlignmentValue>

com.ctre.phoenix6.signals.MotorAlignmentValue

All Implemented Interfaces:

Serializable, Comparable<MotorAlignmentValue>, Constable

public enum MotorAlignmentValue
extends Enum<MotorAlignmentValue>

The relationship between two motors in a mechanism. Depending on hardware setup, one motor may be inverted relative to the other motor.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Aligned	The two motor directions are aligned.
Opposed	The two motor directions are opposed.

Field Summary

Fields

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

Method Summary

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

Aligned

public static final MotorAlignmentValue Aligned

The two motor directions are aligned. Positive output on both motors moves the mechanism forward/backward.

Opposed

public static final MotorAlignmentValue Opposed

The two motor directions are opposed. To move forward/backward, one motor needs positive output, and the other needs negative output.

Field Details

value

public final int value

Unique integer value of this MotorAlignmentValue.

Method Details

values

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

Gets MotorAlignmentValue from specified value

Parameters:

value - Value of MotorAlignmentValue

Returns:

MotorAlignmentValue of specified value