manifold.science.api

Interface Unit<D extends Dimension<D>,U extends Unit<D,U>>

Type Parameters:

D - The Dimension type expressed using this unit type

U - This type (recursive to enforce type-safety).

All Superinterfaces:

Comparable<U>, manifold.ext.rt.api.ComparableUsing<U>, Dimension<U>, Serializable

All Known Implementing Classes:

AbstractBinaryUnit, AbstractPrimaryUnit, AbstractProductUnit, AbstractQuotientUnit, AccelerationUnit, AngleUnit, AreaUnit, CapacitanceUnit, ChargeUnit, ConductanceUnit, CurrentUnit, DensityUnit, EnergyUnit, ForceUnit, FrequencyUnit, HeatCapacityUnit, InductanceUnit, LengthUnit, MagneticFluxDensityUnit, MagneticFluxUnit, MassUnit, MomentumUnit, PotentialUnit, PowerUnit, PressureUnit, ResistanceUnit, SolidAngleUnit, StorageCapacityUnit, TemperatureUnit, TimeUnit, VelocityUnit, VolumeUnit

public interface Unit<D extends Dimension<D>,U extends Unit<D,U>>
extends Dimension<U>

Unit provides a base abstraction for postfix unit types such as length, time, mass, and velocity.

Nested Class Summary

Nested classes/interfaces inherited from interface manifold.ext.rt.api.ComparableUsing

manifold.ext.rt.api.ComparableUsing.EqualityMode, manifold.ext.rt.api.ComparableUsing.Operator

Method Summary

Modifier and Type	Method and Description
default int	compareTo(U o)
default U	copy(Rational value) Given a value produce a copy of this dimension with the given value
Rational	from(D dim)
default U	fromNumber(Rational n)
default String	getFullName()
default String	getFullSymbol()
String	getName()
String	getSymbol()
D	makeDimension(Number amount)
default D	postfixBind(Number amount)
Rational	toBaseUnits(Rational theseUnits)

Methods inherited from interface manifold.science.api.Dimension

div, div, minus, plus, rem, rem, times, toBaseNumber, toNumber, unaryMinus

Methods inherited from interface manifold.ext.rt.api.ComparableUsing

compareToUsing, equalityMode

Method Detail

getName

String getName()

Returns:

The name of this unit, such as "Meter" or "Pound".

getSymbol

String getSymbol()

Returns:

The symbol for this unit. For example, SI units define "Meter" to have symbol "m".

toBaseUnits

Rational toBaseUnits(Rational theseUnits)

Parameters:

theseUnits - A magnitude of these units to convert to base units.

Returns:

The theseUnits converted to the base units of this unit type.

from

Rational from(D dim)

makeDimension

D makeDimension(Number amount)

copy

default U copy(Rational value)

Description copied from interface: Dimension

Given a value produce a copy of this dimension with the given value

Specified by:

copy in interface Dimension<U extends Unit<D,U>>

getFullName

default String getFullName()

getFullSymbol

default String getFullSymbol()

postfixBind

default D postfixBind(Number amount)

fromNumber

default U fromNumber(Rational n)

Specified by:

fromNumber in interface Dimension<U extends Unit<D,U>>

Returns:

a separate instance of this type with the given value.

compareTo

default int compareTo(U o)

Specified by:

compareTo in interface Comparable<U extends Unit<D,U>>