Enum Class TimestepMethod

java.lang.Object

java.lang.Enum<TimestepMethod>

org.wpilib.math.optimization.ocp.TimestepMethod

All Implemented Interfaces:

Serializable, Comparable<TimestepMethod>, Constable

public enum TimestepMethod
extends Enum<TimestepMethod>

Enum describing the type of system timestep.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIXED	The timestep is a fixed constant.
VARIABLE	The timesteps are allowed to vary as independent decision variables.
VARIABLE_SINGLE	The timesteps are equal length but allowed to vary as a single decision variable.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value	TimestepMethod value.

Method Summary

Modifier and Type	Method	Description
static TimestepMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TimestepMethod[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FIXED

public static final TimestepMethod FIXED

The timestep is a fixed constant.

VARIABLE

public static final TimestepMethod VARIABLE

The timesteps are allowed to vary as independent decision variables.

VARIABLE_SINGLE

public static final TimestepMethod VARIABLE_SINGLE

The timesteps are equal length but allowed to vary as a single decision variable.

Field Details

value

public final int value

TimestepMethod value.

Method Details

values

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