Package com.ctre.phoenix.led

Enum CANdle.VBatOutputMode

java.lang.Object

java.lang.Enum<CANdle.VBatOutputMode>

com.ctre.phoenix.led.CANdle.VBatOutputMode

All Implemented Interfaces:

Serializable, Comparable<CANdle.VBatOutputMode>, java.lang.constant.Constable

Enclosing class:

CANdle

public static enum CANdle.VBatOutputMode
extends Enum<CANdle.VBatOutputMode>

The various methods of managing the VBat output behavior

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, no modulation
On	VBat output is on at full power, no modulation

Field Summary

Fields

Modifier and Type	Field	Description
int	value

Method Summary

Modifier and Type	Method	Description
static CANdle.VBatOutputMode	valueOf(double value)	Get VBatOutputMode of specified value
static CANdle.VBatOutputMode	valueOf(int value)	Get VBatOutputMode of specified value
static CANdle.VBatOutputMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CANdle.VBatOutputMode[]	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

On

public static final CANdle.VBatOutputMode On

VBat output is on at full power, no modulation

Off

public static final CANdle.VBatOutputMode Off

VBat output is off, no modulation

Modulated

public static final CANdle.VBatOutputMode Modulated

VBat output is on at the specified modulation

Field Details

value

public final int value

Method Details

values

public static CANdle.VBatOutputMode[] 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 CANdle.VBatOutputMode 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

valueOf

public static CANdle.VBatOutputMode valueOf(int value)

Get VBatOutputMode of specified value

Parameters:

value - value of VBatOutputMode

Returns:

VBatOutputMode of specified value

valueOf

public static CANdle.VBatOutputMode valueOf(double value)

Get VBatOutputMode of specified value

Parameters:

value - value of VBatOutputMode

Returns:

VBatOutputMode of specified value