org.jscience.ml.sbml
Class Compartment

java.lang.Object
  org.jscience.ml.sbml.SBase
      org.jscience.ml.sbml.SBaseId
          org.jscience.ml.sbml.Compartment

public class Compartment
extends SBaseId

A bounded container in which species are located.

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

Compartment()
Creates a new instance of Compartment

Compartment(java.lang.String id, java.lang.String name)

Method Summary

java.lang.String	getOutside() Getter for property outside.
java.lang.String	getSize() Setter for property volume.
java.lang.String	getSpatialDimensions() Setter for property volume.
java.lang.String	getUnits() Getter for property units.
boolean	isConstant() Getter for property constant.
void	setConstant(boolean constant) Sets whether the compartment's volume may vary during simulation.
void	setOutside(java.lang.String outside) Setter for property outside.
void	setSize(double size)
void	setSize(java.lang.String size)
void	setSpatialDimensions(java.lang.String value) Setter for property volume.
void	setUnits(java.lang.String units) Setter for property units.
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

Compartment

public Compartment(java.lang.String id,
                   java.lang.String name)

Compartment

public Compartment()

Creates a new instance of Compartment

Method Detail

getOutside

public java.lang.String getOutside()

Getter for property outside.

Returns:

Value of property outside.

getSize

public java.lang.String getSize()

Setter for property volume.

getSpatialDimensions

public java.lang.String getSpatialDimensions()

Setter for property volume.

getUnits

public java.lang.String getUnits()

Getter for property units.

Returns:

Value of property units.

isConstant

public boolean isConstant()

Getter for property constant.

Returns:

Value of property constant.

setConstant

public void setConstant(boolean constant)

Sets whether the compartment's volume may vary during simulation.

Parameters:

constant - New value of property constant.

setOutside

public void setOutside(java.lang.String outside)

Setter for property outside.

Parameters:

outside - New value of property outside.

setSize

public void setSize(double size)

setSize

public void setSize(java.lang.String size)

setSpatialDimensions

public void setSpatialDimensions(java.lang.String value)

Setter for property volume.

Parameters:

volume - New value of property volume.

setUnits

public void setUnits(java.lang.String units)

Setter for property units.

Parameters:

units - New value of property units.

toString

public java.lang.String toString()

Get the SBML representation for this class.

Overrides:

toString in class SBase

Returns:

The class's SBML representation