org.wpilib.units.DistanceUnit Class Reference

Inheritance diagram for org.wpilib.units.DistanceUnit:

Public Member Functions
DistanceUnit	getBaseUnit ()
LinearVelocityUnit	per (TimeUnit period)
double	convertFrom (double magnitude, DistanceUnit otherUnit)
Distance	of (double magnitude)
Distance	ofBaseUnits (double baseUnitMagnitude)
Distance	zero ()
Distance	one ()
TorqueUnit	multAsTorque (ForceUnit force)
Public Member Functions inherited from org.wpilib.units.Unit
boolean	isBaseUnit ()
double	fromBaseUnits (double valueInBaseUnits)
double	toBaseUnits (double valueInNativeUnits)
UnaryFunction	getConverterToBase ()
UnaryFunction	getConverterFromBase ()
boolean	equivalent (Unit other)
boolean	equals (Object o)
int	hashCode ()
String	name ()
String	symbol ()
String	toString ()

Additional Inherited Members
Protected Member Functions inherited from org.wpilib.units.Unit
	Unit (Unit baseUnit, UnaryFunction toBaseConverter, UnaryFunction fromBaseConverter, String name, String symbol)
	Unit (Unit baseUnit, double baseUnitEquivalent, String name, String symbol)

Detailed Description

Unit of linear dimension.

This is the base type for units of linear dimension. It is also used to specify the dimension for Measure: Measure<DistanceUnit>.

Actual units (such as Units#Meters and Units#Inches) can be found in the Units class.

Definition at line 18 of file DistanceUnit.java.

Member Function Documentation

convertFrom()

double org.wpilib.units.DistanceUnit.convertFrom	(	double	magnitude,
		DistanceUnit	otherUnit )

Converts a measurement value in terms of another distance unit to this unit.

Parameters

magnitude	the magnitude of the measurement in terms of the other distance unit
otherUnit	the other distance unit

Returns

the value of the measurement in terms of this unit

Definition at line 60 of file DistanceUnit.java.

getBaseUnit()

DistanceUnit org.wpilib.units.DistanceUnit.getBaseUnit

(

)

Gets the base unit of measurement that this unit is derived from. If the unit is the base unit, the unit will be returned.

NOTE: Subclasses must override this method to provide the correct return type. Failing to do say will make unit combinations that use it break at runtime!

  Unit baseUnit = new Unit(null, ...);
  baseUnit.getBaseUnit(); // returns baseUnit

  Unit derivedUnit = new Unit(baseUnit, ...);
  derivedUnit.getBaseUnit(); // returns baseUnit

Returns

the base unit

Reimplemented from org.wpilib.units.Unit.

Definition at line 33 of file DistanceUnit.java.

multAsTorque()

TorqueUnit org.wpilib.units.DistanceUnit.multAsTorque

(

ForceUnit

force

)

Multiplies this distance unit by a unit of force to create a unit of torque.

Parameters

force

the unit of force

Returns

the combined torque unit

Definition at line 90 of file DistanceUnit.java.

of()

Distance org.wpilib.units.DistanceUnit.of

(

double

magnitude

)

Creates a new immutable measurement of the given magnitude in terms of this unit. Implementations are strongly recommended to sharpen the return type to a unit-specific measurement implementation.

Parameters

magnitude

the magnitude of the measurement.

Returns

the measurement object

Reimplemented from org.wpilib.units.Unit.

Definition at line 65 of file DistanceUnit.java.

ofBaseUnits()

Distance org.wpilib.units.DistanceUnit.ofBaseUnits

(

double

baseUnitMagnitude

)

Creates a new immutable measurement of the given magnitude in terms of this unit's base unit. Implementations are strongly recommended to sharpen the return type to a unit-specific measurement implementation.

Parameters

baseUnitMagnitude

the magnitude in terms of the base unit

Returns

the measurement object

Reimplemented from org.wpilib.units.Unit.

Definition at line 70 of file DistanceUnit.java.

one()

Distance org.wpilib.units.DistanceUnit.one

(

)

Gets a measure with a magnitude of 1.0 in terms of this unit. The returned object is guaranteed to be of the same type returned by of(double). Subclasses are encouraged to override this method to sharpen the return type.

Returns

a measure of magnitude 1.0 in terms of this unit

Reimplemented from org.wpilib.units.Unit.

Definition at line 80 of file DistanceUnit.java.

per()

LinearVelocityUnit org.wpilib.units.DistanceUnit.per

(

TimeUnit

time

)

Combines this unit with a unit of time. This often - but not always - results in a velocity. Subclasses should sharpen the return type to be unit-specific.

Parameters

time	the unit of time

Returns

the combined unit

Reimplemented from org.wpilib.units.Unit.

Definition at line 38 of file DistanceUnit.java.

zero()

Distance org.wpilib.units.DistanceUnit.zero

(

)

Gets a measure of zero magnitude in terms of this unit. The returned object is guaranteed to be of the same type returned by of(double). Subclasses are encouraged to override this method to sharpen the return type.

Returns

a zero-magnitude measure of this unit

Reimplemented from org.wpilib.units.Unit.

Definition at line 75 of file DistanceUnit.java.

---

The documentation for this class was generated from the following file:

• org/wpilib/units/DistanceUnit.java