Package com.reduxrobotics.sensors.canandcolor

Enum Class Canandcolor.DataSource

java.lang.Object

java.lang.Enum<Canandcolor.DataSource>

com.reduxrobotics.sensors.canandcolor.Canandcolor.DataSource

All Implemented Interfaces:

Serializable, Comparable<Canandcolor.DataSource>, Constable

Enclosing class:

Canandcolor

public static enum Canandcolor.DataSource
extends Enum<Canandcolor.DataSource>

Data sources that digout slots can use to perform comparisons or output data directly as a duty cycle.

All values are typically considered to be scaled between 0.0 and 1.0. For proximity, red, green, blue, white, and HSV, the values that digout slots consider (and what the Rio would read if it read the PWM outputs), they are generally equivalent to the values read through functions like Canandcolor.getProximity() or Canandcolor.getColor().

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
kBlue	Blue reading
kGreen	Green reading
kHue	Hue reading
kProximity	Proximity value
kRed	Red reading
kSaturation	Saturation reading
kValue	Value reading
kWhite	White reading

Method Summary

Modifier and Type	Method	Description
static Canandcolor.DataSource	fromIndex(int v)	Fetches the enum associated with the index value.
byte	getIndex()	Returns the associated index number for the enum (used in serialization)
static Canandcolor.DataSource	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Canandcolor.DataSource[]	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

kProximity

public static final Canandcolor.DataSource kProximity

Proximity value

kRed

public static final Canandcolor.DataSource kRed

Red reading

kGreen

public static final Canandcolor.DataSource kGreen

Green reading

kBlue

public static final Canandcolor.DataSource kBlue

Blue reading

kWhite

public static final Canandcolor.DataSource kWhite

White reading

kHue

public static final Canandcolor.DataSource kHue

Hue reading

kSaturation

public static final Canandcolor.DataSource kSaturation

Saturation reading

kValue

public static final Canandcolor.DataSource kValue

Value reading

Method Details

values

public static Canandcolor.DataSource[] 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 Canandcolor.DataSource 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 byte getIndex()

Returns the associated index number for the enum (used in serialization)

Returns:

the associated index number for the enum.

fromIndex

public static Canandcolor.DataSource fromIndex(int v)

Fetches the enum associated with the index value.

Parameters:

v - int containing index value -- if index > max value, the modulo is used

Returns:

corresponding enum