Package org.texastorque.torquelib.base

Enum Class TorqueDirection

java.lang.Object

java.lang.Enum<TorqueDirection>

org.texastorque.torquelib.base.TorqueDirection

All Implemented Interfaces:

Serializable, Comparable<TorqueDirection>, Constable

public enum TorqueDirection
extends Enum<TorqueDirection>

An enum to represent a three state representation of a direction with a quick multiplier. Implements TorqueSubsystemState for the static logging method.

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
FORWARD
NEUTRAL
REVERSE

Field Summary

Fields

Modifier and Type	Field	Description
static final TorqueDirection	OFF

Method Summary

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

REVERSE

public static final TorqueDirection REVERSE

NEUTRAL

public static final TorqueDirection NEUTRAL

FORWARD

public static final TorqueDirection FORWARD

Field Details

OFF

public static final TorqueDirection OFF

Method Details

values

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

get

public final double get()