Package edu.wpi.first.wpilibj

Enum Class SynchronousInterrupt.WaitResult

java.lang.Object

java.lang.Enum<SynchronousInterrupt.WaitResult>

edu.wpi.first.wpilibj.SynchronousInterrupt.WaitResult

All Implemented Interfaces:

Serializable, Comparable<SynchronousInterrupt.WaitResult>, Constable

Enclosing class:

SynchronousInterrupt

public static enum SynchronousInterrupt.WaitResult
extends Enum<SynchronousInterrupt.WaitResult>

Event trigger combinations for a synchronous interrupt.

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
kBoth	Both rising and falling edge events.
kFallingEdge	Falling edge event.
kRisingEdge	Rising edge event.
kTimeout	Timeout event.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value	WaitResult value.

Method Summary

Modifier and Type	Method	Description
static SynchronousInterrupt.WaitResult	getValue(boolean rising, boolean falling)	Create a wait result enum.
static SynchronousInterrupt.WaitResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SynchronousInterrupt.WaitResult[]	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

kTimeout

public static final SynchronousInterrupt.WaitResult kTimeout

Timeout event.

kRisingEdge

public static final SynchronousInterrupt.WaitResult kRisingEdge

Rising edge event.

kFallingEdge

public static final SynchronousInterrupt.WaitResult kFallingEdge

Falling edge event.

kBoth

public static final SynchronousInterrupt.WaitResult kBoth

Both rising and falling edge events.

Field Details

value

public final int value

WaitResult value.

Method Details

values

public static SynchronousInterrupt.WaitResult[] 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 SynchronousInterrupt.WaitResult 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

getValue

public static SynchronousInterrupt.WaitResult getValue(boolean rising,
 boolean falling)

Create a wait result enum.

Parameters:

rising - True if a rising edge occurred.

falling - True if a falling edge occurred.

Returns:

A wait result enum.