tec.units.ri.unit

Class TransformedUnit<Q extends javax.measure.Quantity<Q>>

java.lang.Object

tec.units.ri.AbstractUnit<Q>

tec.units.ri.unit.TransformedUnit<Q>

Type Parameters:

Q - The type of the quantity measured by this unit.

All Implemented Interfaces:

Comparable<javax.measure.Unit<Q>>, javax.measure.Unit<Q>, tec.uom.lib.common.function.UnitConverterSupplier

public final class TransformedUnit<Q extends javax.measure.Quantity<Q>>
extends AbstractUnit<Q>
implements tec.uom.lib.common.function.UnitConverterSupplier

This class represents the units derived from other units using converters.

Examples of transformed units: CELSIUS = KELVIN.shift(273.15); FOOT = METRE.multiply(3048).divide(10000); MILLISECOND = MILLI(SECOND);

Transformed units have no symbol. But like all other units, they may have labels attached to them (see UnitFormat.label(Unit, String)

Instances of this class are created through the AbstractUnit.transform(javax.measure.UnitConverter) method.

Version:

0.7, December 28, 2015

Author:

Jean-Marie Dautelle, Werner Keil

Field Summary

Fields inherited from class tec.units.ri.AbstractUnit

name, ONE

Constructor Summary

Constructors

Constructor and Description
TransformedUnit(AbstractUnit<Q> parentUnit, javax.measure.UnitConverter unitConverter) Creates a transformed unit from the specified system unit.
TransformedUnit(String symbol, javax.measure.Unit<Q> parentUnit, javax.measure.UnitConverter unitConverter) Creates a transformed unit from the specified system unit.
TransformedUnit(javax.measure.Unit<Q> parentUnit, javax.measure.UnitConverter toParentUnit) Creates a transformed unit from the specified system unit.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object that)
Map<? extends javax.measure.Unit<?>,Integer>	getBaseUnits()
javax.measure.UnitConverter	getConverter()
javax.measure.Dimension	getDimension()
javax.measure.Unit<Q>	getParentUnit()
String	getSymbol()
javax.measure.UnitConverter	getSystemConverter() Returns the converter from this unit to its unscaled standard unit.
int	hashCode()
AbstractUnit<Q>	toSystemUnit() Returns the unscaled standard (SI) unit from which this unit is derived.

Methods inherited from class tec.units.ri.AbstractUnit

alternate, annotate, asType, compareTo, divide, divide, getConverterTo, getConverterToAny, getName, getSystemUnit, inverse, isCompatible, isSystemUnit, multiply, multiply, multiply, parse, pow, root, setName, setSymbol, shift, toString, transform

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformedUnit

public TransformedUnit(AbstractUnit<Q> parentUnit,
               javax.measure.UnitConverter unitConverter)

Creates a transformed unit from the specified system unit.

Parameters:

parentUnit - the system unit from which this unit is derived.

unitConverter - the converter to the parent units.

Throws:

IllegalArgumentException - if the specified parent unit is not an system unit

TransformedUnit

public TransformedUnit(String symbol,
               javax.measure.Unit<Q> parentUnit,
               javax.measure.UnitConverter unitConverter)

Creates a transformed unit from the specified system unit.

Parameters:

parentUnit - the system unit from which this unit is derived.

unitConverter - the converter to the parent units.

Throws:

IllegalArgumentException - if the specified parent unit is not an system unit

TransformedUnit

public TransformedUnit(javax.measure.Unit<Q> parentUnit,
               javax.measure.UnitConverter toParentUnit)

Creates a transformed unit from the specified system unit.

Parameters:

parentUnit - the system unit from which this unit is derived.

toParentUnit - the converter to the parent units.

Throws:

IllegalArgumentException - if the specified parent unit is not an system unit

ClassCastException - if parentUnit is not a valid Unit implementation

Method Detail

getDimension

public javax.measure.Dimension getDimension()

Specified by:

getDimension in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>

Specified by:

getDimension in class AbstractUnit<Q extends javax.measure.Quantity<Q>>

getSystemConverter

public javax.measure.UnitConverter getSystemConverter()

Description copied from class: AbstractUnit

Returns the converter from this unit to its unscaled standard unit.

Specified by:

getSystemConverter in class AbstractUnit<Q extends javax.measure.Quantity<Q>>

Returns:

getConverterTo(this.toSystemUnit())

See Also:

AbstractUnit.toSystemUnit()

toSystemUnit

public AbstractUnit<Q> toSystemUnit()

Description copied from class: AbstractUnit

Returns the unscaled standard (SI) unit from which this unit is derived. The SI unit can be be used to identify a quantity given the unit. For example: static boolean isAngularVelocity(AbstractUnit unit) { return unit.toSystemUnit().equals(RADIAN.divide(SECOND)); } assert(REVOLUTION.divide(MINUTE).isAngularVelocity()); // Returns true.

Specified by:

toSystemUnit in class AbstractUnit<Q extends javax.measure.Quantity<Q>>

Returns:

the unscaled metric unit from which this unit is derived.

getBaseUnits

public Map<? extends javax.measure.Unit<?>,Integer> getBaseUnits()

Specified by:

getBaseUnits in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>

Specified by:

getBaseUnits in class AbstractUnit<Q extends javax.measure.Quantity<Q>>

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractUnit<Q extends javax.measure.Quantity<Q>>

equals

public boolean equals(Object that)

Specified by:

equals in class AbstractUnit<Q extends javax.measure.Quantity<Q>>

getSymbol

public String getSymbol()

Specified by:

getSymbol in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>

Overrides:

getSymbol in class AbstractUnit<Q extends javax.measure.Quantity<Q>>

getParentUnit

public javax.measure.Unit<Q> getParentUnit()

getConverter

public javax.measure.UnitConverter getConverter()

Specified by:

getConverter in interface tec.uom.lib.common.function.UnitConverterSupplier