|
libSBML Python API
5.18.0
|
|
libSBML Python API
5.18.0
|
The SBML unit definition facility uses two classes of objects, UnitDefinition and Unit. The approach to defining units in SBML is compositional; for example, meter second –2 is constructed by combining a Unit object representing meter with another Unit object representing second –2. The combination is wrapped inside a UnitDefinition, which provides for assigning an identifier and optional name to the combination. The identifier can then be referenced from elsewhere in a model. Thus, the UnitDefinition class is the container, and Unit instances are placed inside UnitDefinition instances.
A Unit has four attributes named 'kind', 'exponent', 'scale' and 'multiplier'. It represents a (possibly transformed) reference to a base unit. The attribute 'kind' on Unit indicates the chosen base unit. Its value must be one of the text strings listed below; this list corresponds to SBML Level 3:
| ampere | farad | joule | lux | radian | volt |
| avogadro | gram | katal | metre | second | watt |
| becquerel | gray | kelvin | mole | siemens | weber |
| candela | henry | kilogram | newton | sievert | |
| coulomb | hertz | litre | ohm | steradian | |
| dimensionless | item | lumen | pascal | tesla |
A few small differences exist between the Level 3 list of base units and the list defined in other Level/Version combinations of SBML. Specifically, Levels of SBML before Level 3 do not define avogadro; conversely, Level 2 Version 1 defines Celsius, and Level 1 defines celsius, meter, and liter, none of which are available in Level 3. In libSBML, each of the predefined base unit names is represented by an enumeration value whose name begins with the characters UNIT_KIND_, discussed in a separate section below.
The attribute named 'exponent' on Unit represents an exponent on the unit. In SBML Level 2, the attribute is optional and has a default value of 1 (one); in SBML Level 3, the attribute is mandatory and there is no default value. A Unit also has an attribute called 'scale'; its value must be an integer exponent for a power-of-ten multiplier used to set the scale of the unit. For example, a unit having a 'kind' value of gram and a 'scale' value of -3 signifies 10 –3 * gram, or milligrams. In SBML Level 2, the attribute is optional and has a default value of 0 (zero), because 10 0 = 1; in SBML Level 3, the attribute is mandatory and has no default value. Lastly, the attribute named 'multiplier' can be used to multiply the unit by a real-numbered factor; this enables the definition of units that are not power-of-ten multiples of SI units. For instance, a multiplier of 0.3048 could be used to define foot as a measure of length in terms of a metre. The 'multiplier' attribute is optional in SBML Level 2, where it has a default value of 1 (one); in SBML Level 3, the attribute is mandatory and has no default value.
As discussed above, SBML defines a set of base units which serves as the starting point for new unit definitions. This set of base units consists of the SI units and a small number of additional convenience units.
In SBML Level 2 Versions before Version 3, there existed an enumeration of units called UnitKind. In Version 3, this enumeration was removed and the identifier class UnitSId redefined to include the previous UnitKind values as reserved symbols. This change has no net effect on permissible models, their representation or their syntax. The purpose of the change in the SBML specification was simply to clean up an inconsistency about the contexts in which these values were usable. However, libSBML maintains UnitKind in the form of of a set of static integer constants whose names begin with the characters UNIT_KIND_. These constants are defined in the class libsbml.
As a consequence of the fact that libSBML supports models in all Levels and Versions of SBML, libSBML's set of UNIT_KIND_ values is a union of all the possible base unit names defined in the different SBML specifications. However, not every base unit is allowed in every Level+Version combination of SBML. Note in particular the following exceptions:
The alternate spelling 'meter' is included in addition to the official SI spelling 'metre'. This spelling is only permitted in SBML Level 1 models.
The alternate spelling 'liter' is included in addition to the official SI spelling 'litre'. This spelling is only permitted in SBML Level 1 models.
The unit 'Celsius' is included because of its presence in specifications of SBML prior to SBML Level 2 Version 2.
avogadro was introduced in SBML Level 3, and is only permitted for use in SBML Level 3 models. The table below lists the unit constants defined in libSBML, and their meanings.
| Enumerator | Meaning |
|---|---|
UNIT_KIND_AMPERE | The ampere unit. |
UNIT_KIND_AVOGADRO | The unit
dimensionless multiplied by the numerical value of Avogadro's
constant. (Only usable in SBML Level 3 models.) |
UNIT_KIND_BECQUEREL | The becquerel unit. |
UNIT_KIND_CANDELA | The candela unit. |
UNIT_KIND_CELSIUS | The Celsius unit. (Only usable in SBML Level 1 and SBML Level 2 Version 1 models.) |
UNIT_KIND_COULOMB | The coulomb unit. |
UNIT_KIND_DIMENSIONLESS | A pseudo-unit indicating a dimensionless quantity. |
UNIT_KIND_FARAD | The farad unit. |
UNIT_KIND_GRAM | The gram unit. |
UNIT_KIND_GRAY | The gray unit. |
UNIT_KIND_HENRY | The henry unit. |
UNIT_KIND_HERTZ | The hertz unit. |
UNIT_KIND_ITEM | A pseudo-unit representing a single "thing". |
UNIT_KIND_JOULE | The joule unit. |
UNIT_KIND_KATAL | The katal unit. |
UNIT_KIND_KELVIN | The kelvin unit. |
UNIT_KIND_KILOGRAM | The kilogram unit. |
UNIT_KIND_LITER | Alternate spelling of litre. |
UNIT_KIND_LITRE | The litre unit. |
UNIT_KIND_LUMEN | The lumen unit. |
UNIT_KIND_LUX | The lux unit. |
UNIT_KIND_METER | Alternate spelling of metre. |
UNIT_KIND_METRE | The metre unit. |
UNIT_KIND_MOLE | The mole unit. |
UNIT_KIND_NEWTON | The newton unit. |
UNIT_KIND_OHM | The ohm unit. |
UNIT_KIND_PASCAL | The pascal unit. |
UNIT_KIND_RADIAN | The radian unit. |
UNIT_KIND_SECOND | The second unit. |
UNIT_KIND_SIEMENS | The siemens unit. |
UNIT_KIND_SIEVERT | The sievert unit. |
UNIT_KIND_STERADIAN | The steradian unit. |
UNIT_KIND_TESLA | The tesla unit. |
UNIT_KIND_VOLT | The volt unit. |
UNIT_KIND_WATT | The watt unit. |
UNIT_KIND_WEBER | The weber unit. |
UNIT_KIND_INVALID | Marker used by libSBML to indicate an invalid or unset unit. |
Public Member Functions | |
| def | __init__ (self, args) |
| This method has multiple variants; they differ in the arguments they accept. More... | |
| def | addCVTerm (self, term, newBag=False) |
| Adds a copy of the given CVTerm object to this SBML object. More... | |
| def | appendAnnotation (self, args) |
| This method has multiple variants; they differ in the arguments they accept. More... | |
| def | appendNotes (self, args) |
| This method has multiple variants; they differ in the arguments they accept. More... | |
| def | areEquivalent (unit1, unit2) |
Predicate returning True if Unit objects are equivalent. More... | |
| def | areIdentical (unit1, unit2) |
Predicate returning True if two Unit objects are identical. More... | |
| def | clone (self) |
| Creates and returns a deep copy of this Unit object. More... | |
| def | connectToChild (self) |
| def | convertToSI (unit) |
Returns a UnitDefinition object containing the given unit converted to the appropriate SI unit. More... | |
| def | deleteDisabledPlugins (self, recursive=True) |
| Deletes all information stored in disabled plugins. More... | |
| def | disablePackage (self, pkgURI, pkgPrefix) |
| Disables the given SBML Level 3 package on this object. More... | |
| def | enablePackage (self, pkgURI, pkgPrefix, flag) |
| Enables or disables the given SBML Level 3 package on this object. More... | |
| def | getAncestorOfType (self, args) |
| This method has multiple variants; they differ in the arguments they accept. More... | |
| def | getAnnotation (self, args) |
| Returns the content of the 'annotation' subelement of this object as a tree of XMLNode objects. More... | |
| def | getAnnotationString (self, args) |
| Returns the content of the 'annotation' subelement of this object as a character string. More... | |
| def | getColumn (self) |
| Returns the column number where this object first appears in the XML representation of the SBML document. More... | |
| def | getCVTerm (self, n) |
| Returns the nth CVTerm in the list of CVTerms of this SBML object. More... | |
| def | getCVTerms (self, args) |
| Returns a list of CVTerm objects in the annotations of this SBML object. More... | |
| def | getDisabledPlugin (self, args) |
| Returns the nth disabled plug-in object (extension interface) for an SBML Level 3 package extension. More... | |
| def | getElementByMetaId (self, args) |
Returns the first child element it can find with a specific 'metaid' attribute value, or None if no such object is found. More... | |
| def | getElementBySId (self, args) |
Returns the first child element found that has the given id in the model-wide SId namespace, or None if no such object is found. More... | |
| def | getElementName (self) |
Returns the XML element name of this object, which for Unit, is always 'unit'. More... | |
| def | getExponent (self) |
| Returns the value of the 'exponent' attribute of this unit. More... | |
| def | getExponentAsDouble (self) |
| Returns the value of the 'exponent' attribute of this unit. More... | |
| def | getId (self) |
| Returns the value of the 'id' attribute of this SBML object, if it has one, or the 'variable' attribute of a Rule, or the 'symbol' attribute of an InitialAssignment. More... | |
| def | getIdAttribute (self) |
| Returns the value of the 'id' attribute of this SBML object. More... | |
| def | getKind (self) |
| Returns the 'kind' of Unit this is. More... | |
| def | getLevel (self) |
| Returns the SBML Level of the SBMLDocument object containing this object. More... | |
| def | getLine (self) |
| Returns the line number where this object first appears in the XML representation of the SBML document. More... | |
| def | getListOfAllElements (self, filter=None) |
| Returns an SBaseList of all child SBase objects, including those nested to an arbitrary depth. More... | |
| def | getListOfAllElementsFromPlugins (self, filter=None) |
| Returns a List of all child SBase objects contained in SBML package plug-ins. More... | |
| def | getMetaId (self) |
| Returns the value of the 'metaid' attribute of this SBML object. More... | |
| def | getModel (self) |
| Returns the Model object for the SBML Document in which the current object is located. More... | |
| def | getModelHistory (self, args) |
| Returns the ModelHistory object, if any, attached to this object. More... | |
| def | getMultiplier (self) |
| Returns the value of the 'multiplier' attribute of this Unit. More... | |
| def | getName (self) |
| Returns the value of the 'name' attribute of this SBML object. More... | |
| def | getNamespaces (self) |
| Returns a list of the XML Namespaces declared on the SBML document owning this object. More... | |
| def | getNotes (self, args) |
| Returns the content of the 'notes' subelement of this object as a tree of XMLNode objects. More... | |
| def | getNotesString (self, args) |
| Returns the content of the 'notes' subelement of this object as a string. More... | |
| def | getNumCVTerms (self) |
| Returns the number of CVTerm objects in the annotations of this SBML object. More... | |
| def | getNumDisabledPlugins (self) |
| Returns the number of disabled plug-in objects (extension interfaces) for SBML Level 3 package extensions known. More... | |
| def | getNumPlugins (self) |
| Returns the number of plug-in objects (extenstion interfaces) for SBML Level 3 package extensions known. More... | |
| def | getOffset (self) |
| Returns the value of the 'offset' attribute of this Unit. More... | |
| def | getPackageCoreVersion (self) |
| Returns the SBML Core Version within the SBML Level of the actual object. More... | |
| def | getPackageName (self) |
| Returns the name of the SBML Level 3 package in which this element is defined. More... | |
| def | getPackageVersion (self) |
| Returns the Version of the SBML Level 3 package to which this element belongs to. More... | |
| def | getParentSBMLObject (self, args) |
| Returns the parent SBML object containing this object. More... | |
| def | getPlugin (self, args) |
| This method has multiple variants; they differ in the arguments they accept. More... | |
| def | getPrefix (self) |
| Returns the XML namespace prefix of this element. More... | |
| def | getResourceBiologicalQualifier (self, resource) |
| Returns the MIRIAM biological qualifier associated with the given resource. More... | |
| def | getResourceModelQualifier (self, resource) |
| Returns the MIRIAM model qualifier associated with the given resource. More... | |
| def | getSBMLDocument (self, args) |
| Returns the SBMLDocument object containing this object instance. More... | |
| def | getSBOTerm (self) |
| Returns the integer portion of the value of the 'sboTerm' attribute of this object. More... | |
| def | getSBOTermAsURL (self) |
| Returns the URL representation of the 'sboTerm' attribute of this object. More... | |
| def | getSBOTermID (self) |
| Returns the string representation of the 'sboTerm' attribute of this object. More... | |
| def | getScale (self) |
| Returns the value of the 'scale' attribute of this unit. More... | |
| def | getTypeCode (self) |
| Returns the libSBML type code of this object instance. More... | |
| def | getURI (self) |
| Gets the namespace URI to which this element belongs to. More... | |
| def | getVersion (self) |
| Returns the Version within the SBML Level of the SBMLDocument object containing this object. More... | |
| def | hasRequiredAttributes (self) |
Predicate returning True if all the required attributes for this Unit object have been set. More... | |
| def | hasValidLevelVersionNamespaceCombination (self) |
Predicate returning true if this object's level/version and namespace values correspond to a valid SBML specification. More... | |
| def | initDefaults (self) |
| Initializes the fields of this Unit object to 'typical' default values. More... | |
| def | isAmpere (self) |
Predicate for testing whether this Unit is of the kind ampere. More... | |
| def | isAvogadro (self) |
Predicate for testing whether this Unit is of the kind avogadro. More... | |
| def | isBecquerel (self) |
Predicate for testing whether this Unit is of the kind becquerel. More... | |
| def | isBuiltIn (name, level) |
| Predicate to test whether a given string is the name of a built-in SBML unit, depending on the SBML level, since new predefined units were added between level 2 versions 1 and 2, and then all predefined units were removed again in SBML Level 3. More... | |
| def | isCandela (self) |
Predicate for testing whether this Unit is of the kind candela. More... | |
| def | isCelsius (self) |
Predicate for testing whether this Unit is of the kind Celsius. More... | |
| def | isCoulomb (self) |
Predicate for testing whether this Unit is of the kind coulomb. More... | |
| def | isDimensionless (self) |
Predicate for testing whether this Unit is of the kind dimensionless. More... | |
| def | isFarad (self) |
Predicate for testing whether this Unit is of the kind farad. More... | |
| def | isGram (self) |
Predicate for testing whether this Unit is of the kind gram. More... | |
| def | isGray (self) |
Predicate for testing whether this Unit is of the kind gray. More... | |
| def | isHenry (self) |
Predicate for testing whether this Unit is of the kind henry. More... | |
| def | isHertz (self) |
Predicate for testing whether this Unit is of the kind hertz. More... | |
| def | isItem (self) |
Predicate for testing whether this Unit is of the kind item. More... | |
| def | isJoule (self) |
Predicate for testing whether this Unit is of the kind joule. More... | |
| def | isKatal (self) |
Predicate for testing whether this Unit is of the kind katal. More... | |
| def | isKelvin (self) |
Predicate for testing whether this Unit is of the kind kelvin. More... | |
| def | isKilogram (self) |
Predicate for testing whether this Unit is of the kind kilogram. More... | |
| def | isLitre (self) |
Predicate for testing whether this Unit is of the kind litre. More... | |
| def | isLumen (self) |
Predicate for testing whether this Unit is of the kind lumen. More... | |
| def | isLux (self) |
Predicate for testing whether this Unit is of the kind lux. More... | |
| def | isMetre (self) |
Predicate for testing whether this Unit is of the kind metre. More... | |
| def | isMole (self) |
Predicate for testing whether this Unit is of the kind mole. More... | |
| def | isNewton (self) |
Predicate for testing whether this Unit is of the kind newton. More... | |
| def | isOhm (self) |
Predicate for testing whether this Unit is of the kind ohm. More... | |
| def | isPackageEnabled (self, pkgName) |
Predicate returning True if the given SBML Level 3 package is enabled with this object. More... | |
| def | isPackageURIEnabled (self, pkgURI) |
Predicate returning True if an SBML Level 3 package with the given URI is enabled with this object. More... | |
| def | isPascal (self) |
Predicate for testing whether this Unit is of the kind pascal. More... | |
| def | isPkgEnabled (self, pkgName) |
Predicate returning True if the given SBML Level 3 package is enabled with this object. More... | |
| def | isPkgURIEnabled (self, pkgURI) |
Predicate returning True if an SBML Level 3 package with the given URI is enabled with this object. More... | |
| def | isRadian (self) |
Predicate for testing whether this Unit is of the kind radian. More... | |
| def | isSecond (self) |
Predicate for testing whether this Unit is of the kind second. More... | |
| def | isSetAnnotation (self) |
Predicate returning True if this object's 'annotation' subelement exists and has content. More... | |
| def | isSetExponent (self) |
| Predicate to test whether the 'exponent' attribute of this Unit is set. More... | |
| def | isSetId (self) |
Predicate returning True if a call to getId() returns a non-empty string. More... | |
| def | isSetIdAttribute (self) |
Predicate returning True if this object's 'id' attribute is set. More... | |
| def | isSetKind (self) |
| Predicate to test whether the 'kind' attribute of this Unit is set. More... | |
| def | isSetMetaId (self) |
Predicate returning True if this object's 'metaid' attribute is set. More... | |
| def | isSetModelHistory (self) |
Predicate returning True if this object has a ModelHistory object attached to it. More... | |
| def | isSetMultiplier (self) |
| Predicate to test whether the 'multiplier' attribute of this Unit is set. More... | |
| def | isSetName (self) |
Predicate returning True if this object's 'name' attribute is set. More... | |
| def | isSetNotes (self) |
Predicate returning True if this object's 'notes' subelement exists and has content. More... | |
| def | isSetOffset (self) |
| Predicate to test whether the 'offset' attribute of this Unit is set. More... | |
| def | isSetSBOTerm (self) |
Predicate returning True if this object's 'sboTerm' attribute is set. More... | |
| def | isSetScale (self) |
| Predicate to test whether the 'scale' attribute of this Unit is set. More... | |
| def | isSetUserData (self) |
| Predicate returning true or false depending on whether the user data of this element has been set. More... | |
| def | isSiemens (self) |
Predicate for testing whether this Unit is of the kind siemens. More... | |
| def | isSievert (self) |
Predicate for testing whether this Unit is of the kind sievert. More... | |
| def | isSteradian (self) |
Predicate for testing whether this Unit is of the kind steradian. More... | |
| def | isTesla (self) |
Predicate for testing whether this Unit is of the kind tesla. More... | |
| def | isUnitKind (name, level, version) |
Predicate to test whether a given string is the name of a valid base unit in SBML (such as 'gram' or 'mole'). More... | |
| def | isVolt (self) |
Predicate for testing whether this Unit is of the kind volt. More... | |
| def | isWatt (self) |
Predicate for testing whether this Unit is of the kind watt. More... | |
| def | isWeber (self) |
Predicate for testing whether this Unit is of the kind weber. More... | |
| def | matchesRequiredSBMLNamespacesForAddition (self, args) |
Returns True if this object's set of XML namespaces are a subset of the given object's XML namespaces. More... | |
| def | matchesSBMLNamespaces (self, args) |
Returns True if this object's set of XML namespaces are the same as the given object's XML namespaces. More... | |
| def | merge (unit1, unit2) |
| Merges two Unit objects with the same 'kind' attribute value into a single Unit. More... | |
| def | removeFromParentAndDelete (self) |
| Removes this object from its parent. More... | |
| def | removeScale (unit) |
| Manipulates the attributes of the Unit to express the unit with the value of the scale attribute reduced to zero. More... | |
| def | removeTopLevelAnnotationElement (self, args) |
| Removes the top-level element within the 'annotation' subelement of this SBML object with the given name and optional URI. More... | |
| def | renameMetaIdRefs (self, oldid, newid) |
| Replaces all uses of a given meta identifier attribute value with another value. More... | |
| def | renameSIdRefs (self, oldid, newid) |
Replaces all uses of a given SIdRef type attribute value with another value. More... | |
| def | renameUnitSIdRefs (self, oldid, newid) |
Replaces all uses of a given UnitSIdRef type attribute value with another value. More... | |
| def | replaceTopLevelAnnotationElement (self, args) |
| This method has multiple variants; they differ in the arguments they accept. More... | |
| def | setAnnotation (self, args) |
| This method has multiple variants; they differ in the arguments they accept. More... | |
| def | setExponent (self, args) |
| This method has multiple variants; they differ in the arguments they accept. More... | |
| def | setId (self, sid) |
| Sets the value of the 'id' attribute of this SBML object. More... | |
| def | setIdAttribute (self, sid) |
| Sets the value of the 'id' attribute of this SBML object. More... | |
| def | setKind (self, kind) |
| Sets the 'kind' attribute value of this Unit. More... | |
| def | setMetaId (self, metaid) |
| Sets the value of the meta-identifier attribute of this SBML object. More... | |
| def | setModelHistory (self, history) |
| Sets the ModelHistory of this object. More... | |
| def | setMultiplier (self, value) |
| Sets the 'multipler' attribute value of this Unit. More... | |
| def | setName (self, name) |
| Sets the value of the 'name' attribute of this SBML object. More... | |
| def | setNamespaces (self, xmlns) |
| Sets the namespaces relevant of this SBML object. More... | |
| def | setNotes (self, args) |
| This method has multiple variants; they differ in the arguments they accept. More... | |
| def | setOffset (self, value) |
| Sets the 'offset' attribute value of this Unit. More... | |
| def | setSBOTerm (self, args) |
| This method has multiple variants; they differ in the arguments they accept. More... | |
| def | setScale (self, value) |
| Sets the 'scale' attribute value of this Unit. More... | |
| def | toSBML (self) |
| Returns a string consisting of a partial SBML corresponding to just this object. More... | |
| def | toXMLNode (self) |
| Returns this element as an XMLNode. More... | |
| def | unsetAnnotation (self) |
| Unsets the value of the 'annotation' subelement of this SBML object. More... | |
| def | unsetCVTerms (self) |
| Clears the list of CVTerm objects attached to this SBML object. More... | |
| def | unsetExponent (self) |
| Unsets the 'exponent' attribute value of this Unit. More... | |
| def | unsetId (self) |
| Unsets the value of the 'id' attribute of this SBML object. More... | |
| def | unsetIdAttribute (self) |
| Unsets the value of the 'id' attribute of this SBML object. More... | |
| def | unsetKind (self) |
| Unsets the 'kind' attribute value of this Unit. More... | |
| def | unsetMetaId (self) |
| Unsets the value of the 'metaid' attribute of this SBML object. More... | |
| def | unsetModelHistory (self) |
| Unsets the ModelHistory object attached to this object. More... | |
| def | unsetMultiplier (self) |
| Unsets the 'multipler' attribute value of this Unit. More... | |
| def | unsetName (self) |
| Unsets the value of the 'name' attribute of this SBML object. More... | |
| def | unsetNotes (self) |
| Unsets the value of the 'notes' subelement of this SBML object. More... | |
| def | unsetOffset (self) |
| Unsets the 'offset' attribute value of this Unit. More... | |
| def | unsetSBOTerm (self) |
| Unsets the value of the 'sboTerm' attribute of this SBML object. More... | |
| def | unsetScale (self) |
| Unsets the 'scale' attribute value of this Unit. More... | |
| def | unsetUserData (self) |
| Unsets the user data of this element. More... | |
| def libsbml.Unit.__init__ | ( | self, | |
| args | |||
| ) |
This method has multiple variants; they differ in the arguments they accept.
__init__(long level, long version) Unit __init__(SBMLNamespaces sbmlns) Unit __init__(Unit orig) Unit
Each variant is described separately below.
Unit(SBMLNamespaces sbmlns)
Creates a new Unit using the given SBMLNamespaces object sbmlns.
| sbmlns | an SBMLNamespaces object. |
| ValueError | Thrown if the given sbmlns is inconsistent or incompatible with this object. |
Unit(long level, long version)
Creates a new Unit using the given SBML level and version values.
| level | a long integer, the SBML Level to assign to this Unit. |
| version | a long integer, the SBML Version to assign to this Unit. |
| ValueError | Thrown if the given level and version combination are invalid or if this object is incompatible with the given level and version. |
Unit(Unit orig)
Copy constructor; creates a copy of this Unit.
| orig | the object to copy. |
|
inherited |
Adds a copy of the given CVTerm object to this SBML object.
addCVTerm(CVTerm term, bool newBag) int addCVTerm(CVTerm term) int
| term | the CVTerm to assign. |
| newBag | if True, creates a new RDF bag with the same identifier as a previous bag, and if False, adds the term to an existing RDF bag with the same type of qualifier as the term being added. |
create) for alternatives that do not lead to these issues.parameter = value. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
appendAnnotation(XMLNode annotation) int appendAnnotation(string annotation) int
Each variant is described separately below.
appendAnnotation(XMLNode annotation)
Appends the given annotation to the 'annotation' subelement of this object.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Unlike SBase.setAnnotation() or SBase.setAnnotation(), this method allows other annotations to be preserved when an application adds its own data.
| annotation | an XML structure that is to be copied and appended to the content of the 'annotation' subelement of this object. |
appendAnnotation(string annotation)
Appends the given annotation to the 'annotation' subelement of this object.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Unlike SBase.setAnnotation() or SBase.setAnnotation(), this method allows other annotations to be preserved when an application adds its own data.
| annotation | an XML string that is to be copied and appended to the content of the 'annotation' subelement of this object. |
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
appendNotes(XMLNode notes) int appendNotes(string notes) int
Each variant is described separately below.
appendNotes(string notes)
Appends the given notes to the 'notes' subelement of this object.
The content of the parameter notes is copied.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
| notes | an XML string that is to appended to the content of the 'notes' subelement of this object. |
appendNotes(XMLNode notes)
Appends the given notes to the 'notes' subelement of this object.
The content of notes is copied.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
| notes | an XML node structure that is to appended to the content of the 'notes' subelement of this object. |
| def libsbml.Unit.areEquivalent | ( | unit1, | |
| unit2 | |||
| ) |
Predicate returning True if Unit objects are equivalent.
areEquivalent(Unit unit1, Unit unit2) bool
Two Unit objects are considered to be equivalent either if (1) both have a 'kind' attribute value of dimensionless, or (2) their 'kind', 'exponent' and (for SBML Level 2 Version 1) 'offset' attribute values are equal. (Contrast this to the method areIdentical(), which compares Unit objects with respect to all attributes, not just the 'kind' and 'exponent'.)
True if the 'kind' and 'exponent' attributes of unit1 are identical to the kind and exponent attributes of unit2, or if the kind attributes of both are dimensionless; False otherwise.| def libsbml.Unit.areIdentical | ( | unit1, | |
| unit2 | |||
| ) |
Predicate returning True if two Unit objects are identical.
areIdentical(Unit unit1, Unit unit2) bool
Two Unit objects are considered to be identical if they match in all attributes. (Contrast this to the method areEquivalent(), which compares Unit objects only with respect to certain attributes.)
True if all the attributes of unit1 are identical to the attributes of unit2, False otherwise.| def libsbml.Unit.clone | ( | self | ) |
|
inherited |
connectToChild()
| def libsbml.Unit.convertToSI | ( | unit | ) |
Returns a UnitDefinition object containing the given unit converted to the appropriate SI unit.
convertToSI(Unit unit) UnitDefinition
This method exists because some units can be expressed in terms of others when the same physical dimension is involved. For example, one hertz is identical to 1 sec-1, one litre is equivalent to 1 cubic decametre, and so on.
| unit | the Unit object to convert to SI. |
|
inherited |
Deletes all information stored in disabled plugins.
deleteDisabledPlugins(bool recursive) deleteDisabledPlugins()
If the plugin is re-enabled later, it will then not have any previously-stored information.
| recursive | if True, the disabled information will be deleted also from all child elements, otherwise only from this SBase element. |
|
inherited |
Disables the given SBML Level 3 package on this object.
disablePackage(string pkgURI, string pkgPrefix) intThis method disables the specified package on this object and other objects connected by child-parent links in the same SBMLDocument object.
An example of when this may be useful is during construction of model components when mixing existing and new models. Suppose your application read an SBML document containing a model that used the SBML Hierarchical Model Composition (“comp”) package, and extracted parts of that model in order to construct a new model in memory. The new, in-memory model will not accept a component drawn from an other SBMLDocument with different package namespace declarations. You could reconstruct the same namespaces in the in-memory model first, but as a shortcut, you could also disable the package namespace on the object being added. Here is a code example to help clarify this:
| pkgURI | the URI of the package. |
| pkgPrefix | the XML prefix of the package. |
|
inherited |
Enables or disables the given SBML Level 3 package on this object.
enablePackage(string pkgURI, string pkgPrefix, bool flag) intThis method enables the specified package on this object and other objects connected by child-parent links in the same SBMLDocument object. This method is the converse of SBase.disablePackage().
| pkgURI | the URI of the package. |
| pkgPrefix | the XML prefix of the package. |
| flag | whether to enable (True) or disable (False) the package. |
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
getAncestorOfType(int type, string pkgName) SBase getAncestorOfType(int type) SBase
Each variant is described separately below.
getAncestorOfType(int type, string pkgName = 'core')
Returns the first ancestor object that has the given SBML type code from the given package.
LibSBML attaches an identifying code to every kind of SBML object. These are known as SBML type codes. In the Python language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbml. The names of the type codes all begin with the characters SBML_.
This method searches the tree of objects that are parents of this object, and returns the first one that has the given SBML type code from the given pkgName.
| type | the SBML type code of the object sought. |
| pkgName | (optional) the short name of an SBML Level 3 package to which the sought-after object must belong. |
None if no ancestor exists.pkgName must be used for all type codes from SBML Level 3 packages. Otherwise, the function will search the 'core' namespace alone, not find any corresponding elements, and return None.parameter = value. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.getAncestorOfType(int type, string pkgName = 'core')
Returns the first ancestor object that has the given SBML type code from the given package.
LibSBML attaches an identifying code to every kind of SBML object. These are known as SBML type codes. In the Python language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbml. The names of the type codes all begin with the characters SBML_.
This method searches the tree of objects that are parents of this object, and returns the first one that has the given SBML type code from the given pkgName.
| type | the SBML type code of the object sought. |
| pkgName | (optional) the short name of an SBML Level 3 package to which the sought-after object must belong. |
None if no ancestor exists.pkgName must be used for all type codes from SBML Level 3 packages. Otherwise, the function will search the 'core' namespace alone, not find any corresponding elements, and return None.parameter = value. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.
|
inherited |
Returns the content of the 'annotation' subelement of this object as a tree of XMLNode objects.
getAnnotation() XMLNode
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
The annotations returned by this method will be in XML form. LibSBML provides an object model and related interfaces for certain specific kinds of annotations, namely model history information and RDF content. See the ModelHistory, CVTerm and RDFAnnotationParser classes for more information about the facilities available.
|
inherited |
Returns the content of the 'annotation' subelement of this object as a character string.
getAnnotationString() stringSBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
The annotations returned by this method will be in string form. See the method getAnnotation() for a version that returns annotations in XML form.
|
inherited |
Returns the column number where this object first appears in the XML representation of the SBML document.
getColumn() long0.
|
inherited |
|
inherited |
Returns a list of CVTerm objects in the annotations of this SBML object.
getCVTerms() List *
|
inherited |
Returns the nth disabled plug-in object (extension interface) for an SBML Level 3 package extension.
getDisabledPlugin(long n) SBasePlugin
If no such plugin exists, None is returned.
| n | the index of the disabled plug-in to return. |
n is invalid, None is returned.
|
inherited |
Returns the first child element it can find with a specific 'metaid' attribute value, or None if no such object is found.
getElementByMetaId(string metaid) SBase
ID, the XML identifier type, which means each 'metaid' value must be globally unique within an SBML file. The latter point is important, because the uniqueness criterion applies across any attribute with type ID anywhere in the file, not just the 'metaid' attribute used by SBML—something to be aware of if your application-specific XML content inside the 'annotation' subelement happens to use the XML ID type. Although SBML itself specifies the use of XML ID only for the 'metaid' attribute, SBML-compatible applications should be careful if they use XML ID's in XML portions of a model that are not defined by SBML, such as in the application-specific content of the 'annotation' subelement. Finally, note that LibSBML does not provide an explicit XML ID data type; it uses ordinary character strings, which is easier for applications to support.| metaid | string representing the 'metaid' attribute value of the object to find. |
|
inherited |
Returns the first child element found that has the given id in the model-wide SId namespace, or None if no such object is found.
getElementBySId(string id) SBase
| id | string representing the 'id' attribute value of the object to find. |
| def libsbml.Unit.getElementName | ( | self | ) |
Returns the XML element name of this object, which for Unit, is always 'unit'.
getElementName() string'unit'. | def libsbml.Unit.getExponent | ( | self | ) |
Returns the value of the 'exponent' attribute of this unit.
getExponent() int| def libsbml.Unit.getExponentAsDouble | ( | self | ) |
Returns the value of the 'exponent' attribute of this unit.
getExponentAsDouble() float
|
inherited |
Returns the value of the 'id' attribute of this SBML object, if it has one, or the 'variable' attribute of a Rule, or the 'symbol' attribute of an InitialAssignment.
getId() stringSId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows: letter ::= 'a'..'z','A'..'Z' digit ::= '0'..'9' idChar ::= letter | digit | '_' SId ::= ( letter | '_' ) idChar*The characters
( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.
With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.
|
inherited |
Returns the value of the 'id' attribute of this SBML object.
getIdAttribute() stringSId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows: letter ::= 'a'..'z','A'..'Z' digit ::= '0'..'9' idChar ::= letter | digit | '_' SId ::= ( letter | '_' ) idChar*The characters
( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.
With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.
| def libsbml.Unit.getKind | ( | self | ) |
|
inherited |
Returns the SBML Level of the SBMLDocument object containing this object.
getLevel() long
|
inherited |
Returns the line number where this object first appears in the XML representation of the SBML document.
getLine() long0.
|
inherited |
Returns an SBaseList of all child SBase objects, including those nested to an arbitrary depth.
getListOfAllElements(ElementFilter filter) SBaseList getListOfAllElements() SBaseList
|
inherited |
Returns a List of all child SBase objects contained in SBML package plug-ins.
getListOfAllElementsFromPlugins(ElementFilter filter) SBaseList getListOfAllElementsFromPlugins() SBaseList
This method walks down the list of all SBML Level 3 packages used by this object and returns all child objects defined by those packages.
|
inherited |
Returns the value of the 'metaid' attribute of this SBML object.
getMetaId() stringID, the XML identifier type, which means each 'metaid' value must be globally unique within an SBML file. The latter point is important, because the uniqueness criterion applies across any attribute with type ID anywhere in the file, not just the 'metaid' attribute used by SBML—something to be aware of if your application-specific XML content inside the 'annotation' subelement happens to use the XML ID type. Although SBML itself specifies the use of XML ID only for the 'metaid' attribute, SBML-compatible applications should be careful if they use XML ID's in XML portions of a model that are not defined by SBML, such as in the application-specific content of the 'annotation' subelement. Finally, note that LibSBML does not provide an explicit XML ID data type; it uses ordinary character strings, which is easier for applications to support.
|
inherited |
|
inherited |
Returns the ModelHistory object, if any, attached to this object.
getModelHistory() ModelHistory
None if none exist.| def libsbml.Unit.getMultiplier | ( | self | ) |
|
inherited |
Returns the value of the 'name' attribute of this SBML object.
getName() stringThe 'name' attribute is optional and is not intended to be used for cross-referencing purposes within a model. Its purpose instead is to provide a human-readable label for the component. The data type of 'name' is the type string defined in XML Schema. SBML imposes no restrictions as to the content of 'name' attributes beyond those restrictions defined by the string type in XML Schema.
The recommended practice for handling 'name' is as follows. If a software tool has the capability for displaying the content of 'name' attributes, it should display this content to the user as a component's label instead of the component's 'id'. If the user interface does not have this capability (e.g., because it cannot display or use special characters in symbol names), or if the 'name' attribute is missing on a given component, then the user interface should display the value of the 'id' attribute instead. (Script language interpreters are especially likely to display 'id' instead of 'name'.)
As a consequence of the above, authors of systems that automatically generate the values of 'id' attributes should be aware some systems may display the 'id''s to the user. Authors therefore may wish to take some care to have their software create 'id' values that are: (a) reasonably easy for humans to type and read; and (b) likely to be meaningful, for example by making the 'id' attribute be an abbreviated form of the name attribute value.
An additional point worth mentioning is although there are restrictions on the uniqueness of 'id' values, there are no restrictions on the uniqueness of 'name' values in a model. This allows software applications leeway in assigning component identifiers.
Regardless of the level and version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have names). If the object in question does not posess a 'name' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the name to be set, nor will it read or write 'name' attributes for those objects.
|
inherited |
Returns a list of the XML Namespaces declared on the SBML document owning this object.
getNamespaces() XMLNamespaces
The SBMLNamespaces object encapsulates SBML Level/Version/namespaces information. It is used to communicate the SBML Level, Version, and (in Level 3) packages used in addition to SBML Level 3 Core.
None in certain very usual circumstances where a namespace is not set.
|
inherited |
Returns the content of the 'notes' subelement of this object as a tree of XMLNode objects.
getNotes() XMLNode
The format of 'notes' elements conform to the definition of XHTML 1.0. However, the content cannot be entirely free-form; it must satisfy certain requirements defined in the SBML specifications for specific SBML Levels. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); this method implements a verification process that lets callers check whether the content of a given XMLNode object conforms to the SBML requirements for 'notes' and 'message' structure. Developers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations of using 'notes' in SBML. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
The 'notes' element content returned by this method will be in XML form, but libSBML does not provide an object model specifically for the content of notes. Callers will need to traverse the XML tree structure using the facilities available on XMLNode and related objects. For an alternative method of accessing the notes, see getNotesString().
|
inherited |
Returns the content of the 'notes' subelement of this object as a string.
getNotesString() stringThe format of 'notes' elements conform to the definition of XHTML 1.0. However, the content cannot be entirely free-form; it must satisfy certain requirements defined in the SBML specifications for specific SBML Levels. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); this method implements a verification process that lets callers check whether the content of a given XMLNode object conforms to the SBML requirements for 'notes' and 'message' structure. Developers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations of using 'notes' in SBML. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
For an alternative method of accessing the notes, see getNotes(), which returns the content as an XMLNode tree structure. Depending on an application's needs, one or the other method may be more convenient.
|
inherited |
Returns the number of CVTerm objects in the annotations of this SBML object.
getNumCVTerms() long
|
inherited |
Returns the number of disabled plug-in objects (extension interfaces) for SBML Level 3 package extensions known.
getNumDisabledPlugins() long
|
inherited |
Returns the number of plug-in objects (extenstion interfaces) for SBML Level 3 package extensions known.
getNumPlugins() long| def libsbml.Unit.getOffset | ( | self | ) |
Returns the value of the 'offset' attribute of this Unit.
getOffset() float
|
inherited |
Returns the SBML Core Version within the SBML Level of the actual object.
getPackageCoreVersion() long
|
inherited |
Returns the name of the SBML Level 3 package in which this element is defined.
getPackageName() string"core" will be returned if this element is defined in SBML Level 3 Core. The string "unknown" will be returned if this element is not defined in any SBML package.
|
inherited |
Returns the Version of the SBML Level 3 package to which this element belongs to.
getPackageVersion() long0 will be returned if this element belongs to the SBML Level 3 Core package.
|
inherited |
Returns the parent SBML object containing this object.
getParentSBMLObject() SBase
This returns the immediately-containing object. This method is convenient when holding an object nested inside other objects in an SBML model.
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
getPlugin(string package) SBasePlugin getPlugin(long n) SBasePlugin
Each variant is described separately below.
getPlugin(long n)
Returns the nth plug-in object (extension interface) for an SBML Level 3 package extension. The returned plug-in will be the appropriate type of plugin requested: calling Model.getPlugin() will return an FbcModelPlugin; calling Parameter.getPlugin() will return CompSBasePlugin, etc.
If no such plugin exists, None is returned.
| n | the index of the plug-in to return. |
n is invalid, None is returned.getPlugin(string package)
Returns a plug-in object (extension interface) for an SBML Level 3 package extension with the given package name or URI. The returned plug-in will be the appropriate type of plugin requested: calling Model.getPlugin() will return an FbcModelPlugin; calling Parameter.getPlugin() will return CompSBasePlugin, etc.
If no such plugin exists, None is returned.
| package | the name or URI of the package. |
|
inherited |
Returns the XML namespace prefix of this element.
getPrefix() stringThis reports the XML namespace prefix chosen for this class of object in the current SBML document. This may be an empty string if the component has no explicit prefix (for instance, if it is a core SBML object placed in the default SBML namespace of the document). If it is not empty, then it corresponds to the XML namespace prefix used set the object, whatever that may be in a given SBML document.
|
inherited |
Returns the MIRIAM biological qualifier associated with the given resource.
getResourceBiologicalQualifier(string resource) longIn MIRIAM, qualifiers are an optional means of indicating the relationship between a model component and its annotations. There are two broad kinds of annotations: model and biological. The latter kind is used to qualify the relationship between a model component and a biological entity which it represents. Examples of relationships include 'is' and 'has part', but many others are possible. MIRIAM defines numerous relationship qualifiers to enable different software tools to qualify biological annotations in the same standardized way. In libSBML, the MIRIAM controlled-vocabulary annotations on an SBML model element are represented using lists of CVTerm objects, and the the MIRIAM biological qualifiers are represented using valueswhose names begin with BQB_ in the interface class libsbml.
This method searches the controlled-vocabulary annotations (i.e., the list of CVTerm objects) on the present object, then out of those that have biological qualifiers, looks for an annotation to the given resource. If such an annotation is found, it returns the type of biological qualifier associated with that resource as a valuewhose name begins with BQB_ from the interface class libsbml.
| resource | string representing the resource; e.g., 'http://www.geneontology.org/#GO:0005892'. |
BQB_ constants defined in libsbml may be expanded in later libSBML releases, to match the values defined by MIRIAM at that later time.
|
inherited |
Returns the MIRIAM model qualifier associated with the given resource.
getResourceModelQualifier(string resource) longIn MIRIAM, qualifiers are an optional means of indicating the relationship between a model component and its annotations. There are two broad kinds of annotations: model and biological. The former kind is used to qualify the relationship between a model component and another modeling object. An example qualifier is 'isDerivedFrom', to indicate that a given component of the model is derived from the modeling object represented by the referenced resource. MIRIAM defines numerous relationship qualifiers to enable different software tools to qualify model annotations in the same standardized way. In libSBML, the MIRIAM controlled-vocabulary annotations on an SBML model element are represented using lists of CVTerm objects, and the the MIRIAM model qualifiers are represented using valueswhose names begin with BQM_ in the interface class libsbml.
This method method searches the controlled-vocabulary annotations (i.e., the list of CVTerm objects) on the present object, then out of those that have model qualifiers, looks for an annotation to the given resource. If such an annotation is found, it returns the type of type of model qualifier associated with that resource as a valuewhose name begins with BQM_ from the interface class libsbml.
| resource | string representing the resource; e.g., 'http://www.geneontology.org/#GO:0005892'. |
BQM_ constants defined in libsbml may be expanded in later libSBML releases, to match the values defined by MIRIAM at that later time.
|
inherited |
Returns the SBMLDocument object containing this object instance.
getSBMLDocument() SBMLDocument
This method allows the caller to obtain the SBMLDocument for the current object.
|
inherited |
Returns the integer portion of the value of the 'sboTerm' attribute of this object.
getSBOTerm() intint, and SBO identifiers are stored simply as integers. -1 if the value is not set.
|
inherited |
Returns the URL representation of the 'sboTerm' attribute of this object.
getSBOTermAsURL() stringThis method returns the entire SBO identifier as a text string in the form http://identifiers.org/biomodels.sbo/SBO:NNNNNNN'.
|
inherited |
Returns the string representation of the 'sboTerm' attribute of this object.
getSBOTermID() stringint, and SBO identifiers are stored simply as integers. | def libsbml.Unit.getScale | ( | self | ) |
Returns the value of the 'scale' attribute of this unit.
getScale() int| def libsbml.Unit.getTypeCode | ( | self | ) |
Returns the libSBML type code of this object instance.
getTypeCode() intSBML_. In the Python language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbml. Note that different Level 3 package plug-ins may use overlapping type codes; to identify the package to which a given object belongs, call the SBase.getPackageName() method on the object.The exception to this is lists: all SBML-style list elements have the type SBML_LIST_OF, regardless of what package they are from.
|
inherited |
Gets the namespace URI to which this element belongs to.
getURI() stringFor example, all elements that belong to SBML Level 3 Version 1 Core must would have the URI 'http://www.sbml.org/sbml/level3/version1/core'; all elements that belong to Layout Extension Version 1 for SBML Level 3 Version 1 Core must would have the URI 'http://www.sbml.org/sbml/level3/version1/layout/version1'.
This function first returns the URI for this element by looking into the SBMLNamespaces object of the document with the its package name. If not found, it will then look for the namespace associated with the element itself.
|
inherited |
Returns the Version within the SBML Level of the SBMLDocument object containing this object.
getVersion() long| def libsbml.Unit.hasRequiredAttributes | ( | self | ) |
Predicate returning True if all the required attributes for this Unit object have been set.
hasRequiredAttributes() boolThe required attributes for a Unit object are:
True if the required attributes have been set, False otherwise.
|
inherited |
Predicate returning true if this object's level/version and namespace values correspond to a valid SBML specification.
hasValidLevelVersionNamespaceCombination() boolThe valid combinations of SBML Level, Version and Namespace as of this release of libSBML are the following:
http://www.sbml.org/sbml/level1 http://www.sbml.org/sbml/level2 http://www.sbml.org/sbml/level2/version2 http://www.sbml.org/sbml/level2/version3 http://www.sbml.org/sbml/level2/version4 http://www.sbml.org/sbml/level3/version1/core true if the level, version and namespace values of this SBML object correspond to a valid set of values, false otherwise. | def libsbml.Unit.initDefaults | ( | self | ) |
Initializes the fields of this Unit object to 'typical' default values.
initDefaults()
The SBML Unit component has slightly different aspects and default attribute values in different SBML Levels and Versions. This method sets the values to certain common defaults, based mostly on what they are in SBML Level 2. Specifically:
1 0 1.0 The 'kind' attribute is left unchanged.
| def libsbml.Unit.isAmpere | ( | self | ) |
| def libsbml.Unit.isAvogadro | ( | self | ) |
| def libsbml.Unit.isBecquerel | ( | self | ) |
| def libsbml.Unit.isBuiltIn | ( | name, | |
| level | |||
| ) |
Predicate to test whether a given string is the name of a built-in SBML unit, depending on the SBML level, since new predefined units were added between level 2 versions 1 and 2, and then all predefined units were removed again in SBML Level 3.
isBuiltIn(string name, long level) bool| name | a string to be tested against the built-in unit names. |
| level | the level of SBML one is checking. |
True if name is one of 'substance', 'volume', or 'time' and the level is 1; or if name is one of 'substance', 'volume', 'area', 'length', or 'time' and the level is 2; False otherwise (including all values when level is 3).| def libsbml.Unit.isCandela | ( | self | ) |
| def libsbml.Unit.isCelsius | ( | self | ) |
Predicate for testing whether this Unit is of the kind Celsius.
True if the kind of this Unit is Celsius, False otherwise.isCelsius() boolCelsius was removed from the list of predefined units in SBML Level 2 Version 2 at the same time that the 'offset' attribute was removed from Unit definitions. LibSBML methods such as this one related to Celsius are retained in order to support SBML Level 2 Version 1, but their use is strongly discouraged. | def libsbml.Unit.isCoulomb | ( | self | ) |
| def libsbml.Unit.isDimensionless | ( | self | ) |
| def libsbml.Unit.isFarad | ( | self | ) |
| def libsbml.Unit.isGram | ( | self | ) |
| def libsbml.Unit.isGray | ( | self | ) |
| def libsbml.Unit.isHenry | ( | self | ) |
| def libsbml.Unit.isHertz | ( | self | ) |
| def libsbml.Unit.isItem | ( | self | ) |
| def libsbml.Unit.isJoule | ( | self | ) |
| def libsbml.Unit.isKatal | ( | self | ) |
| def libsbml.Unit.isKelvin | ( | self | ) |
| def libsbml.Unit.isKilogram | ( | self | ) |
| def libsbml.Unit.isLitre | ( | self | ) |
| def libsbml.Unit.isLumen | ( | self | ) |
| def libsbml.Unit.isLux | ( | self | ) |
| def libsbml.Unit.isMetre | ( | self | ) |
| def libsbml.Unit.isMole | ( | self | ) |
| def libsbml.Unit.isNewton | ( | self | ) |
| def libsbml.Unit.isOhm | ( | self | ) |
|
inherited |
Predicate returning True if the given SBML Level 3 package is enabled with this object.
isPackageEnabled(string pkgName) boolThe search ignores the package version.
| pkgName | the name of the package. |
True if the given package is enabled within this object, False otherwise.
|
inherited |
Predicate returning True if an SBML Level 3 package with the given URI is enabled with this object.
isPackageURIEnabled(string pkgURI) bool| pkgURI | the URI of the package. |
True if the given package is enabled within this object, False otherwise.| def libsbml.Unit.isPascal | ( | self | ) |
|
inherited |
Predicate returning True if the given SBML Level 3 package is enabled with this object.
isPkgEnabled(string pkgName) boolThe search ignores the package version.
| pkgName | the name of the package. |
True if the given package is enabled within this object, False otherwise.
|
inherited |
Predicate returning True if an SBML Level 3 package with the given URI is enabled with this object.
isPkgURIEnabled(string pkgURI) bool| pkgURI | the URI of the package. |
True if the given package is enabled within this object, False otherwise.| def libsbml.Unit.isRadian | ( | self | ) |
| def libsbml.Unit.isSecond | ( | self | ) |
|
inherited |
Predicate returning True if this object's 'annotation' subelement exists and has content.
isSetAnnotation() boolWhereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
True if a 'annotation' subelement exists, False otherwise.| def libsbml.Unit.isSetExponent | ( | self | ) |
|
inherited |
Predicate returning True if a call to getId() returns a non-empty string.
isSetId() boolFor most objects, this function will return True if its 'id' attribute is set, and False if it is not, or if the object has no 'id' attribute at all. However, for an EventAssignment or a Rule, isSetId() checks whether the 'variable' attribute is set, and for an InitialAssignment, it checks whether the 'symbol' attribute is set. Because those elements will also have an 'id' attribute in SBML Level 3 Version 2 which isSetId() will not check, the function itself is deprecated, and it is recommended to use isSetIdAttribute() in all cases where one needs to know whether the 'id' attribute is set, and to use EventAssignment.isSetVariable(), Rule.isSetVariable() and InitialAssignment.isSetSymbol() when the status of the 'variable' or 'symbol' attributes need to be checked.
SId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows: letter ::= 'a'..'z','A'..'Z' digit ::= '0'..'9' idChar ::= letter | digit | '_' SId ::= ( letter | '_' ) idChar*The characters
( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.
With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.
True if the 'id' attribute of this SBML object is set, False otherwise.
|
inherited |
Predicate returning True if this object's 'id' attribute is set.
isSetIdAttribute() boolSId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows: letter ::= 'a'..'z','A'..'Z' digit ::= '0'..'9' idChar ::= letter | digit | '_' SId ::= ( letter | '_' ) idChar*The characters
( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.
With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.
True if the 'id' attribute of this SBML object is set, False otherwise.| def libsbml.Unit.isSetKind | ( | self | ) |
|
inherited |
Predicate returning True if this object's 'metaid' attribute is set.
isSetMetaId() boolID, the XML identifier type, which means each 'metaid' value must be globally unique within an SBML file. The latter point is important, because the uniqueness criterion applies across any attribute with type ID anywhere in the file, not just the 'metaid' attribute used by SBML—something to be aware of if your application-specific XML content inside the 'annotation' subelement happens to use the XML ID type. Although SBML itself specifies the use of XML ID only for the 'metaid' attribute, SBML-compatible applications should be careful if they use XML ID's in XML portions of a model that are not defined by SBML, such as in the application-specific content of the 'annotation' subelement. Finally, note that LibSBML does not provide an explicit XML ID data type; it uses ordinary character strings, which is easier for applications to support.True if the 'metaid' attribute of this SBML object is set, False otherwise.
|
inherited |
Predicate returning True if this object has a ModelHistory object attached to it.
isSetModelHistory() boolTrue if the ModelHistory of this object is set, False otherwise.| def libsbml.Unit.isSetMultiplier | ( | self | ) |
|
inherited |
Predicate returning True if this object's 'name' attribute is set.
isSetName() boolThe 'name' attribute is optional and is not intended to be used for cross-referencing purposes within a model. Its purpose instead is to provide a human-readable label for the component. The data type of 'name' is the type string defined in XML Schema. SBML imposes no restrictions as to the content of 'name' attributes beyond those restrictions defined by the string type in XML Schema.
The recommended practice for handling 'name' is as follows. If a software tool has the capability for displaying the content of 'name' attributes, it should display this content to the user as a component's label instead of the component's 'id'. If the user interface does not have this capability (e.g., because it cannot display or use special characters in symbol names), or if the 'name' attribute is missing on a given component, then the user interface should display the value of the 'id' attribute instead. (Script language interpreters are especially likely to display 'id' instead of 'name'.)
As a consequence of the above, authors of systems that automatically generate the values of 'id' attributes should be aware some systems may display the 'id''s to the user. Authors therefore may wish to take some care to have their software create 'id' values that are: (a) reasonably easy for humans to type and read; and (b) likely to be meaningful, for example by making the 'id' attribute be an abbreviated form of the name attribute value.
An additional point worth mentioning is although there are restrictions on the uniqueness of 'id' values, there are no restrictions on the uniqueness of 'name' values in a model. This allows software applications leeway in assigning component identifiers.
Regardless of the level and version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have names). If the object in question does not posess a 'name' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the name to be set, nor will it read or write 'name' attributes for those objects.
True if the 'name' attribute of this SBML object is set, False otherwise.
|
inherited |
Predicate returning True if this object's 'notes' subelement exists and has content.
isSetNotes() boolThe optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
True if a 'notes' subelement exists, False otherwise.| def libsbml.Unit.isSetOffset | ( | self | ) |
Predicate to test whether the 'offset' attribute of this Unit is set.
isSetOffset() boolTrue if the 'offset' attribute of this Unit is set, False otherwise.
|
inherited |
Predicate returning True if this object's 'sboTerm' attribute is set.
isSetSBOTerm() boolTrue if the 'sboTerm' attribute of this SBML object is set, False otherwise. | def libsbml.Unit.isSetScale | ( | self | ) |
|
inherited |
Predicate returning true or false depending on whether the user data of this element has been set.
isSetUserData() boolTrue if this object's user data has been set, False otherwise. | def libsbml.Unit.isSiemens | ( | self | ) |
| def libsbml.Unit.isSievert | ( | self | ) |
| def libsbml.Unit.isSteradian | ( | self | ) |
| def libsbml.Unit.isTesla | ( | self | ) |
| def libsbml.Unit.isUnitKind | ( | name, | |
| level, | |||
| version | |||
| ) |
Predicate to test whether a given string is the name of a valid base unit in SBML (such as 'gram' or 'mole').
isUnitKind(string name, long level, long version) boolThis method exists because prior to SBML Level 2 Version 3, an enumeration called UnitKind was defined by SBML. This enumeration was removed in SBML Level 2 Version 3 and its values were folded into the space of values of a type called UnitSId. This method therefore has less significance in SBML Level 2 Version 3 and Level 2 Version 4, but remains for backward compatibility and support for reading models in older Versions of Level 2.
| name | a string to be tested. |
| level | a long integer representing the SBML specification Level. |
| version | a long integer representing the SBML specification Version. |
True if name is a valid SBML UnitKind, False otherwise.| def libsbml.Unit.isVolt | ( | self | ) |
| def libsbml.Unit.isWatt | ( | self | ) |
| def libsbml.Unit.isWeber | ( | self | ) |
|
inherited |
Returns True if this object's set of XML namespaces are a subset of the given object's XML namespaces.
matchesRequiredSBMLNamespacesForAddition(SBase sb) bool
| sb | an object to compare with respect to namespaces. |
True if this object's collection of namespaces is a subset of sb's, False otherwise.
|
inherited |
Returns True if this object's set of XML namespaces are the same as the given object's XML namespaces.
matchesSBMLNamespaces(SBase sb) bool
| sb | an object to compare with respect to namespaces. |
True if this object's collection of namespaces is the same as sb's, False otherwise. | def libsbml.Unit.merge | ( | unit1, | |
| unit2 | |||
| ) |
Merges two Unit objects with the same 'kind' attribute value into a single Unit.
merge(Unit unit1, Unit unit2)
For example, the following,
<unit kind='metre' exponent='2'/> <unit kind='metre' exponent='1'/>
would be merged to become
<unit kind='metre' exponent='3'/>
| unit1 | the first Unit object; the result of the operation is left as a new version of this unit, modified in-place. Not modified if the two units have different kinds. |
| unit2 | the second Unit object to merge with the first. |
|
inherited |
Removes this object from its parent.
removeFromParentAndDelete() intIf the parent was storing this object as a pointer, it is deleted. If not, it is simply cleared (as in ListOf objects). This is a pure virtual method, as every SBase element has different parents, and therefore different methods of removing itself. Will fail (and not delete itself) if it has no parent object. This function is designed to be overridden, but for all objects whose parent is of the class ListOf, the default implementation will work.
| def libsbml.Unit.removeScale | ( | unit | ) |
Manipulates the attributes of the Unit to express the unit with the value of the scale attribute reduced to zero.
removeScale(Unit unit) int
For example, 1 millimetre can be expressed as a Unit with kind= 'metre' multiplier='1' scale='-3' exponent='1'. It can also be expressed as a Unit with kind='metre' multiplier='0.001' scale='0' exponent='1'.
| unit | the Unit object to manipulate. |
|
inherited |
Removes the top-level element within the 'annotation' subelement of this SBML object with the given name and optional URI.
removeTopLevelAnnotationElement(string elementName, string elementURI, bool removeEmpty) int removeTopLevelAnnotationElement(string elementName, string elementURI) int removeTopLevelAnnotationElement(string elementName) int
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Calling this method allows a particular annotation element to be removed whilst the remaining annotations remain intact.
| elementName | a string representing the name of the top level annotation element that is to be removed. |
| elementURI | an optional string that is used to check both the name and URI of the top level element to be removed. |
| removeEmpty | if after removing of the element, the annotation is empty, and the removeEmpty argument is true, the annotation node will be deleted (default). |
parameter = value. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.
|
inherited |
Replaces all uses of a given meta identifier attribute value with another value.
renameMetaIdRefs(string oldid, string newid)
ID; the SBML object attribute itself is typically named metaid. All attributes that hold values referring to values of type ID are of the XML data type IDREF. They are also sometimes informally referred to as 'metaid refs', in analogy to the SBML-defined type SIdRef.This method works by looking at all meta-identifier attribute values, comparing the identifiers to the value of oldid. If any matches are found, the matching identifiers are replaced with newid. The method does not descend into child elements.
| oldid | the old identifier. |
| newid | the new identifier. |
|
inherited |
Replaces all uses of a given SIdRef type attribute value with another value.
renameSIdRefs(string oldid, string newid)
SId. In SBML Level 3, an explicit data type called SIdRef was introduced for attribute values that refer to SId values; in previous Levels of SBML, this data type did not exist and attributes were simply described to as 'referring to an identifier', but the effective data type was the same as SIdRef in Level 3. These and other methods of libSBML refer to the type SIdRef for all Levels of SBML, even if the corresponding SBML specification did not explicitly name the data type.This method works by looking at all attributes and (if appropriate) mathematical formulas in MathML content, comparing the referenced identifiers to the value of oldid. If any matches are found, the matching values are replaced with newid. The method does not descend into child elements.
| oldid | the old identifier. |
| newid | the new identifier. |
|
inherited |
Replaces all uses of a given UnitSIdRef type attribute value with another value.
renameUnitSIdRefs(string oldid, string newid)
UnitSId. In SBML Level 3, an explicit data type called UnitSIdRef was introduced for attribute values that refer to UnitSId values; in previous Levels of SBML, this data type did not exist and attributes were simply described to as 'referring to a unit identifier', but the effective data type was the same as UnitSIdRef in Level 3. These and other methods of libSBML refer to the type UnitSIdRef for all Levels of SBML, even if the corresponding SBML specification did not explicitly name the data type.This method works by looking at all unit identifier attribute values (including, if appropriate, inside mathematical formulas), comparing the referenced unit identifiers to the value of oldid. If any matches are found, the matching values are replaced with newid. The method does not descend into child elements.
| oldid | the old identifier. |
| newid | the new identifier. |
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
replaceTopLevelAnnotationElement(XMLNode annotation) int replaceTopLevelAnnotationElement(string annotation) int
Each variant is described separately below.
replaceTopLevelAnnotationElement(XMLNode annotation)
Replaces the given top-level element within the 'annotation' subelement of this SBML object and with the annotation element supplied.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
This method determines the name of the element to be replaced from the annotation argument. Functionally it is equivalent to calling removeTopLevelAnnotationElement(name) followed by calling appendAnnotation(annotation_with_name), with the exception that the placement of the annotation element remains the same.
| annotation | XMLNode representing the replacement top level annotation. |
replaceTopLevelAnnotationElement(string annotation)
Replaces the given top-level element within the 'annotation' subelement of this SBML object and with the annotation element supplied.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
This method determines the name of the element to be replaced from the annotation argument. Functionally it is equivalent to calling removeTopLevelAnnotationElement(name) followed by calling appendAnnotation(annotation_with_name), with the exception that the placement of the annotation element remains the same.
| annotation | string representing the replacement top level annotation. |
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
setAnnotation(XMLNode annotation) int setAnnotation(string annotation) int
Each variant is described separately below.
setAnnotation(XMLNode annotation)
Sets the value of the 'annotation' subelement of this SBML object.
The content of annotation is copied, and any previous content of this object's 'annotation' subelement is deleted.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Call this method will result in any existing content of the 'annotation' subelement to be discarded. Unless you have taken steps to first copy and reconstitute any existing annotations into the annotation that is about to be assigned, it is likely that performing such wholesale replacement is unfriendly towards other software applications whose annotations are discarded. An alternative may be to use SBase.appendAnnotation() or SBase.appendAnnotation().
| annotation | an XML structure that is to be used as the new content of the 'annotation' subelement of this object. |
setAnnotation(string annotation)
Sets the value of the 'annotation' subelement of this SBML object.
The content of annotation is copied, and any previous content of this object's 'annotation' subelement is deleted.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Call this method will result in any existing content of the 'annotation' subelement to be discarded. Unless you have taken steps to first copy and reconstitute any existing annotations into the annotation that is about to be assigned, it is likely that performing such wholesale replacement is unfriendly towards other software applications whose annotations are discarded. An alternative may be to use SBase.appendAnnotation() or SBase.appendAnnotation().
| annotation | an XML string that is to be used as the content of the 'annotation' subelement of this object. |
| def libsbml.Unit.setExponent | ( | self, | |
| args | |||
| ) |
This method has multiple variants; they differ in the arguments they accept.
setExponent(int value) int setExponent (float value) int
Each variant is described separately below.
setExponent(int value)
Sets the 'exponent' attribute value of this Unit.
| value | the integer to which the attribute 'exponent' should be set. |
setExponent (float value)
Sets the 'exponent' attribute value of this Unit.
| value | the float to which the attribute 'exponent' should be set. |
|
inherited |
Sets the value of the 'id' attribute of this SBML object.
setId(string sid) intsid is copied.SId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows: letter ::= 'a'..'z','A'..'Z' digit ::= '0'..'9' idChar ::= letter | digit | '_' SId ::= ( letter | '_' ) idChar*The characters
( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.
With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.
| sid | the string to use as the identifier of this object. |
|
inherited |
Sets the value of the 'id' attribute of this SBML object.
setIdAttribute(string sid) intsid is copied.SId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows: letter ::= 'a'..'z','A'..'Z' digit ::= '0'..'9' idChar ::= letter | digit | '_' SId ::= ( letter | '_' ) idChar*The characters
( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.
With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.
| sid | the string to use as the identifier of this object. |
| def libsbml.Unit.setKind | ( | self, | |
| kind | |||
| ) |
|
inherited |
Sets the value of the meta-identifier attribute of this SBML object.
setMetaId(string metaid) intID, the XML identifier type, which means each 'metaid' value must be globally unique within an SBML file. The latter point is important, because the uniqueness criterion applies across any attribute with type ID anywhere in the file, not just the 'metaid' attribute used by SBML—something to be aware of if your application-specific XML content inside the 'annotation' subelement happens to use the XML ID type. Although SBML itself specifies the use of XML ID only for the 'metaid' attribute, SBML-compatible applications should be careful if they use XML ID's in XML portions of a model that are not defined by SBML, such as in the application-specific content of the 'annotation' subelement. Finally, note that LibSBML does not provide an explicit XML ID data type; it uses ordinary character strings, which is easier for applications to support.The string metaid is copied.
| metaid | the identifier string to use as the value of the 'metaid' attribute. |
|
inherited |
Sets the ModelHistory of this object.
setModelHistory(ModelHistory history) int
The content of history is copied, and this object's existing model history content is deleted.
| history | ModelHistory of this object. |
| def libsbml.Unit.setMultiplier | ( | self, | |
| value | |||
| ) |
Sets the 'multipler' attribute value of this Unit.
setMultiplier (float value) int| value | the floating-point value to which the attribute 'multiplier' should be set. |
|
inherited |
Sets the value of the 'name' attribute of this SBML object.
setName(string name) intThe string in name is copied.
| name | the new name for the SBML object. |
|
inherited |
Sets the namespaces relevant of this SBML object.
setNamespaces(XMLNamespaces xmlns) int
The content of xmlns is copied, and this object's existing namespace content is deleted.
The SBMLNamespaces object encapsulates SBML Level/Version/namespaces information. It is used to communicate the SBML Level, Version, and (in Level 3) packages used in addition to SBML Level 3 Core.
| xmlns | the namespaces to set. |
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
setNotes(XMLNode notes) int setNotes(string notes, bool addXHTMLMarkup) int setNotes(string notes) int
Each variant is described separately below.
setNotes(string notes, bool addXHTMLMarkup = false)
Sets the value of the 'notes' subelement of this SBML object to a copy of the string notes.
The content of notes is copied, and any existing content of this object's 'notes' subelement is deleted.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
The following code illustrates a very simple way of setting the notes using this method. Here, the object being annotated is the whole SBML document, but that is for illustration purposes only; you could of course use this same approach to annotate any other SBML component.
| notes | an XML string that is to be used as the content of the 'notes' subelement of this object. |
| addXHTMLMarkup | a boolean indicating whether to wrap the contents of the notes argument with XHTML paragraph (<p>) tags. This is appropriate when the string in notes does not already containg the appropriate XHTML markup. |
parameter = value. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.setNotes(XMLNode notes)
Sets the value of the 'notes' subelement of this SBML object.
The content of notes is copied, and any existing content of this object's 'notes' subelement is deleted.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
| notes | an XML structure that is to be used as the content of the 'notes' subelement of this object. |
| def libsbml.Unit.setOffset | ( | self, | |
| value | |||
| ) |
Sets the 'offset' attribute value of this Unit.
setOffset (float value) int| value | the floating point value to which the attribute 'offset' should set. |
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
setSBOTerm(int value) int setSBOTerm(string sboid) int
Each variant is described separately below.
setSBOTerm(int value)
Sets the value of the 'sboTerm' attribute.
int, and SBO identifiers are stored simply as integers. | value | the NNNNNNN integer portion of the SBO identifier. |
setSBOTerm(string sboid)
Sets the value of the 'sboTerm' attribute by string.
int, and SBO identifiers are stored simply as integers. | def libsbml.Unit.setScale | ( | self, | |
| value | |||
| ) |
Sets the 'scale' attribute value of this Unit.
setScale(int value) int| value | the integer to which the attribute 'scale' should be set. |
|
inherited |
Returns a string consisting of a partial SBML corresponding to just this object.
toSBML() string
|
inherited |
|
inherited |
Unsets the value of the 'annotation' subelement of this SBML object.
unsetAnnotation() intWhereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
|
inherited |
Clears the list of CVTerm objects attached to this SBML object.
unsetCVTerms() int| def libsbml.Unit.unsetExponent | ( | self | ) |
Unsets the 'exponent' attribute value of this Unit.
unsetExponent() int
|
inherited |
Unsets the value of the 'id' attribute of this SBML object.
unsetId() intSId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows: letter ::= 'a'..'z','A'..'Z' digit ::= '0'..'9' idChar ::= letter | digit | '_' SId ::= ( letter | '_' ) idChar*The characters
( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.
With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.
|
inherited |
Unsets the value of the 'id' attribute of this SBML object.
unsetIdAttribute() intMost (but not all) objects in SBML include two common attributes: 'id' and 'name'. The identifier given by an object's 'id' attribute value is used to identify the object within the SBML model definition. Other objects can refer to the component using this identifier.
| def libsbml.Unit.unsetKind | ( | self | ) |
Unsets the 'kind' attribute value of this Unit.
unsetKind() int
|
inherited |
Unsets the value of the 'metaid' attribute of this SBML object.
unsetMetaId() intID, the XML identifier type, which means each 'metaid' value must be globally unique within an SBML file. The latter point is important, because the uniqueness criterion applies across any attribute with type ID anywhere in the file, not just the 'metaid' attribute used by SBML—something to be aware of if your application-specific XML content inside the 'annotation' subelement happens to use the XML ID type. Although SBML itself specifies the use of XML ID only for the 'metaid' attribute, SBML-compatible applications should be careful if they use XML ID's in XML portions of a model that are not defined by SBML, such as in the application-specific content of the 'annotation' subelement. Finally, note that LibSBML does not provide an explicit XML ID data type; it uses ordinary character strings, which is easier for applications to support.
|
inherited |
Unsets the ModelHistory object attached to this object.
unsetModelHistory() int| def libsbml.Unit.unsetMultiplier | ( | self | ) |
Unsets the 'multipler' attribute value of this Unit.
unsetMultiplier() int
|
inherited |
Unsets the value of the 'name' attribute of this SBML object.
unsetName() intThe 'name' attribute is optional and is not intended to be used for cross-referencing purposes within a model. Its purpose instead is to provide a human-readable label for the component. The data type of 'name' is the type string defined in XML Schema. SBML imposes no restrictions as to the content of 'name' attributes beyond those restrictions defined by the string type in XML Schema.
The recommended practice for handling 'name' is as follows. If a software tool has the capability for displaying the content of 'name' attributes, it should display this content to the user as a component's label instead of the component's 'id'. If the user interface does not have this capability (e.g., because it cannot display or use special characters in symbol names), or if the 'name' attribute is missing on a given component, then the user interface should display the value of the 'id' attribute instead. (Script language interpreters are especially likely to display 'id' instead of 'name'.)
As a consequence of the above, authors of systems that automatically generate the values of 'id' attributes should be aware some systems may display the 'id''s to the user. Authors therefore may wish to take some care to have their software create 'id' values that are: (a) reasonably easy for humans to type and read; and (b) likely to be meaningful, for example by making the 'id' attribute be an abbreviated form of the name attribute value.
An additional point worth mentioning is although there are restrictions on the uniqueness of 'id' values, there are no restrictions on the uniqueness of 'name' values in a model. This allows software applications leeway in assigning component identifiers.
Regardless of the level and version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have names). If the object in question does not posess a 'name' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the name to be set, nor will it read or write 'name' attributes for those objects.
|
inherited |
Unsets the value of the 'notes' subelement of this SBML object.
unsetNotes() intThe optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
| def libsbml.Unit.unsetOffset | ( | self | ) |
Unsets the 'offset' attribute value of this Unit.
unsetOffset() int
|
inherited |
Unsets the value of the 'sboTerm' attribute of this SBML object.
unsetSBOTerm() int| def libsbml.Unit.unsetScale | ( | self | ) |
Unsets the 'scale' attribute value of this Unit.
unsetScale() int
|
inherited |
Unsets the user data of this element.
unsetUserData() int