Package com.ctre.phoenix6.signals

Enum Class VBatOutputModeValue

java.lang.Object

java.lang.Enum<VBatOutputModeValue>

com.ctre.phoenix6.signals.VBatOutputModeValue

All Implemented Interfaces:

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

public enum VBatOutputModeValue
extends Enum<VBatOutputModeValue>

The behavior of the VBat output. CANdle supports modulating VBat output for single-color LED strips.

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
Modulated	VBat output is on at the specified modulation.
Off	VBat output is off.
On	VBat output is on at full power.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value

Method Summary

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

On

public static final VBatOutputModeValue On

VBat output is on at full power.

Off

public static final VBatOutputModeValue Off

VBat output is off.

Modulated

public static final VBatOutputModeValue Modulated

VBat output is on at the specified modulation.

Field Details

value

public final int value

Method Details

values

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

Gets VBatOutputModeValue from specified value

Parameters:

value - Value of VBatOutputModeValue

Returns:

VBatOutputModeValue of specified value