org.jscience.ml.sbml
Class Parameter

java.lang.Object
  extended by org.jscience.ml.sbml.SBase
      extended by org.jscience.ml.sbml.SBaseId
          extended by org.jscience.ml.sbml.Parameter

public class Parameter
extends SBaseId

This class declares a variable for use in MathML structures. This code is licensed under the DARPA BioCOMP Open Source License. See LICENSE for more details.


Field Summary
 
Fields inherited from class org.jscience.ml.sbml.SBaseId
id, name
 
Constructor Summary
Parameter()
          Creates a new instance of Parameter
Parameter(java.lang.String id, java.lang.String name)
          Creates a new Parameter object.
Parameter(java.lang.String id, java.lang.String name, double value)
          Creates a new Parameter object.
 
Method Summary
 java.lang.String getUnits()
          Getter for property units.
 double getValue()
          Getter for property value.
 boolean isConstant()
          Getter for property constant.
 void setConstant(boolean constant)
          Sets whether the parameter's value is constant throughout a simulation.
 void setUnits(java.lang.String units)
          Setter for property units.
 void setValue(double value)
          Setter for property value.
 java.lang.String toString()
          Get the SBML representation for this class.
 
Methods inherited from class org.jscience.ml.sbml.SBaseId
getId, getName, setId, setName
 
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

Parameter

public Parameter(java.lang.String id,
                 java.lang.String name,
                 double value)
Creates a new Parameter object.

Parameters:
id - DOCUMENT ME!
name - DOCUMENT ME!
value - DOCUMENT ME!

Parameter

public Parameter(java.lang.String id,
                 java.lang.String name)
Creates a new Parameter object.

Parameters:
id - DOCUMENT ME!
name - DOCUMENT ME!

Parameter

public Parameter()
Creates a new instance of Parameter

Method Detail

getUnits

public java.lang.String getUnits()
Getter for property units.

Returns:
Value of property units.

getValue

public double getValue()
Getter for property value.

Returns:
Value of property value.

isConstant

public boolean isConstant()
Getter for property constant.

Returns:
Value of property constant.

setConstant

public void setConstant(boolean constant)
Sets whether the parameter's value is constant throughout a simulation.

Parameters:
constant - New value of property constant.

setUnits

public void setUnits(java.lang.String units)
Setter for property units.

Parameters:
units - New value of property units.

setValue

public void setValue(double value)
Setter for property value.

Parameters:
value - New value of property value.

toString

public java.lang.String toString()
Get the SBML representation for this class.

Overrides:
toString in class SBase
Returns:
The class's SBML representation