manifold.science.api

Class AbstractProductUnit<A extends Unit,B extends Unit,D extends Dimension<D>,U extends AbstractProductUnit<A,B,D,U>>

java.lang.Object

manifold.science.api.AbstractBinaryUnit<A,B,D,U>

manifold.science.api.AbstractProductUnit<A,B,D,U>

Type Parameters:

A - The unit type on the left hand side

B - The unit type on the right hand side

D - The Dimension type expressed using this binary product of unit types

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<U>, ComparableUsing<U>, Dimension<U>, Unit<D,U>

Direct Known Subclasses:

AreaUnit, EnergyUnit, ForceUnit, InductanceUnit, MomentumUnit, VolumeUnit

public abstract class AbstractProductUnit<A extends Unit,B extends Unit,D extends Dimension<D>,U extends AbstractProductUnit<A,B,D,U>>
extends AbstractBinaryUnit<A,B,D,U>

Represents a binary product of unit types of measure such as Area which is the product of two LengthUnits.

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

Modifier	Constructor and Description
protected	AbstractProductUnit(A leftUnit, B rightUnit)
protected	AbstractProductUnit(A leftUnit, B rightUnit, Rational factor)
protected	AbstractProductUnit(A leftUnit, B rightUnit, Rational factor, java.lang.String name)
protected	AbstractProductUnit(A leftUnit, B rightUnit, Rational factor, java.lang.String name, java.lang.String symbol)

Method Summary

Modifier and Type	Method and Description
B	div(A a)
java.lang.String	getFullName()
java.lang.String	getFullSymbol()
java.lang.String	getName()
java.lang.String	getSymbol()
Rational	toBaseUnits(Rational myUnits)
Rational	toNumber()

Methods inherited from class manifold.science.api.AbstractBinaryUnit

equals, from, getFactor, getLeftUnit, getRightUnit, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface manifold.science.api.Unit

compareTo, copy, fromNumber, makeDimension, postfixBind

Methods inherited from interface manifold.science.api.Dimension

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

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

compareToUsing, equalityMode

Constructor Detail

AbstractProductUnit

protected AbstractProductUnit(A leftUnit,
                              B rightUnit)

AbstractProductUnit

protected AbstractProductUnit(A leftUnit,
                              B rightUnit,
                              Rational factor)

AbstractProductUnit

protected AbstractProductUnit(A leftUnit,
                              B rightUnit,
                              Rational factor,
                              java.lang.String name)

AbstractProductUnit

protected AbstractProductUnit(A leftUnit,
                              B rightUnit,
                              Rational factor,
                              java.lang.String name,
                              java.lang.String symbol)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface Unit<D extends Dimension<D>,U extends AbstractProductUnit<A,B,D,U>>

Overrides:

getName in class AbstractBinaryUnit<A extends Unit,B extends Unit,D extends Dimension<D>,U extends AbstractProductUnit<A,B,D,U>>

Returns:

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

getSymbol

public java.lang.String getSymbol()

Specified by:

getSymbol in interface Unit<D extends Dimension<D>,U extends AbstractProductUnit<A,B,D,U>>

Overrides:

getSymbol in class AbstractBinaryUnit<A extends Unit,B extends Unit,D extends Dimension<D>,U extends AbstractProductUnit<A,B,D,U>>

Returns:

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

getFullName

public java.lang.String getFullName()

getFullSymbol

public java.lang.String getFullSymbol()

toBaseUnits

public Rational toBaseUnits(Rational myUnits)

Parameters:

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

Returns:

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

toNumber

public Rational toNumber()

Returns:

the value for this dimension instance.

div

public B div(A a)