Package tagalong.devices

Enum Class Encoders

java.lang.Object

java.lang.Enum<Encoders>

tagalong.devices.Encoders

All Implemented Interfaces:

Serializable, Comparable<Encoders>, Constable, CanDeviceInterface

public enum Encoders
extends Enum<Encoders>
implements CanDeviceInterface

Generic encoder or encoder like sensors identifier enum

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
CANCODER	CTRE CANcoder
PIGEON2_PITCH	CTRE PIGEON2 -- Pitch used as encoder value
PIGEON2_ROLL	CTRE PIGEON2 -- Roll used as encoder value
PIGEON2_YAW	CTRE PIGEON2 -- Yaw used as encoder value

Field Summary

Fields

Modifier and Type	Field	Description
final int	_ticksPerRotation	Sensor value increments (ticks) per a rotation of the sensor

Method Summary

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

CANCODER

public static final Encoders CANCODER

CTRE CANcoder

PIGEON2_YAW

public static final Encoders PIGEON2_YAW

CTRE PIGEON2 -- Yaw used as encoder value

PIGEON2_PITCH

public static final Encoders PIGEON2_PITCH

CTRE PIGEON2 -- Pitch used as encoder value

PIGEON2_ROLL

public static final Encoders PIGEON2_ROLL

CTRE PIGEON2 -- Roll used as encoder value

Field Details

_ticksPerRotation

public final int _ticksPerRotation

Sensor value increments (ticks) per a rotation of the sensor

Method Details

values

public static Encoders[] 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 Encoders 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