Package tagalong.units

Enum Class TimeUnits

java.lang.Object

java.lang.Enum<TimeUnits>

tagalong.units.TimeUnits

All Implemented Interfaces:

Serializable, Comparable<TimeUnits>, Constable

public enum TimeUnits
extends Enum<TimeUnits>

Time 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
HOUR	Hour
MILLISECOND	Milliseconds
MINUTE	Minutes
SECOND	Seconds

Field Summary

Fields

Modifier and Type	Field	Description
final double	conversionToSeconds	Seconds per unit (conversion l.t.

Method Summary

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

MILLISECOND

public static final TimeUnits MILLISECOND

Milliseconds

SECOND

public static final TimeUnits SECOND

Seconds

MINUTE

public static final TimeUnits MINUTE

Minutes

HOUR

public static final TimeUnits HOUR

Hour

Field Details

conversionToSeconds

public final double conversionToSeconds

Seconds per unit (conversion l.t. 1 if smaller than a second)

Method Details

values

public static TimeUnits[] 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 TimeUnits 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,
 TimeUnits targetUnit)

Convert from the base unit to the given argument unit

Parameters:

x - double to be converted

targetUnit - target unit

Returns:

x converted to the target units