Package tagalong.units

Enum Class VelocityUnits

java.lang.Object

java.lang.Enum<VelocityUnits>

tagalong.units.VelocityUnits

All Implemented Interfaces:

Serializable, Comparable<VelocityUnits>, Constable

public enum VelocityUnits
extends Enum<VelocityUnits>

Velocity units enum identifiers. Used for configuration and robot setup instead of the WPILib Java units to avoid reallocations and garbage collections in match.

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
DEGPS	Degrees per Second aka DegPS aka deg/second
DEGREES_PER_HOUR	Degrees per Hour aka deg/hour
DEGREES_PER_MILLISECOND	Degrees per Millisecond aka deg/millisecond
DEGREES_PER_MINUTE	Degrees per Minute aka deg/minute
DEGREES_PER_SECOND	Degrees per Second aka DegPS aka deg/second
FEET_PER_HOUR	Feet per Hour aka feet/hour
FEET_PER_MILLISECOND	Feet per Millisecond aka feet/millisecond
FEET_PER_MINUTE	Feet per Minute aka feet/minute
FEET_PER_SECOND	Feet per Second aka FPS aka feet/second
INCHES_PER_HOUR	Inches per Hour aka inch/hour
INCHES_PER_MILLISECOND	Inches per Millisecond aka feet/millisecond
INCHES_PER_MINUTE	Inches per Minute aka inch/minute
INCHES_PER_SECOND	Inches per Second aka inch/second
METERS_PER_HOUR	Meter per Hour aka meter/hour
METERS_PER_MILLISECOND	Meter per Millisecond aka meter/millisecond
METERS_PER_MINUTE	Meter per Minute aka meter/minute
METERS_PER_SECOND	Meter per Second aka MPS aka meter/second
MPS	Meter per Second aka MPS aka meter/second
RADIANS_PER_HOUR	Radians per Hour aka radians/hour
RADIANS_PER_MILLISECOND	Radians per Millisecond aka radians/millisecond
RADIANS_PER_MINUTE	Radians per Minute aka radians/minute
RADIANS_PER_SECOND	Radians per Second aka radians/second
RADPS	Radians per Second aka RadPS aka radians/second
ROTATIONS_PER_HOUR	Rotations per Hour aka rotations/hour
ROTATIONS_PER_MILLISECOND	Rotations per Millisecond aka rotations/Millisecond
ROTATIONS_PER_MINUTE	Rotations per Minute aka RPM aka rotations/minute
ROTATIONS_PER_SECOND	Rotations per Second aka RPS aka rotations/second
ROTPS	Rotations per Second aka RPS aka rotations/second
RPS	Rotations per Second aka RPS aka rotations/second

Field Summary

Fields

Modifier and Type	Field	Description
final DistanceUnits	distanceUnit	The distance portion of the velocity unit
final TimeUnits	timeUnit	The time portion of the velocity unit

Method Summary

Modifier and Type	Method	Description
double	convertX(double x, VelocityUnits targetUnit)	Convert from base class' unit to the targetUnit type
static VelocityUnits	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VelocityUnits[]	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

MPS

public static final VelocityUnits MPS

Meter per Second aka MPS aka meter/second

ROTPS

public static final VelocityUnits ROTPS

Rotations per Second aka RPS aka rotations/second

RPS

public static final VelocityUnits RPS

Rotations per Second aka RPS aka rotations/second

RADPS

public static final VelocityUnits RADPS

Radians per Second aka RadPS aka radians/second

DEGPS

public static final VelocityUnits DEGPS

Degrees per Second aka DegPS aka deg/second

METERS_PER_MILLISECOND

public static final VelocityUnits METERS_PER_MILLISECOND

Meter per Millisecond aka meter/millisecond

METERS_PER_SECOND

public static final VelocityUnits METERS_PER_SECOND

Meter per Second aka MPS aka meter/second

METERS_PER_MINUTE

public static final VelocityUnits METERS_PER_MINUTE

Meter per Minute aka meter/minute

METERS_PER_HOUR

public static final VelocityUnits METERS_PER_HOUR

Meter per Hour aka meter/hour

FEET_PER_MILLISECOND

public static final VelocityUnits FEET_PER_MILLISECOND

Feet per Millisecond aka feet/millisecond

FEET_PER_SECOND

public static final VelocityUnits FEET_PER_SECOND

Feet per Second aka FPS aka feet/second

FEET_PER_MINUTE

public static final VelocityUnits FEET_PER_MINUTE

Feet per Minute aka feet/minute

FEET_PER_HOUR

public static final VelocityUnits FEET_PER_HOUR

Feet per Hour aka feet/hour

INCHES_PER_MILLISECOND

public static final VelocityUnits INCHES_PER_MILLISECOND

Inches per Millisecond aka feet/millisecond

INCHES_PER_SECOND

public static final VelocityUnits INCHES_PER_SECOND

Inches per Second aka inch/second

INCHES_PER_MINUTE

public static final VelocityUnits INCHES_PER_MINUTE

Inches per Minute aka inch/minute

INCHES_PER_HOUR

public static final VelocityUnits INCHES_PER_HOUR

Inches per Hour aka inch/hour

ROTATIONS_PER_MILLISECOND

public static final VelocityUnits ROTATIONS_PER_MILLISECOND

Rotations per Millisecond aka rotations/Millisecond

ROTATIONS_PER_SECOND

public static final VelocityUnits ROTATIONS_PER_SECOND

Rotations per Second aka RPS aka rotations/second

ROTATIONS_PER_MINUTE

public static final VelocityUnits ROTATIONS_PER_MINUTE

Rotations per Minute aka RPM aka rotations/minute

ROTATIONS_PER_HOUR

public static final VelocityUnits ROTATIONS_PER_HOUR

Rotations per Hour aka rotations/hour

RADIANS_PER_MILLISECOND

public static final VelocityUnits RADIANS_PER_MILLISECOND

Radians per Millisecond aka radians/millisecond

RADIANS_PER_SECOND

public static final VelocityUnits RADIANS_PER_SECOND

Radians per Second aka radians/second

RADIANS_PER_MINUTE

public static final VelocityUnits RADIANS_PER_MINUTE

Radians per Minute aka radians/minute

RADIANS_PER_HOUR

public static final VelocityUnits RADIANS_PER_HOUR

Radians per Hour aka radians/hour

DEGREES_PER_MILLISECOND

public static final VelocityUnits DEGREES_PER_MILLISECOND

Degrees per Millisecond aka deg/millisecond

DEGREES_PER_SECOND

public static final VelocityUnits DEGREES_PER_SECOND

Degrees per Second aka DegPS aka deg/second

DEGREES_PER_MINUTE

public static final VelocityUnits DEGREES_PER_MINUTE

Degrees per Minute aka deg/minute

DEGREES_PER_HOUR

public static final VelocityUnits DEGREES_PER_HOUR

Degrees per Hour aka deg/hour

Field Details

distanceUnit

public final DistanceUnits distanceUnit

The distance portion of the velocity unit

timeUnit

public final TimeUnits timeUnit

The time portion of the velocity unit

Method Details

values

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

convertX

public double convertX(double x,
 VelocityUnits targetUnit)

Convert from base class' unit to the targetUnit type

Parameters:

x - double value to be converted

targetUnit - target unit

Returns:

x converted to the target units