org.sbml.jsbml

Interface Quantity

All Superinterfaces:

CallableSBase, java.lang.Cloneable, NamedSBase, NamedSBaseWithDerivedUnit, SBase, SBaseWithDerivedUnit, java.io.Serializable, javax.swing.tree.TreeNode, TreeNodeWithChangeSupport

All Known Subinterfaces:

Variable

All Known Implementing Classes:

Compartment, LocalParameter, Parameter, QuantityWithUnit, Species, SpeciesReference, Symbol

public interface Quantity
extends CallableSBase

A quantity is an element that represents a value with an associated unit that can be addressed through the identifier or name attribute of this element. Both the value and the unit may be directly declared by the quantity or may have to be derived.

Since:

0.8

Version:

$Rev: 1639 $

Author:

Andreas Dräger, Nicolas Rodriguez

Method Summary

Methods

Modifier and Type	Method and Description
double	getValue() Returns the value of this Quantity.
boolean	isSetValue() Returns true if the value of this Quantity is set.
void	setValue(double value) Sets the value of this Quantity.
void	unsetValue() Unsets the value of this Quantity.

Methods inherited from interface org.sbml.jsbml.NamedSBase

getId, getName, isIdMandatory, isSetId, isSetName, setId, setName, unsetId, unsetName

Methods inherited from interface org.sbml.jsbml.SBaseWithDerivedUnit

containsUndeclaredUnits, getDerivedUnitDefinition, getDerivedUnits

Methods inherited from interface org.sbml.jsbml.SBase

addCVTerm, addDeclaredNamespace, addExtension, appendNotes, appendNotes, clone, createPlugin, disablePackage, enablePackage, enablePackage, equals, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hashCode, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, readAttribute, registerChild, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregister, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm, writeXMLAttributes

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Method Detail

getValue

double getValue()

Returns the value of this Quantity. In Compartments the value is its size, in Species the value defines its initial amount or concentration, and in Parameters and LocalParameters this returns the value attribute from SBML.

Returns:

the value

isSetValue

boolean isSetValue()

Returns true if the value of this Quantity is set.

Returns:

true if the value of this Quantity is set.

setValue

void setValue(double value)

Sets the value of this Quantity. Note that the meaning of the value can be different in all derived classes. In Compartments the value defines its size. In Species the value describes either the initial amount or the initial concentration. Only the class Parameter and LocalParameter really define a value attribute with this name.

Parameters:

value - the value to set

unsetValue

void unsetValue()

Unsets the value of this Quantity.