Package com.reduxrobotics.sensors.canandcolor

Enum Class CanandcolorProximityConfig.LEDCurrent

java.lang.Object

java.lang.Enum<CanandcolorProximityConfig.LEDCurrent>

com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.LEDCurrent

All Implemented Interfaces:

Serializable, Comparable<CanandcolorProximityConfig.LEDCurrent>, Constable

Enclosing class:

CanandcolorProximityConfig

public static enum CanandcolorProximityConfig.LEDCurrent
extends Enum<CanandcolorProximityConfig.LEDCurrent>

Determines how much current gets dumped into the IR LED and thus its intensity. Higher intensities can detect longer ranges but come at the tradeoff of close range saturation. Recommended default is max intensity at 20 mA.

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
k10mA	10 milliamp LED current.
k12mA	12 milliamp LED current.
k14mA	14 milliamp LED current.
k16mA	16 milliamp LED current.
k18mA	18 milliamp LED current.
k20mA	20 milliamp LED current.
k6mA	6 milliamp LED current.
k8mA	8 milliamp LED current.

Method Summary

Modifier and Type	Method	Description
static CanandcolorProximityConfig.LEDCurrent	fromIndex(int v)	Fetches the enum associated with the index value.
int	getIndex()	Fetches the index associated with the enum.
static CanandcolorProximityConfig.LEDCurrent	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CanandcolorProximityConfig.LEDCurrent[]	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

k6mA

public static final CanandcolorProximityConfig.LEDCurrent k6mA

6 milliamp LED current.

k8mA

public static final CanandcolorProximityConfig.LEDCurrent k8mA

8 milliamp LED current.

k10mA

public static final CanandcolorProximityConfig.LEDCurrent k10mA

10 milliamp LED current.

k12mA

public static final CanandcolorProximityConfig.LEDCurrent k12mA

12 milliamp LED current.

k14mA

public static final CanandcolorProximityConfig.LEDCurrent k14mA

14 milliamp LED current.

k16mA

public static final CanandcolorProximityConfig.LEDCurrent k16mA

16 milliamp LED current.

k18mA

public static final CanandcolorProximityConfig.LEDCurrent k18mA

18 milliamp LED current.

k20mA

public static final CanandcolorProximityConfig.LEDCurrent k20mA

20 milliamp LED current.

Method Details

values

public static CanandcolorProximityConfig.LEDCurrent[] 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 CanandcolorProximityConfig.LEDCurrent 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

getIndex

public int getIndex()

Fetches the index associated with the enum.

Returns:

index value

fromIndex

public static CanandcolorProximityConfig.LEDCurrent fromIndex(int v)

Fetches the enum associated with the index value.

Parameters:

v - int containing index value; only lower 3 bits are used

Returns:

corresponding enum