org.sbml.jsbml

Interface Variable

All Superinterfaces:

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

All Known Implementing Classes:

Compartment, Parameter, ProductSpeciesReference, Species, SpeciesReference, Symbol

public interface Variable
extends Quantity, UniqueNamedSBase

A variable of the system is a Quantity whose value may change during a simulation. To decide whether it has to stay constant, this interface provides the necessary methods.

Since:

0.8

Version:

$Rev: 1639 $

Author:

Andreas Dräger, Nicolas Rodriguez

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getConstant()
boolean	isConstant()
boolean	isSetConstant()
void	setConstant(boolean constant) Sets the constant boolean of this Variable.
void	unsetConstant() With this method the constant property of this variable will be set to an undefined state.

Methods inherited from interface org.sbml.jsbml.Quantity

getValue, isSetValue, setValue, unsetValue

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, addPlugin, appendNotes, appendNotes, clone, createPlugin, disablePackage, enablePackage, enablePackage, equals, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, 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, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm, writeXMLAttributes

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

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

Methods inherited from interface javax.swing.tree.TreeNode

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

Method Detail

getConstant

boolean getConstant()

Returns:

the constant boolean of this variable.

isConstant

boolean isConstant()

Returns:

the constant value if it is set, false otherwise.

isSetConstant

boolean isSetConstant()

Returns:

true if the constant boolean of this Variable is not null.

setConstant

void setConstant(boolean constant)

Sets the constant boolean of this Variable.

Parameters:

constant -

Throws:

PropertyNotAvailableException - for inappropriate Level/Version combinations depending on the implementing class.

unsetConstant

void unsetConstant()

With this method the constant property of this variable will be set to an undefined state.