All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class pmr.molecule.Unit

java.lang.Object
   |
   +----pmr.molecule.Unit

public class Unit

extends Object

Unit(String, String, UnitDimension)

this constructor should be used for SI units only

Unit(String, String, UnitDimension, double, double)

make unit including conversion factors

to get to SI: siVal = (val - addToSI) * multiplyToSI;

to get from SI: val = siVal / multiplyToSI + addToSI;

This constructor should be used for NON SI units

addSynonym(String)

add a synonym (might be an abbreviation) for a Unit.

convertFromOtherUnit(double, Unit)

convertFromSI(double)

convertFromTo(double, String, String)

convertToSI(double)

getName()

getNames(String)

get the name of all the units of a given type (e.g.

getSIUnit(String)

get the SI unit for a given type

getType()

getUnit(String)

gets a unit by name (e.g.

getUnitDimension()

getUnits()

get an array of all the Units

main(String[])

toString()

  public Unit(String nam,
              String typ,
              UnitDimension d) throws DuplicateUnitException

this constructor should be used for SI units only

Throws: DuplicateUnitException

This Unit has already been defined

  public Unit(String nam,
              String typ,
              UnitDimension d,
              double mult,
              double add) throws DuplicateUnitException

make unit including conversion factors

to get to SI: siVal = (val - addToSI) * multiplyToSI;

to get from SI: val = siVal / multiplyToSI + addToSI;

This constructor should be used for NON SI units

Throws: DuplicateUnitException

This Unit has already been defined

  public void addSynonym(String s) throws DuplicateUnitException

add a synonym (might be an abbreviation) for a Unit. Name MUST be unique through the whole unit space. Duplicate throws an exception

Throws: DuplicateUnitException

This Unit has already been defined

  public static Unit[] getUnits()

get an array of all the Units

  public static Unit getUnit(String name)

gets a unit by name (e.g. "Celsius");

  public String getName()

  public String getType()

  public UnitDimension getUnitDimension()

  public static StringList getNames(String type)

get the name of all the units of a given type (e.g. energy)

  public static Unit getSIUnit(String type)

get the SI unit for a given type

  public String toString()

Overrides:

toString in class Object

  public double convertToSI(double val)

  public double convertFromSI(double val)

  public double convertFromOtherUnit(double val,
                                     Unit otherUnit) throws IncompatibleUnitException

  public static double convertFromTo(double val,
                                     String fromUnit,
                                     String toUnit) throws IncompatibleUnitException

  public static void main(String args[])

All Packages  Class Hierarchy  This Package  Previous  Next  Index