Package com.ctre.phoenix6.mechanisms

Enum DifferentialMechanism.RequiresUserReason

java.lang.Object

java.lang.Enum<DifferentialMechanism.RequiresUserReason>

com.ctre.phoenix6.mechanisms.DifferentialMechanism.RequiresUserReason

All Implemented Interfaces:

Serializable, Comparable<DifferentialMechanism.RequiresUserReason>, java.lang.constant.Constable

Enclosing class:

DifferentialMechanism

public static enum DifferentialMechanism.RequiresUserReason
extends Enum<DifferentialMechanism.RequiresUserReason>

Possible reasons for the mechanism to require user action to resume control.

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
DeviceHasReset	A device or remote sensor has reset.
None	No reason given.
RemoteSensorPosOverflow	A remote sensor position has overflowed.

Method Summary

Modifier and Type	Method	Description
static DifferentialMechanism.RequiresUserReason	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DifferentialMechanism.RequiresUserReason[]	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

None

public static final DifferentialMechanism.RequiresUserReason None

No reason given.

RemoteSensorPosOverflow

public static final DifferentialMechanism.RequiresUserReason RemoteSensorPosOverflow

A remote sensor position has overflowed. Because of the nature of remote sensors, it is possible for a remote sensor position to overflow beyond what is supported by the status signal frame. However, this is rare and cannot occur over the course of an FRC match under normal use.

DeviceHasReset

public static final DifferentialMechanism.RequiresUserReason DeviceHasReset

A device or remote sensor has reset.

Method Details

values

public static DifferentialMechanism.RequiresUserReason[] 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 DifferentialMechanism.RequiresUserReason 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