org.wpilib.units.VelocityUnit< D extends Unit > Class Template Reference

Inheritance diagram for org.wpilib.units.VelocityUnit< D extends Unit >:

Public Member Functions
VelocityUnit< D >	getBaseUnit ()
D	getUnit ()
TimeUnit	getPeriod ()
Velocity< D >	of (double magnitude)
Velocity< D >	ofBaseUnits (double baseUnitMagnitude)
Velocity< D >	zero ()
Velocity< D >	one ()
AccelerationUnit< D >	per (TimeUnit period)
double	convertFrom (double magnitude, VelocityUnit<? extends D > otherUnit)
Public Member Functions inherited from org.wpilib.units.PerUnit< D, TimeUnit >
PerUnit< N, D >	getBaseUnit ()
N	numerator ()
D	denominator ()
PerUnit< D, N >	reciprocal ()
N	mult (D denom)
Measure<? extends PerUnit< N, D > >	of (double magnitude)
Measure<? extends PerUnit< N, D > >	ofBaseUnits (double baseUnitMagnitude)
final Per< N, D >	ofNative (double magnitude)
final Per< N, D >	ofNativeBaseUnits (double baseUnitMagnitude)
Measure<? extends PerUnit< N, D > >	zero ()
Measure<? extends PerUnit< N, D > >	one ()
Unit	per (TimeUnit time)
double	convertFrom (double magnitude, PerUnit<? extends N, ? extends D > otherUnit)
boolean	equals (Object o)
int	hashCode ()

Static Public Member Functions
static< D extends Unit > VelocityUnit< D >	combine (D unit, TimeUnit period)
Static Public Member Functions inherited from org.wpilib.units.PerUnit< D, TimeUnit >
static< N extends Unit, D extends Unit > PerUnit< N, D >	combine (N numerator, D denominator)

Detailed Description

Unit of velocity dimension that is a combination of a distance unit (numerator) and a time unit (denominator).

This is a generic velocity type for units that do not have discrete velocity units (eg DistanceUnit has LinearVelocityUnit, and so would not use this class).

Parameters

<D>	the unit of the changing quantity, such as VoltageUnit or TemperatureUnit

Definition at line 19 of file VelocityUnit.java.

Member Function Documentation

combine()

static< D extends Unit > VelocityUnit< D > org.wpilib.units.VelocityUnit< D extends Unit >.combine ( D unit, TimeUnit period )

static

Combines a dimension unit and a unit of the period of change to create a unit of velocity.

Parameters

unit	the unit of the changing dimension
period	the unit of the period of change in the velocity
<D>	the unit of the changing dimension

Returns

the combined velocity unit

Definition at line 52 of file VelocityUnit.java.

convertFrom()

double org.wpilib.units.VelocityUnit< D extends Unit >.convertFrom	(	double	magnitude,
		VelocityUnit<? extends D >	otherUnit )

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

Parameters

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

Returns

the value of the measurement in terms of this unit

Definition at line 130 of file VelocityUnit.java.

getBaseUnit()

VelocityUnit< D > org.wpilib.units.VelocityUnit< D extends Unit >.getBaseUnit

(

)

Definition at line 57 of file VelocityUnit.java.

getPeriod()

TimeUnit org.wpilib.units.VelocityUnit< D extends Unit >.getPeriod

(

)

Gets the period unit of the velocity, eg Seconds or Milliseconds.

Returns

the period unit

Definition at line 75 of file VelocityUnit.java.

getUnit()

D org.wpilib.units.VelocityUnit< D extends Unit >.getUnit

(

)

Gets the major unit being measured (eg Meters for Meters per Second).

Returns

the major unit

Definition at line 66 of file VelocityUnit.java.

of()

Velocity< D > org.wpilib.units.VelocityUnit< D extends Unit >.of

(

double

magnitude

)

Definition at line 80 of file VelocityUnit.java.

ofBaseUnits()

Velocity< D > org.wpilib.units.VelocityUnit< D extends Unit >.ofBaseUnits

(

double

baseUnitMagnitude

)

Definition at line 85 of file VelocityUnit.java.

one()

Velocity< D > org.wpilib.units.VelocityUnit< D extends Unit >.one

(

)

Definition at line 97 of file VelocityUnit.java.

per()

AccelerationUnit< D > org.wpilib.units.VelocityUnit< D extends Unit >.per

(

TimeUnit

period

)

Combines this velocity unit with a unit of a period of change to create an acceleration unit.

Parameters

period

the unit of the period of change

Returns

the acceleration unit

Definition at line 108 of file VelocityUnit.java.

zero()

Velocity< D > org.wpilib.units.VelocityUnit< D extends Unit >.zero

(

)

Definition at line 91 of file VelocityUnit.java.

---

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

• org/wpilib/units/VelocityUnit.java