Package edu.wpi.first.math

Enum Class MathUsageId

java.lang.Object

java.lang.Enum<MathUsageId>

edu.wpi.first.math.MathUsageId

All Implemented Interfaces:

Serializable, Comparable<MathUsageId>, Constable

public enum MathUsageId
extends Enum<MathUsageId>

WPIMath usage reporting IDs.

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
kController_BangBangController	BangBangController.
kController_PIDController2	PIDController.
kController_ProfiledPIDController	ProfiledPIDController.
kFilter_Linear	LinearFilter.
kKinematics_DifferentialDrive	DifferentialDriveKinematics.
kKinematics_MecanumDrive	MecanumDriveKinematics.
kKinematics_SwerveDrive	SwerveDriveKinematics.
kOdometry_DifferentialDrive	DifferentialDriveOdometry.
kOdometry_MecanumDrive	MecanumDriveOdometry.
kOdometry_SwerveDrive	SwerveDriveOdometry.
kTrajectory_PathWeaver	PathWeaver Trajectory.
kTrajectory_TrapezoidProfile	TrapezoidProfile.

Method Summary

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

kKinematics_DifferentialDrive

public static final MathUsageId kKinematics_DifferentialDrive

DifferentialDriveKinematics.

kKinematics_MecanumDrive

public static final MathUsageId kKinematics_MecanumDrive

MecanumDriveKinematics.

kKinematics_SwerveDrive

public static final MathUsageId kKinematics_SwerveDrive

SwerveDriveKinematics.

kTrajectory_TrapezoidProfile

public static final MathUsageId kTrajectory_TrapezoidProfile

TrapezoidProfile.

kFilter_Linear

public static final MathUsageId kFilter_Linear

LinearFilter.

kOdometry_DifferentialDrive

public static final MathUsageId kOdometry_DifferentialDrive

DifferentialDriveOdometry.

kOdometry_SwerveDrive

public static final MathUsageId kOdometry_SwerveDrive

SwerveDriveOdometry.

kOdometry_MecanumDrive

public static final MathUsageId kOdometry_MecanumDrive

MecanumDriveOdometry.

kController_PIDController2

public static final MathUsageId kController_PIDController2

PIDController.

kController_ProfiledPIDController

public static final MathUsageId kController_ProfiledPIDController

ProfiledPIDController.

kController_BangBangController

public static final MathUsageId kController_BangBangController

BangBangController.

kTrajectory_PathWeaver

public static final MathUsageId kTrajectory_PathWeaver

PathWeaver Trajectory.

Method Details

values

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