org.jscience.ml.sbml
Class Unit

java.lang.Object
  extended by org.jscience.ml.sbml.SBase
      extended by org.jscience.ml.sbml.Unit

public final class Unit
extends SBase

Units of measurement for quantities in an SBML model. A unit is defined by unit = (multiplier * 10^scale * kind^exponent) + offset.

This code is licensed under the DARPA BioCOMP Open Source License. See LICENSE for more details.


Constructor Summary
Unit(Unit kind)
          Creates a new unit.
Unit(Unit kind, double multiplier, int scale, int exponent, double offset)
          Creates a new unit.
 
Method Summary
 int getExponent()
           
 Unit getKind()
           
 java.lang.String getKindName()
           
 double getMultiplier()
           
 double getOffset()
           
 int getScale()
           
 boolean isBaseUnit()
           
 void setExponent(int exponent)
           
 void setKind(Unit kind)
           
 void setMultiplier(double multiplier)
           
 void setOffset(double offset)
           
 void setScale(int scale)
           
 java.lang.String toString()
          The SBML for this element.
 
Methods inherited from class org.jscience.ml.sbml.SBase
getAnnotations, getMetaid, getNotes, getRDF, printList, printShortForm, setMetaid, setRDF, setRDF
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Unit

public Unit(Unit kind)
Creates a new unit. unit = kind.


Unit

public Unit(Unit kind,
            double multiplier,
            int scale,
            int exponent,
            double offset)
Creates a new unit. unit = (multiplier * 10^scale * kind^exponent) + offset

Method Detail

getExponent

public int getExponent()

getKind

public Unit getKind()

getKindName

public java.lang.String getKindName()

getMultiplier

public double getMultiplier()

getOffset

public double getOffset()

getScale

public int getScale()

isBaseUnit

public boolean isBaseUnit()

setExponent

public void setExponent(int exponent)

setKind

public void setKind(Unit kind)

setMultiplier

public void setMultiplier(double multiplier)

setOffset

public void setOffset(double offset)

setScale

public void setScale(int scale)

toString

public java.lang.String toString()
Description copied from class: SBase
The SBML for this element.

Overrides:
toString in class SBase
Returns:
DOCUMENT ME!