org.wpilib.units.EnergyUnit Class Reference

Inheritance diagram for org.wpilib.units.EnergyUnit:

Public Member Functions
EnergyUnit	getBaseUnit ()
PowerUnit	per (TimeUnit period)
double	convertFrom (double magnitude, EnergyUnit otherUnit)
Energy	of (double magnitude)
Energy	ofBaseUnits (double baseUnitMagnitude)
Energy	zero ()
Energy	one ()
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 energy dimension.

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

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

Definition at line 18 of file EnergyUnit.java.

Member Function Documentation

convertFrom()

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

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

Parameters

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

Returns

the value of the measurement in terms of this unit

Definition at line 66 of file EnergyUnit.java.

getBaseUnit()

EnergyUnit org.wpilib.units.EnergyUnit.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 EnergyUnit.java.

of()

Energy org.wpilib.units.EnergyUnit.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 71 of file EnergyUnit.java.

ofBaseUnits()

Energy org.wpilib.units.EnergyUnit.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 76 of file EnergyUnit.java.

one()

Energy org.wpilib.units.EnergyUnit.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 86 of file EnergyUnit.java.

per()

PowerUnit org.wpilib.units.EnergyUnit.per

(

TimeUnit

period

)

Combines this unit of energy with a unit of time to create a unit of power.

Parameters

period

the period of the change in energy

Returns

the combined unit of power

Reimplemented from org.wpilib.units.Unit.

Definition at line 44 of file EnergyUnit.java.

zero()

Energy org.wpilib.units.EnergyUnit.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 81 of file EnergyUnit.java.

---

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

• org/wpilib/units/EnergyUnit.java