public abstract class Symbol extends QuantityWithUnit implements Variable
Compartment, Species, Parameter. A
symbol is a Variable of the system that declares a unit and a value,
i.e., neither its Unit or UnitDefinition, nor its value are
derived. A Symbol defines both fields. Furthermore, a Symbol may vary through
a simulation and can be accessed within the model through its identifier and
name attributes.| Modifier and Type | Field and Description |
|---|---|
protected java.lang.Boolean |
constant
The constant attribute of this variable.
|
protected boolean |
isSetConstant |
private static long |
serialVersionUID
Generated serial version identifier.
|
valueunitsIDignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, lv, packageNamelistOfListeners, parent, resourceBundle| Constructor and Description |
|---|
Symbol()
Creates a Symbol instance.
|
Symbol(int level,
int version)
Creates a Symbol instance from a level and version.
|
Symbol(QuantityWithUnit quantity)
Creates a Symbol instance.
|
Symbol(java.lang.String id)
Creates a Symbol instance.
|
Symbol(java.lang.String id,
int level,
int version)
Creates a Symbol instance from an id, level and version.
|
Symbol(java.lang.String id,
java.lang.String name,
int level,
int version)
Creates a Symbol instance from an id, name, level and version.
|
Symbol(Symbol nsb)
Creates a Symbol instance from a given Symbol.
|
| Modifier and Type | Method and Description |
|---|---|
abstract Symbol |
clone()
Creates a deep copy of this object, i.e., a new
SBase with the same
properties
like this one. |
boolean |
equals(java.lang.Object o)
|
boolean |
getConstant() |
int |
hashCode()
Returns a hash code value for this
SBase instance. |
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.
|
getValue, isIdMandatory, isSetValue, setValue, unsetValuecontainsUndeclaredUnits, getDerivedUnitDefinition, getDerivedUnits, getPredefinedUnitID, getUnits, getUnitsInstance, isPredefinedUnitsID, isSetUnits, isSetUnitsInstance, setUnits, setUnits, setUnits, setUnits, unsetUnitsisValidIdaddCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkIdentifier, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, readAttribute, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setLevelAndVersion, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageNamespaceAndVersion, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm, writeXMLAttributesaddAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySetfinalize, getClass, notify, notifyAll, wait, wait, waitgetValue, isSetValue, setValue, unsetValuegetId, getName, isIdMandatory, isSetId, isSetName, setId, setName, unsetId, unsetNamecontainsUndeclaredUnits, getDerivedUnitDefinition, getDerivedUnitsaddCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, readAttribute, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm, writeXMLAttributesaddAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySetprivate static final long serialVersionUID
protected java.lang.Boolean constant
protected boolean isSetConstant
public Symbol()
null.public Symbol(int level,
int version)
null.level - the SBML levelversion - the SBML versionpublic Symbol(QuantityWithUnit quantity)
quantity - public Symbol(java.lang.String id)
id - public Symbol(java.lang.String id,
int level,
int version)
null.id - level - version - public Symbol(java.lang.String id,
java.lang.String name,
int level,
int version)
null.id - name - level - version - public Symbol(Symbol nsb)
nsb - public abstract Symbol clone()
SBaseSBase with the same
properties
like this one.clone in interface SBaseclone in class QuantityWithUnitpublic boolean equals(java.lang.Object o)
SBasepublic boolean getConstant()
getConstant in interface Variablepublic int hashCode()
SBaseSBase instance.hashCode in interface SBasehashCode in class QuantityWithUnitSBase instance.Object.hashCode()public boolean isConstant()
isConstant in interface Variablefalse otherwise.public boolean isSetConstant()
isSetConstant in interface Variabletrue if the constant boolean of this Variable is not null.public void setConstant(boolean constant)
VariablesetConstant in interface Variablepublic void unsetConstant()
VariableunsetConstant in interface Variable