Package com.ctre.phoenix6.signals

Enum Class Enable5VRailValue

java.lang.Object

java.lang.Enum<Enable5VRailValue>

com.ctre.phoenix6.signals.Enable5VRailValue

All Implemented Interfaces:

Serializable, Comparable<Enable5VRailValue>, java.lang.constant.Constable

public enum Enable5VRailValue
extends Enum<Enable5VRailValue>

Whether the 5V rail is enabled. Disabling the 5V rail will also turn off the onboard LEDs.

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
Disabled	The 5V rail is disabled.
Enabled	The 5V rail is enabled, allowing for LED control.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value

Method Summary

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

Enabled

public static final Enable5VRailValue Enabled

The 5V rail is enabled, allowing for LED control.

Disabled

public static final Enable5VRailValue Disabled

The 5V rail is disabled. This will also turn off the onboard LEDs.

Field Details

value

public final int value

Method Details

values

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

Gets Enable5VRailValue from specified value

Parameters:

value - Value of Enable5VRailValue

Returns:

Enable5VRailValue of specified value