Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni.enumerate

Enum Class EMotorState

java.lang.Object

java.lang.Enum<EMotorState>

com.github.stephengold.joltjni.enumerate.EMotorState

All Implemented Interfaces:

Serializable, Comparable<EMotorState>, Constable

public enum EMotorState
extends Enum<EMotorState>

Enumerate the states a constraint motor can be in.

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
Off	disabled
Position	driving to the target position
Velocity	driving to the target velocity

Method Summary

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

Off

public static final EMotorState Off

disabled

Velocity

public static final EMotorState Velocity

driving to the target velocity

Position

public static final EMotorState Position

driving to the target position

Method Details

values

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