Package edu.wpi.first.wpilibj

Enum Encoder.IndexingType

java.lang.Object

java.lang.Enum<Encoder.IndexingType>

edu.wpi.first.wpilibj.Encoder.IndexingType

All Implemented Interfaces:

Serializable, Comparable<Encoder.IndexingType>, Constable

Enclosing class:

Encoder

public static enum Encoder.IndexingType
extends Enum<Encoder.IndexingType>

Encoder indexing types.

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
kResetOnFallingEdge	Reset on falling edge of the signal.
kResetOnRisingEdge	Reset on rising edge of the signal.
kResetWhileHigh	Reset while the signal is high.
kResetWhileLow	Reset while the signal is low.

Field Summary

Fields

Modifier and Type	Field	Description
int	value	IndexingType value.

Method Summary

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

kResetWhileHigh

public static final Encoder.IndexingType kResetWhileHigh

Reset while the signal is high.

kResetWhileLow

public static final Encoder.IndexingType kResetWhileLow

Reset while the signal is low.

kResetOnFallingEdge

public static final Encoder.IndexingType kResetOnFallingEdge

Reset on falling edge of the signal.

kResetOnRisingEdge

public static final Encoder.IndexingType kResetOnRisingEdge

Reset on rising edge of the signal.

Field Details

value

public final int value

IndexingType value.

Method Details

values

public static Encoder.IndexingType[] 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 Encoder.IndexingType 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