manifold.science.api

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

java.lang.Object

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

manifold.science.api.AbstractQuotientUnit<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 unit type

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

All Implemented Interfaces:

Serializable, Comparable<U>, ComparableUsing<U>, Dimension<U>, Unit<D,U>

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

Represents a binary quotient of unit types of measure such as VelocityUnit which is the quotient of LengthUnit and TimeUnit.

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	AbstractQuotientUnit(A leftUnit, B rightUnit)
protected	AbstractQuotientUnit(A leftUnit, B rightUnit, manifold.science.util.Rational factor)
protected	AbstractQuotientUnit(A leftUnit, B rightUnit, manifold.science.util.Rational factor, String name)
protected	AbstractQuotientUnit(A leftUnit, B rightUnit, manifold.science.util.Rational factor, String name, String symbol)

Method Summary

Modifier and Type	Method and Description
String	getFullName()
String	getFullSymbol()
String	getName()
String	getSymbol()
A	times(B a)
manifold.science.util.Rational	toBaseUnits(manifold.science.util.Rational myUnits)
manifold.science.util.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, 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

AbstractQuotientUnit

protected AbstractQuotientUnit(A leftUnit,
                               B rightUnit)

AbstractQuotientUnit

protected AbstractQuotientUnit(A leftUnit,
                               B rightUnit,
                               manifold.science.util.Rational factor)

AbstractQuotientUnit

protected AbstractQuotientUnit(A leftUnit,
                               B rightUnit,
                               manifold.science.util.Rational factor,
                               String name)

AbstractQuotientUnit

protected AbstractQuotientUnit(A leftUnit,
                               B rightUnit,
                               manifold.science.util.Rational factor,
                               String name,
                               String symbol)

Method Detail

getName

public String getName()

Specified by:

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

Overrides:

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

Returns:

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

getSymbol

public String getSymbol()

Specified by:

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

Overrides:

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

Returns:

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

getFullName

public String getFullName()

getFullSymbol

public String getFullSymbol()

toBaseUnits

public manifold.science.util.Rational toBaseUnits(manifold.science.util.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 manifold.science.util.Rational toNumber()

Returns:

the value for this dimension instance.

times

public A times(B a)