manifold.science.api

Class AbstractMeasure<U extends Unit<T,U>,T extends AbstractMeasure<U,T>>

java.lang.Object

manifold.science.api.AbstractMeasure<U,T>

Type Parameters:

U - The unit corresponding with the type e.g., Length specifies LengthUnit.

T - This type. Note this type is recursive to enforce type-safety, normally the complicated generics are not exposed to users of the library e.g., see the Length measure.

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<T>, Sequential<T,Rational,U>, ComparableUsing<T>, Dimension<T>

Direct Known Subclasses:

Acceleration, Angle, Area, Capacitance, Charge, Conductance, Current, Density, Energy, Force, Frequency, HeatCapacity, Inductance, Length, MagneticFlux, MagneticFluxDensity, Mass, Momentum, Potential, Power, Pressure, Resistance, SolidAngle, StorageCapacity, Temperature, Time, Velocity, Volume

public abstract class AbstractMeasure<U extends Unit<T,U>,T extends AbstractMeasure<U,T>>
extends java.lang.Object
implements Dimension<T>, Sequential<T,Rational,U>

This class serves as the base class for a measured quantity. See Length, Velocity, Mass, etc. for examples.

Instances of this class store the value (or magnitude) of the measure in terms of base units. Thus all arithmetic on measures is performed using Base units, which permits measures of differing input units to work in calculations. A measure instance also maintains a "display unit", which is used for display purposes and for working with other systems requiring specific units.

See Also:

Serialized Form

Nested Class Summary

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

ComparableUsing.EqualityMode, ComparableUsing.Operator

Constructor Summary

Constructors

Constructor and Description
AbstractMeasure(Rational value, U unit, U displayUnit)

Method Summary

Modifier and Type	Method and Description
int	compareTo(T that)
T	copy(Rational value) Given a value produce a copy of this dimension with the given value
T	copy(U dsiplayUnit) Copies this instance with a new display unit.
Rational	div(T operand)
ComparableUsing.EqualityMode	equalityMode() Use #compareTo(T) to implement the == operator as it does not take into account the _displayUnit which is inconsequential wrt the measure.
boolean	equals(java.lang.Object o)
T	fromBaseNumber(Rational p0)
T	fromNumber(Rational p0)
abstract U	getBaseUnit() The unit on which all instances of this type are based.
U	getDisplayUnit()
Rational	getValue()
int	hashCode()
abstract T	make(Rational value, U unit) Creates a new instance using the specified parameters.
abstract T	make(Rational value, U unit, U displayUnit) Creates a new instance using the specified parameters.
T	minus(T operand)
T	nextInSequence(Rational step, U unit)
T	nextNthInSequence(Rational step, U unit, int index)
T	plus(T operand)
T	previousInSequence(Rational step, U unit)
T	previousNthInSequence(Rational step, U unit, int index)
Rational	rem(T operand)
T	to(U displayUnit) Copy this measure using the specified displayUnit.
Rational	toBaseNumber()
java.lang.String	toMixedString()
Rational	toNumber()
Rational	toNumber(U unit) Get the magnitude of this measure in terms of the specified unit.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, jailbreak, notify, notifyAll, wait, wait, wait

Methods inherited from interface manifold.science.api.Dimension

div, rem, times, unaryMinus

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

compareToUsing

Constructor Detail

AbstractMeasure

public AbstractMeasure(Rational value,
                       U unit,
                       U displayUnit)

Parameters:

value - The value (or magnitude) of this measure instance

unit - The unit corresponding to the provided value

displayUnit - The unit in which to display this measure

Method Detail

getBaseUnit

public abstract U getBaseUnit()

The unit on which all instances of this type are based. For instance, a Length dimension might use Meters as the base unit because it is the SI standard.

make

public abstract T make(Rational value,
                       U unit,
                       U displayUnit)

Creates a new instance using the specified parameters.

make

public abstract T make(Rational value,
                       U unit)

Creates a new instance using the specified parameters.

copy

public T copy(U dsiplayUnit)

Copies this instance with a new display unit.

copy

public T 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<T extends AbstractMeasure<U,T>>

getValue

public Rational getValue()

Returns:

The value of this measure in Base units.

getDisplayUnit

public U getDisplayUnit()

Returns:

The unit in which this measure displays.

fromNumber

public T fromNumber(Rational p0)

Specified by:

fromNumber in interface Dimension<T extends AbstractMeasure<U,T>>

Returns:

a separate instance of this type with the given value.

fromBaseNumber

public T fromBaseNumber(Rational p0)

toNumber

public Rational toNumber()

Specified by:

toNumber in interface Dimension<T extends AbstractMeasure<U,T>>

Returns:

The magnitude of this measure in terms of Display units.

toBaseNumber

public Rational toBaseNumber()

Specified by:

toBaseNumber in interface Dimension<T extends AbstractMeasure<U,T>>

Returns:

The magnitude of this measure in terms of Base units.

to

public T to(U displayUnit)

Copy this measure using the specified displayUnit.

toNumber

public Rational toNumber(U unit)

Get the magnitude of this measure in terms of the specified unit.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toMixedString

public java.lang.String toMixedString()

Returns:

The measure as a mixed fraction such as "2 1/8 kg"

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equalityMode

public ComparableUsing.EqualityMode equalityMode()

Use #compareTo(T) to implement the == operator as it does not take into account the _displayUnit which is inconsequential wrt the measure.

Specified by:

equalityMode in interface ComparableUsing<T extends AbstractMeasure<U,T>>

compareTo

public int compareTo(T that)

Specified by:

compareTo in interface java.lang.Comparable<T extends AbstractMeasure<U,T>>

nextInSequence

public T nextInSequence(Rational step,
                        U unit)

Specified by:

nextInSequence in interface Sequential<T extends AbstractMeasure<U,T>,Rational,U extends Unit<T,U>>

nextNthInSequence

public T nextNthInSequence(Rational step,
                           U unit,
                           int index)

Specified by:

nextNthInSequence in interface Sequential<T extends AbstractMeasure<U,T>,Rational,U extends Unit<T,U>>

previousInSequence

public T previousInSequence(Rational step,
                            U unit)

Specified by:

previousInSequence in interface Sequential<T extends AbstractMeasure<U,T>,Rational,U extends Unit<T,U>>

previousNthInSequence

public T previousNthInSequence(Rational step,
                               U unit,
                               int index)

Specified by:

previousNthInSequence in interface Sequential<T extends AbstractMeasure<U,T>,Rational,U extends Unit<T,U>>

plus

public T plus(T operand)

Specified by:

plus in interface Dimension<T extends AbstractMeasure<U,T>>

minus

public T minus(T operand)

Specified by:

minus in interface Dimension<T extends AbstractMeasure<U,T>>

div

public Rational div(T operand)

Specified by:

div in interface Dimension<T extends AbstractMeasure<U,T>>

rem

public Rational rem(T operand)

Specified by:

rem in interface Dimension<T extends AbstractMeasure<U,T>>