Enum Class SensorDirectionValue

java.lang.Object

java.lang.Enum<SensorDirectionValue>

com.ctre.phoenix6.signals.SensorDirectionValue

All Implemented Interfaces:

Serializable, Comparable<SensorDirectionValue>, Constable

public enum SensorDirectionValue
extends Enum<SensorDirectionValue>

Direction of the sensor to determine positive rotation, as seen facing the LED side of the CANcoder.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Clockwise_Positive	Clockwise motion reports positive rotation.
CounterClockwise_Positive	Counter-clockwise motion reports positive rotation.

Field Summary

Fields

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

Method Summary

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

CounterClockwise_Positive

public static final SensorDirectionValue CounterClockwise_Positive

Counter-clockwise motion reports positive rotation.

Clockwise_Positive

public static final SensorDirectionValue Clockwise_Positive

Clockwise motion reports positive rotation.

Field Details

value

public final int value

Unique integer value of this SensorDirectionValue.

Method Details

values

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

Gets SensorDirectionValue from specified value

Parameters:

value - Value of SensorDirectionValue

Returns:

SensorDirectionValue of specified value