|
libSBML Python API
5.18.0
|
|
libSBML Python API
5.18.0
|
The rule type AssignmentRule is derived from the parent class Rule. It is used to express equations that set the values of variables. The left-hand side (the attribute named 'variable') of an assignment rule must refer to the identifier of a Species, SpeciesReference (in SBML Level 3), Compartment, or global Parameter object in the model (but not a Reaction). In SBML Level 3 Version 2, it may also refer to the SId of an element defined in an SBML Level 3 package with mathematical meaning and the ability to be assigned. The entity identified must have its 'constant' attribute set to False. The effects of an assignment rule construct are in general terms the same, but differ in the precise details depending on the type of SBML component being set:
In the case of a species, an SBML assignment rule sets the referenced species' quantity (whether a 'concentration' or 'amount') to the value determined by the formula in the MathML subelement 'math'. The unit associated with the value produced by the 'math' formula should (in SBML Level 2 Version 4 and in SBML Level 3) or must (in SBML releases prior to Level 2 version 4) be equal to the unit associated with the species' quantity. Restrictions: There must not be both an AssignmentRule 'variable' attribute and a SpeciesReference 'species' attribute having the same value in a model, unless the referenced Species object has its 'boundaryCondition' attribute set to True. In other words, an assignment rule cannot be defined for a species that is created or destroyed in a reaction unless that species is defined as a boundary condition in the model.
(For SBML Level 3 only) In the case of a species reference, an assignment rule sets the stoichiometry of the referenced reactant or product to the value determined by the formula in 'math'. The unit associated with the value produced by the 'math' formula should be consistent with the unit 'dimensionless', because reactant and product stoichiometries in reactions are dimensionless quantities.
In the case of a compartment, an SBML assignment rule sets the referenced compartment's size to the value determined by the formula in the 'math' subelement of the AssignmentRule object. The overall units of the formula in 'math' should (in SBML Level 2 Version 4 and in SBML Level 3) or must (in SBML releases prior to Level 2 version 4) be the same as the units of the size of the compartment.
In the case of a parameter, an assignment rule sets the referenced parameter's value to that determined by the formula in the 'math' subelement of the AssignmentRule object. The overall units of the formula in the 'math' subelement should (in SBML Level 2 Version 4 and in SBML Level 3) or must (in SBML releases prior to Level 2 version 4) be the same as the units defined for the parameter.
(For SBML Level 3 Version 2 only) In the case of an object from an SBML Level 3 package, an AssignmentRule sets the referenced object's value (as defined by that package) to the value of the formula in math. The unit of measurement associated with the value produced by the formula should be the same as that object's units attribute value (if it has such an attribute), or be equal to the units of model components of that type (if objects of that class are defined by the package as having the same units).
In SBML Level 2 and Level 3 Version 1, the 'math' subelement of the AssignmentRule is required. In SBML Level 3 Version 2, this rule is relaxed, and the subelement is optional. If an AssignmentRule with no 'math' child is present in the model, the value of its referenced 'variable' is undefined. This may represent a situation where the model itself is unfinished, or the missing information may be provided by an SBML Level 3 package.
If the variable attribute of an AssignmentRule object references an object in an SBML namespace not understood by the interpreter reading a given SBML document (that is, if the object is defined by an SBML Level 3 package that the software does not support), the assignment rule must be ignored–the object's value will not need to be set, as the interpreter could not understand that package. If an interpreter cannot establish whether a referenced object is missing from the model or instead is defined in an SBML namespace not understood by the interpreter, it may produce a warning to the user. (The latter situation may only arise if an SBML package is present in the SBML document with a package:required attribute of 'true'.)
In the context of a simulation, assignment rules are in effect at all times, t >= 0. For purposes of evaluating expressions that involve the delay 'csymbol' (see the SBML Level 2 specification), assignment rules are considered to apply also at t <= 0. Please consult the relevant SBML specification for additional information about the semantics of assignments, rules, and entity values for simulation time t <= 0.
A model must not contain more than one AssignmentRule or RateRule object having the same value of 'variable'; in other words, in the set of all assignment rules and rate rules in an SBML model, each variable appearing in the left-hand sides can only appear once. This simply follows from the fact that an indeterminate system would result if a model contained more than one assignment rule for the same variable or both an assignment rule and a rate rule for the same variable.
Similarly, a model must also not contain both an AssignmentRule and an InitialAssignment definition for the same variable, because both kinds of constructs apply prior to and at the start of simulation time, i.e., t <= 0. If a model contained both an initial assignment and an assignment rule for the same variable, an indeterminate system would result.
The value calculated by an AssignmentRule object overrides the value assigned to the given symbol by the model component defining that symbol. For example, if a Compartment object's 'size' attribute value is set in its definition, and the model also contains an AssignmentRule object having that compartment's 'id' as its 'variable' value, then the 'size' assigned in the Compartment object definition is ignored and the value assigned based on the computation defined in the AssignmentRule. This does not mean that a definition for a given symbol can be omitted if there is an AssignmentRule object involving it. For example, there must be a Parameter object definition for a given parameter if there is an AssignmentRule definition for that parameter. It is only a question of which value definition takes precedence.
In SBML Level 3 as well as Level 2, rules are separated into three subclasses for the benefit of model analysis software. The three subclasses are based on the following three different possible functional forms (where x is a variable, f is some arbitrary function returning a numerical result, V is a vector of variables that does not include x, and W is a vector of variables that may include x):
| Algebraic: | left-hand side is zero | 0 = f(W) |
| Assignment: | left-hand side is a scalar: | x = f(V) |
| Rate: | left-hand side is a rate-of-change: | dx/dt = f(W) |
In their general form given above, there is little to distinguish between assignment and algebraic rules. They are treated as separate cases for the following reasons:
The approach taken to covering these cases in SBML is to define an abstract Rule structure containing a subelement, 'math', to hold the right-hand side expression, then to derive subtypes of Rule that add attributes to distinguish the cases of algebraic, assignment and rate rules. The 'math' subelement must contain a MathML expression defining the mathematical formula of the rule. This MathML formula must return a numerical value. The formula can be an arbitrary expression referencing the variables and other entities in an SBML model.
Each of the three subclasses of Rule (AssignmentRule, AlgebraicRule, RateRule) inherit the the 'math' subelement and other fields from SBase. The AssignmentRule and RateRule classes add an additional attribute, 'variable'. See the definitions of AssignmentRule, AlgebraicRule and RateRule for details about the structure and interpretation of each one.
An important design goal of SBML rule semantics is to ensure that a model's simulation and analysis results will not be dependent on when or how often rules are evaluated. To achieve this, SBML needs to place two restrictions on rule use. The first concerns algebraic loops in the system of assignments in a model, and the second concerns overdetermined systems.
The combined set of InitialAssignment, AssignmentRule and KineticLaw objects in a model constitute a set of assignment statements that should be considered as a whole. (A KineticLaw object is counted as an assignment because it assigns a value to the symbol contained in the 'id' attribute of the Reaction object in which it is defined.) This combined set of assignment statements must not contain algebraic loops—dependency chains between these statements must terminate. To put this more formally, consider a directed graph in which nodes are assignment statements and directed arcs exist for each occurrence of an SBML species, compartment or parameter symbol in an assignment statement's 'math' subelement. Let the directed arcs point from the statement assigning the symbol to the statements that contain the symbol in their 'math' subelement expressions. This graph must be acyclic.
Similarly, the combined set of RateRule and Reaction objects constitute a set of definitions for the rates of change of various model entities (namely, the objects identified by the values of the 'variable' attributes of the RateRule objects, and the 'species' attributes of the SpeciesReference objects in each Reaction). In SBML Level 3 Version 2, these rates of change may be referenced directly using the rateOf csymbol, but may not thereby contain algebraic loops—dependency chains between these statements must terminate. More formally, consider a directed graph in which the nodes are the definitions of different variables' rates of change, and directed arcs exist for each occurrence of a variable referenced by a rateOf csymbol from any RateRule or KineticLaw object in the model. Let the directed arcs point from the variable referenced by the rateOf csymbol (call it x) to the variable(s) determined by the 'math' expression in which x appears. This graph must be acyclic.
SBML does not specify when or how often rules should be evaluated. Eliminating algebraic loops ensures that assignment statements can be evaluated any number of times without the result of those evaluations changing. As an example, consider the set of equations x = x + 1, y = z + 200 and z = y + 100. If this set of equations were interpreted as a set of assignment statements, it would be invalid because the rule for x refers to x (exhibiting one type of loop), and the rule for y refers to z while the rule for z refers back to y (exhibiting another type of loop). Conversely, the following set of equations would constitute a valid set of assignment statements: x = 10, y = z + 200, and z = x + 100.
An SBML model must not be overdetermined; that is, a model must not define more equations than there are unknowns in a model. A valid SBML model that does not contain AlgebraicRule structures cannot be overdetermined.
LibSBML implements the static analysis procedure described in Appendix B of the SBML Level 3 specification for assessing whether a model is overdetermined.
(In summary, assessing whether a given continuous, deterministic, mathematical model is overdetermined does not require dynamic analysis; it can be done by analyzing the system of equations created from the model. One approach is to construct a bipartite graph in which one set of vertices represents the variables and the other the set of vertices represents the equations. Place edges between vertices such that variables in the system are linked to the equations that determine them. For algebraic equations, there will be edges between the equation and each variable occurring in the equation. For ordinary differential equations (such as those defined by rate rules or implied by the reaction rate definitions), there will be a single edge between the equation and the variable determined by that differential equation. A mathematical model is overdetermined if the maximal matchings of the bipartite graph contain disconnected vertexes representing equations. If one maximal matching has this property, then all the maximal matchings will have this property; i.e., it is only necessary to find one maximal matching.)
SBML Level 1 uses a different scheme than SBML Level 2 and Level 3 for distinguishing rules; specifically, it uses an attribute whose value is drawn from an enumeration of 3 values. LibSBML supports this using methods that work with the enumeration values listed below.
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 | clone (self) |
| Creates and returns a deep copy of this AssignmentRule object. More... | |
| def | connectToChild (self) |
| def | containsUndeclaredUnits (self, args) |
Predicate returning True if the math expression of this Rule contains parameters/numbers with undeclared units. 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 | getDerivedUnitDefinition (self, args) |
| Calculates and returns a UnitDefinition that expresses the units of measurement assumed for the 'math' expression of this Rule. 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. More... | |
| def | getFormula (self) |
| Returns the mathematical expression of this Rule in text-string form. More... | |
| def | getId (self) |
| Returns the value of the 'variable' attribute of this Rule (NOT the 'id'). More... | |
| def | getIdAttribute (self) |
| Returns the value of the 'id' attribute of this SBML object. More... | |
| def | getL1TypeCode (self) |
| Returns the SBML Level 1 type code for this Rule object. 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 | getMath (self) |
| Get the mathematical formula of this Rule as an ASTNode tree. 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 | 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 | 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 | getType (self) |
| Returns a code representing the type of rule this is. More... | |
| def | getTypeCode (self) |
| Returns the libSBML type code for this SBML object. More... | |
| def | getUnits (self) |
| Returns the units for the mathematical formula of this Rule. More... | |
| def | getURI (self) |
| Gets the namespace URI to which this element belongs to. More... | |
| def | getVariable (self) |
| Get the value of the 'variable' attribute of this Rule object. 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 AssignmentRule object have been set. More... | |
| def | hasRequiredElements (self) |
Predicate returning True if all the required elements for this Rule 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 | isAlgebraic (self) |
Predicate returning True if this Rule is an AlgebraicRule. More... | |
| def | isAssignment (self) |
Predicate returning True if this Rule is an AssignmentRule. More... | |
| def | isCompartmentVolume (self) |
Predicate returning True if this Rule is an CompartmentVolumeRule or equivalent. 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 | isParameter (self) |
Predicate returning True if this Rule is an ParameterRule or equivalent. 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 | isRate (self) |
Predicate returning True if this Rule is a RateRule (SBML Levels 2–3) or has a 'type' attribute value of 'rate' (SBML Level 1). More... | |
| def | isScalar (self) |
Predicate returning True if this Rule is an AssignmentRule (SBML Levels 2–3) or has a 'type' attribute value of 'scalar' (SBML Level 1). More... | |
| def | isSetAnnotation (self) |
Predicate returning True if this object's 'annotation' subelement exists and has content. More... | |
| def | isSetFormula (self) |
Predicate returning True if this Rule's mathematical expression 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 | isSetMath (self) |
Predicate returning True if this Rule's mathematical expression 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 | 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 | isSetSBOTerm (self) |
Predicate returning True if this object's 'sboTerm' attribute is set. More... | |
| def | isSetUnits (self) |
Predicate returning True if this Rule's 'units' attribute 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 | isSetVariable (self) |
Predicate returning True if this Rule's 'variable' attribute is set. More... | |
| def | isSpeciesConcentration (self) |
Predicate returning True if this Rule is a SpeciesConcentrationRule or equivalent. 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 | removeFromParentAndDelete (self) |
| Removes this object from its parent. 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 | setFormula (self, formula) |
| Sets the 'math' subelement of this Rule to an expression in text-string form. 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 | setL1TypeCode (self, type) |
| Sets the SBML Level 1 type code for this Rule. More... | |
| def | setMath (self, math) |
| Sets the 'math' subelement of this Rule to a copy of the given ASTNode. 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 | 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 | setSBOTerm (self, args) |
| This method has multiple variants; they differ in the arguments they accept. More... | |
| def | setUnits (self, sname) |
| Sets the units for this Rule. More... | |
| def | setVariable (self, sid) |
| Sets the 'variable' attribute value of this Rule object. 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 | 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 | 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 | 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 | unsetSBOTerm (self) |
| Unsets the value of the 'sboTerm' attribute of this SBML object. More... | |
| def | unsetUnits (self) |
| Unsets the 'units' for this Rule. More... | |
| def | unsetUserData (self) |
| Unsets the user data of this element. More... | |
| def | unsetVariable (self) |
| Unsets the value of the 'variable' attribute of this Rule object. More... | |
| def libsbml.AssignmentRule.__init__ | ( | self, | |
| args | |||
| ) |
This method has multiple variants; they differ in the arguments they accept.
__init__(long level, long version) AssignmentRule __init__(SBMLNamespaces sbmlns) AssignmentRule
Each variant is described separately below.
AssignmentRule(SBMLNamespaces sbmlns)
Creates a new AssignmentRule using the given SBMLNamespaces object sbmlns.
| sbmlns | an SBMLNamespaces object. |
| ValueError | Thrown if the given sbmlns is inconsistent or incompatible with this object. |
AssignmentRule(long level, long version)
Creates a new AssignmentRule using the given SBML level and version values.
| level | a long integer, the SBML Level to assign to this AssignmentRule. |
| version | a long integer, the SBML Version to assign to this AssignmentRule. |
| ValueError | Thrown if the given level and version combination are invalid or if this object is incompatible with the given level and version. |
|
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.AssignmentRule.clone | ( | self | ) |
Creates and returns a deep copy of this AssignmentRule object.
clone() AssignmentRule
|
inherited |
connectToChild()
|
inherited |
Predicate returning True if the math expression of this Rule contains parameters/numbers with undeclared units.
containsUndeclaredUnits() boolTrue if the math expression of this Rule includes parameters/numbers with undeclared units, False otherwise.True indicates that the UnitDefinition returned by getDerivedUnitDefinition() may not accurately represent the units of the expression.
|
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 |
Calculates and returns a UnitDefinition that expresses the units of measurement assumed for the 'math' expression of this Rule.
getDerivedUnitDefinition() UnitDefinition
<ci> elements used within that expression. The method Rule.getDerivedUnitDefinition() returns the calculated units, to the extent that libSBML can compute them.None.None if one cannot be constructed.
|
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. |
|
inherited |
Returns the XML element name of this object.
getElementName() stringThe returned value can be any of a number of different strings, depending on the SBML Level in use and the kind of Rule object this is. The rules as of libSBML version 5.18.0 are the following:
'rateRule' 'assignmentRule' 'algebraicRule' 'specieConcentrationRule' 'speciesConcentrationRule' 'compartmentVolumeRule' 'parameterRule' 'unknownRule' Beware that the last ('unknownRule') is not a valid SBML element name.
|
inherited |
Returns the mathematical expression of this Rule in text-string form.
getFormula() stringThe text string is produced by formulaToString(); please consult the documentation for that function to find out more about the format of the text-string formula.
|
inherited |
Returns the value of the 'variable' attribute of this Rule (NOT the 'id').
getId() stringThe 'variable' attribute of a Rule indicates the element which the results of the 'math' are to be applied. An AlgebraicRule has no 'variable', and will always return an empty string.
|
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.
|
inherited |
Returns the SBML Level 1 type code for this Rule object.
getL1TypeCode() intThis method only applies to SBML Level 1 model objects. If this is not an SBML Level 1 rule object, this method will return SBML_UNKNOWN.
|
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 |
Get the mathematical formula of this Rule as an ASTNode tree.
getMath() ASTNode
|
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.
|
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
|
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.
|
inherited |
Returns a code representing the type of rule this is.
getType() long
|
inherited |
Returns the libSBML type code for this SBML object.
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 |
|
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 |
Get the value of the 'variable' attribute of this Rule object.
getVariable() stringThe 'variable' attribute of a Rule indicates the element which the results of the 'math' are to be applied. An AlgebraicRule has no 'variable', and will always return an empty string.
None if this object is an AlgebraicRule object, or if the attribute is unset.
|
inherited |
Returns the Version within the SBML Level of the SBMLDocument object containing this object.
getVersion() long| def libsbml.AssignmentRule.hasRequiredAttributes | ( | self | ) |
Predicate returning True if all the required attributes for this AssignmentRule object have been set.
hasRequiredAttributes() boolIn SBML Levels 2–3, the only required attribute for an AssignmentRule object is 'variable'. For Level 1, where the equivalent attribute is known by different names ('compartment', 'species', or 'name', depending on the type of object), there is an additional required attribute called 'formula'.
True if the required attributes have been set, False otherwise.
|
inherited |
Predicate returning True if all the required elements for this Rule object have been set.
hasRequiredElements() boolThe only required element for a Rule object is the 'math' subelement in SBML Level 2 and Level 3 Version 1. In SBML Level 3 Version 2+, it is no longer required.
|
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.
|
inherited |
Predicate returning True if this Rule is an AlgebraicRule.
isAlgebraic() boolTrue if this Rule is an AlgebraicRule, False otherwise.
|
inherited |
Predicate returning True if this Rule is an AssignmentRule.
isAssignment() boolTrue if this Rule is an AssignmentRule, False otherwise.
|
inherited |
Predicate returning True if this Rule is an CompartmentVolumeRule or equivalent.
isCompartmentVolume() boolThis libSBML method works for SBML Level 1 models (where there is such a thing as an explicit CompartmentVolumeRule), as well as other Levels of SBML. For Levels above Level 1, this method checks the symbol being affected by the rule, and returns True if the symbol is the identifier of a Compartment object defined in the model.
True if this Rule is a CompartmentVolumeRule, False otherwise.
|
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.
|
inherited |
Predicate returning True if this Rule is an ParameterRule or equivalent.
isParameter() boolThis libSBML method works for SBML Level 1 models (where there is such a thing as an explicit ParameterRule), as well as other Levels of SBML. For Levels above Level 1, this method checks the symbol being affected by the rule, and returns True if the symbol is the identifier of a Parameter object defined in the model.
True if this Rule is a ParameterRule, False otherwise.
|
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.
|
inherited |
|
inherited |
Predicate returning True if this Rule is an AssignmentRule (SBML Levels 2–3) or has a 'type' attribute value of 'scalar' (SBML Level 1).
isScalar() boolTrue if this Rule is an AssignmentRule (Level 2) or has type 'scalar' (Level 1), False otherwise.
|
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.
|
inherited |
Predicate returning True if this Rule's mathematical expression is set.
isSetFormula() boolThis method is equivalent to isSetMath(). This version is present for easier compatibility with SBML Level 1, in which mathematical formulas were written in text-string form.
True if the mathematical formula for this Rule is set, False otherwise.
|
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.
|
inherited |
Predicate returning True if this Rule's mathematical expression is set.
isSetMath() boolThis method is equivalent to isSetFormula().
True if the formula (or equivalently the math) for this Rule is set, False otherwise.
|
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.
|
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.
|
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.
|
inherited |
|
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.
|
inherited |
Predicate returning True if this Rule's 'variable' attribute is set.
isSetVariable() boolTrue if the 'variable' attribute value of this Rule is set, False otherwise.
|
inherited |
Predicate returning True if this Rule is a SpeciesConcentrationRule or equivalent.
isSpeciesConcentration() boolThis libSBML method works for SBML Level 1 models (where there is such a thing as an explicit SpeciesConcentrationRule), as well as other Levels of SBML. For Levels above Level 1, this method checks the symbol being affected by the rule, and returns True if the symbol is the identifier of a Species object defined in the model.
True if this Rule is a SpeciesConcentrationRule, False otherwise.
|
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.
|
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.
|
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. |
| def libsbml.AssignmentRule.renameSIdRefs | ( | self, | |
| oldid, | |||
| newid | |||
| ) |
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. |
|
inherited |
Sets the 'math' subelement of this Rule to an expression in text-string form.
setFormula(string formula) intThis is equivalent to setMath(ASTNode math). The provision of using text-string formulas is retained for easier SBML Level 1 compatibility. The formula is converted to an ASTNode internally.
| formula | a mathematical formula in text-string form. |
|
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. |
|
inherited |
Sets the SBML Level 1 type code for this Rule.
setL1TypeCode(int type) int| type | the SBML Level 1 type code for this Rule. The allowable values are SBML_COMPARTMENT_VOLUME_RULE, SBML_PARAMETER_RULE, and SBML_SPECIES_CONCENTRATION_RULE. |
type value is not one of the above.
|
inherited |
Sets the 'math' subelement of this Rule to a copy of the given ASTNode.
setMath(ASTNode math) int
| math | the AST structure of the mathematical formula. |
|
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. |
|
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. |
|
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.
|
inherited |
Sets the units for this Rule.
setUnits(string sname) int| sname | the identifier of the units. |
|
inherited |
Sets the 'variable' attribute value of this Rule object.
setVariable(string sid) int| sid | the identifier of a Compartment, Species or Parameter elsewhere in the enclosing Model object. |
|
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
|
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.
|
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
|
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.
|
inherited |
Unsets the value of the 'sboTerm' attribute of this SBML object.
unsetSBOTerm() int
|
inherited |
Unsets the 'units' for this Rule.
unsetUnits() int
|
inherited |
Unsets the user data of this element.
unsetUserData() int
|
inherited |
Unsets the value of the 'variable' attribute of this Rule object.
unsetVariable() int