no.petroware.uom

Class Unit

java.lang.Object

no.petroware.uom.Unit

public final class Unit
extends Object

Model a unit, such as "ft", "m", "N", "Hz", "m/s" etc., and how values converts to the base unit of the same quantity.

This class is immutable.

Author:

Petroware AS

Constructor Summary

Constructors

Constructor and Description
Unit(String name, String symbol, double a, double b, double c, double d) Create a new unit.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
double	fromBase(double baseValue) Convert the specified value given in base unit to this unit.
String	getName() Return name of this unit.
String	getSymbol() Return symbol of this unit.
int	hashCode()
double	toBase(double value) Convert the specified value to base unit in the quantity of this unit.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Unit

public Unit(String name,
            String symbol,
            double a,
            double b,
            double c,
            double d)

Create a new unit.

The conversion consists of four factors that are applied as follows when value is to be converted to base unit:

    base = (a * value + b) / (c * value + d);
 

For most conversion only a is needed. In these cases b, c and d should be set to 0.0, 0.0 and 1.0 respectively. For units like temperature a shift (b) is used as well, while c and d is in practice never used.

Parameters:

name - Name of unit such as "meter". Non-null.

symbol - Symbol of unit such as "m". Non-null.

a - Conversion factor a for converting to base unit.

b - Conversion factor b for converting to base unit.

c - Conversion factor c for converting to base unit.

d - Conversion factor d for converting to base unit.

Throws:

IllegalArgumentException - If name or symbol is null.

Method Detail

getName

public String getName()

Return name of this unit.

Returns:

Name of this unit. Never null.

getSymbol

public String getSymbol()

Return symbol of this unit.

Returns:

Symbol of this unit. Never null.

toBase

public double toBase(double value)

Convert the specified value to base unit in the quantity of this unit.

Parameters:

value - Value to convert.

Returns:

Value converted to base unit.

fromBase

public double fromBase(double baseValue)

Convert the specified value given in base unit to this unit.

Parameters:

baseValue - Base value to convert.

Returns:

Value converted to this unit.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object