libSBML Python API
5.18.0
|
LibSBML uses the class SBMLDocument as a top-level container for storing SBML content and data associated with it (such as warnings and error messages). The two primary means of reading an SBML model, SBMLReader.readSBML() and SBMLReader.readSBMLFromString(), both return a pointer to an SBMLDocument object. From there, callers can inquire about any errors encountered (e.g., using SBMLDocument.getNumErrors()), access the Model object, and perform other actions such as consistency-checking and model translation.
When creating fresh models programmatically, the starting point is typically the creation of an SBMLDocument object instance. The SBMLDocument constructor accepts arguments for the SBML Level and Version of the model to be created. After creating the SBMLDocument object, calling programs then typically call SBMLDocument.createModel() almost immediately, and then proceed to call the methods on the Model object to fill out the model's contents.
SBMLDocument corresponds roughly to the class Sbml defined in the SBML Level 2 specification and SBML in the Level 3 specification. It does not have a direct correspondence in SBML Level 1. (However, to make matters simpler for applications, libSBML creates an SBMLDocument no matter whether the model is Level 1, Level 2 or Level 3.) In its barest form, when written out in XML format for (e.g.) SBML Level 2 Version 4, the corresponding structure is the following:
<sbml xmlns='http://www.sbml.org/sbml/level2/version4' level='2' version='4'> ... </sbml>
SBMLDocument is derived from SBase, and therefore contains the usual SBase attributes (in SBML Level 2 and Level 3) of 'metaid' and 'sboTerm', as well as the subelements 'notes' and 'annotation'. It also contains the attributes 'level' and 'version' indicating the Level and Version of the SBML data structure. These can be accessed using the methods defined by the SBase class for that purpose.
One of the most important features of libSBML is its ability to perform SBML validation to ensure that a model adheres to the SBML specification for whatever Level+Version combination the model uses. SBMLDocument provides the methods for running consistency-checking and validation rules on the SBML content.
First, a brief explanation of the rationale is in order. In libSBML versions up to and including the version 3.3.x series, the individual methods for creating and setting attributes and other components were quite lenient, and allowed a caller to compose SBML entities that might not, in the end, represent valid SBML. This allowed applications the freedom to do things such as save incomplete models (which is useful when models are being developed over long periods of time). In the version 4.x series, libSBML is somewhat stricter, but still permits structures to be created independently and the results to be combined in a separate step. In all these cases, it means that a separate validation step is necessary when a calling program finally wants to finish a complete SBML document.
The primary interface to this validation facility is SBMLDocument's SBMLDocument.checkInternalConsistency() and SBMLDocument.checkConsistency(). The former verifies the basic internal consistency and syntax of an SBML document, and the latter implements more elaborate validation rules (both those defined by the SBML specifications, as well as additional rules offered by libSBML).
The checks performed by SBMLDocument.checkInternalConsistency() are hardwired and cannot be changed by calling programs, but the validation performed by SBMLDocument.checkConsistency() is under program control using the method SBMLDocument.setConsistencyChecks(). Applications can selectively disable specific kinds of checks that they may not be interested in, by calling SBMLDocument.setConsistencyChecks() with appropriate parameters.
These methods have slightly different relevance depending on whether a model is created programmaticaly from scratch, or whether it is read in from a file or data stream. The following list summarizes the possible scenarios.
Scenario 1: Creating a model from scratch. Before writing out the model,
Scenario 2: Reading a model from a file or data stream. After reading the model,
It should be noted that as of SBML Level 3 Version 2, the Model became an optional child of SBMLDocument, instead of being required. This means that one can no longer use SBMLDocument.getModel() as a cheap method of checking if an SBML document was read in properly: the more robust getError methods detailed above must be used instead.
LibSBML provides facilities for limited translation of SBML between Levels and Versions of the SBML specifications. The method for doing is is setLevelAndVersion() . In general, models can be converted upward without difficulty (e.g., from SBML Level 1 to Level 2, or from an earlier Version of Level 2 to the latest Version of Level 2). Sometimes models can be translated downward as well, if they do not use constructs specific to more advanced Levels of SBML.
Calling SBMLDocument.setLevelAndVersion() will not necessarily lead to a successful conversion. The method will return a boolean value to indicate success or failure. Callers must check the error log (see next section) attached to the SBMLDocument object after calling SBMLDocument.setLevelAndVersion() in order to assess whether any problems arose.
If an application is interested in translating to a lower Level and/or Version of SBML within a Level, the following methods allow for prior assessment of whether there is sufficient compatibility to make a translation possible:
Some changes between Versions of SBML Level 2 may lead to unexpected behaviors when attempting conversions in either direction. For example, SBML Level 2 Version 4 relaxed the requirement for consistency in units of measurement between expressions annd quantities in a model. As a result, a model written in Version 4, if converted to Version 3 with no other changes, may fail validation as a Version 3 model because Version 3 imposed stricter requirements on unit consistency.
Other changes between SBML Level 2 and Level 3 make downward conversions challenging. In some cases, it means that a model converted to Level 2 from Level 3 will contain attributes that were not explicitly given in the Level 3 model, because in Level 2 these attributes may have been optional or have default values.
Upon reading a model, SBMLDocument logs any problems encountered while reading the model from the file or data stream. The log contains objects that record diagnostic information about any notable issues that arose. Whether the problems are warnings or errors, they are both reported through a single common interface involving the object class SBMLError.
The methods SBMLDocument.getNumErrors(), SBMLDocument.getError() and SBMLDocument.printErrors() allow callers to interact with the warnings or errors logged. Alternatively, callers may retrieve the entire log as an SBMLErrorLog object using the method SBMLDocument.getErrorLog(). The SBMLErrorLog object provides some alternative methods for interacting with the set of errors and warnings. In either case, applications typically should first call SBMLDocument.getNumErrors() to find out if any issues have been logged after specific libSBML operations such as the ones discussed in the sections above. If they have, then an application will should proceed to inspect the individual reports using either the direct interfaces on SBMLDocument or using the methods on the SBMLErrorLog object.
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 | checkConsistency (self) |
Performs consistency checking and validation on this SBML document. More... | |
def | checkConsistencyWithStrictUnits (self) |
Performs consistency checking and validation on this SBML document using the ultra strict units validator that assumes that there are no hidden numerical conversion factors. More... | |
def | checkInternalConsistency (self) |
Performs consistency checking on libSBML's internal representation of an SBML Model. More... | |
def | checkL1Compatibility (self, inConversion=False) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 1 and can be converted to Level 1. More... | |
def | checkL2v1Compatibility (self, inConversion=False) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 2 Version 1 and can be converted to Level 2 Version 1. More... | |
def | checkL2v2Compatibility (self, inConversion=False) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 2 Version 2 and can be converted to Level 2 Version 2. More... | |
def | checkL2v3Compatibility (self, inConversion=False) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 2 Version 3 and can be converted to Level 2 Version 3. More... | |
def | checkL2v4Compatibility (self) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 2 Version 4 and can be converted to Level 2 Version 4. More... | |
def | checkL2v5Compatibility (self) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 2 Version 5 and can be converted to Level 2 Version 5. More... | |
def | checkL3v1Compatibility (self) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 3 Version 1 and can be converted to Level 3 Version 1. More... | |
def | checkL3v2Compatibility (self) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 3 Version 2 and can be converted to Level 3 Version 2. More... | |
def | clone (self) |
Creates and returns a deep copy of this SBMLDocument object. More... | |
def | connectToChild (self) |
def | convert (self, props) |
Converts this document using the converter that best matches the given conversion properties. More... | |
def | createModel (self, args) |
Creates a new Model inside this SBMLDocument, and returns a pointer to it. 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 | enableDefaultNS (self, package, flag) |
Set/unset default namespace to each top-level element defined in the given package extension. More... | |
def | enablePackage (self, pkgURI, pkgPrefix, flag) |
Enables or disables the given SBML Level 3 package on this object. More... | |
def | expandFunctionDefinitions (self) |
Removes FunctionDefinition constructs from the document and expands any instances of their use within <math> elements. More... | |
def | expandInitialAssignments (self) |
Removes InitialAssignment constructs from the document and replaces them with appropriate values. 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 | getDefaultLevel () |
The default SBML Level of new SBMLDocument objects. More... | |
def | getDefaultVersion () |
The default Version of new SBMLDocument objects. 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, metaid) |
Returns the first child element it can find with the given metaid , or itself if it has the given metaid , or None if no such object is found. More... | |
def | getElementBySId (self, id) |
Returns the first child element found that has the given id in the model-wide SId namespace, or None if no such object is found. More... | |
def | getElementName (self) |
Returns the XML element name of this object, which for SBMLDocument, is always 'sbml' . More... | |
def | getError (self, n) |
Returns the nth error or warning encountered during parsing, consistency checking, or attempted translation of this model. More... | |
def | getErrorLog (self, args) |
Returns the list of errors or warnings logged during parsing, consistency checking, or attempted translation of this model. More... | |
def | getErrorWithSeverity (self, n, severity) |
Returns the nth error or warning with the given severity encountered during parsing, consistency checking, or attempted translation of this model. More... | |
def | getId (self) |
Returns the value of the 'id' attribute of this SBML object, if it has one, or the 'variable' attribute of a Rule, or the 'symbol' attribute of an InitialAssignment. More... | |
def | getIdAttribute (self) |
Returns the value of the 'id' attribute of this SBML object. More... | |
def | 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 | getLocationURI (self, args) |
Get the location of this SBMLDocument. 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 | getModel (self, args) |
Returns the Model object stored in this SBMLDocument. 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 XML Namespaces associated with the XML content of this SBML document. 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 | getNumErrors (self, args) |
This method has multiple variants; they differ in the arguments they accept. 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 | getPackageRequired (self, package) |
Returns the required attribute of the given package extension. 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 | getPkgRequired (self, package) |
Returns the required attribute of the given package extension. 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 | getTypeCode (self) |
Returns the libSBML type code for this SBML object. More... | |
def | getURI (self) |
Gets the namespace URI to which this element belongs to. More... | |
def | getVersion (self) |
Returns the Version within the SBML Level of the SBMLDocument object containing this object. More... | |
def | hasValidLevelVersionNamespaceCombination (self) |
Predicate returning true if this object's level/version and namespace values correspond to a valid SBML specification. More... | |
def | isDisabledIgnoredPackage (self, pkgURI) |
Returns True if the given package extension is one of an ignored packages that has been disabled, otherwise returns False . More... | |
def | isEnabledDefaultNS (self, package) |
Returns True if a default namespace is added to each top-level element defined in the given package extension, otherwise returns False . More... | |
def | isIgnoredPackage (self, pkgURI) |
Returns True if the given package extension is one of an ignored packages, otherwise returns False . More... | |
def | isIgnoredPkg (self, pkgURI) |
Returns True if the given package extension is one of ignored packages, otherwise returns False . 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 | 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 | isSetAnnotation (self) |
Predicate returning True if this object's 'annotation' subelement exists and has content. 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 | isSetMetaId (self) |
Predicate returning True if this object's 'metaid' attribute is set. More... | |
def | isSetModel (self) |
Returns True if the Model object has been set, otherwise returns False . 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 | isSetPackageRequired (self, package) |
Returns True if the required attribute of the given package extension is defined, otherwise returns False . More... | |
def | isSetPkgRequired (self, package) |
Returns True if the required attribute of the given package extension is defined, otherwise returns False . More... | |
def | isSetSBOTerm (self) |
Predicate returning True if this object's 'sboTerm' 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 | 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 | printErrors (self, args) |
This method has multiple variants; they differ in the arguments they accept. 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 | setConsistencyChecks (self, category, apply) |
def | setConsistencyChecksForConversion (self, category, apply) |
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 | setLevelAndVersion (self, level, version, strict=True, ignorePackages=False) |
Sets the SBML Level and Version of this SBMLDocument instance, attempting to convert the model as needed. More... | |
def | setLocationURI (self, uri) |
Sets the location of this SBMLDocument. More... | |
def | setMetaId (self, metaid) |
Sets the value of the meta-identifier attribute of this SBML object. More... | |
def | setModel (self, m) |
Sets the Model for this SBMLDocument to a copy of the given Model. 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 | setPackageRequired (self, package, flag) |
Sets the required attribute value of the given package extension. More... | |
def | setPkgRequired (self, package, flag) |
Sets the value of the required attribute for the given package. More... | |
def | setSBOTerm (self, args) |
This method has multiple variants; they differ in the arguments they accept. 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 | unsetUserData (self) |
Unsets the user data of this element. More... | |
def | validateSBML (self) |
Performs consistency checking and validation on this SBML document. More... | |
def libsbml.SBMLDocument.__init__ | ( | self, | |
args | |||
) |
This method has multiple variants; they differ in the arguments they accept.
__init__(long level=0, long version=0) SBMLDocument __init__(long level=0) SBMLDocument __init__() SBMLDocument __init__(SBMLNamespaces sbmlns) SBMLDocument __init__(SBMLDocument orig) SBMLDocument
Each variant is described separately below.
SBMLDocument(SBMLNamespaces sbmlns)
Creates a new SBMLDocument using the given SBMLNamespaces object sbmlns
.
sbmlns | an SBMLNamespaces object. |
ValueError | Thrown if the given sbmlns is inconsistent or incompatible with this object. |
SBMLDocument(long level = 0, long version = 0)
Creates a new SBMLDocument, optionally with given values for the SBML Level and Version.
If both the SBML Level and Version attributes are not specified, the SBML document is treated as having the latest Level and Version of SBML as determined by SBMLDocument.getDefaultLevel() and SBMLDocument.getDefaultVersion(); however, the SBMLDocument object is otherwise left blank. In particular, the blank SBMLDocument object has no associated XML attributes, including (but not limited to) an XML namespace declaration. The XML namespace declaration is not added until the model is written out, or the method SBMLDocument.setLevelAndVersion() is called. This may be important to keep in mind if an application needs to add additional XML namespace declarations on the <sbml>
element. Application writers should either provide values for level
and version
on the call to this constructor, or else call SBMLDocument.setLevelAndVersion() shortly after creating the SBMLDocument object.
level | an integer for the SBML Level. |
version | an integer for the Version within the SBML Level. |
ValueError | Thrown if the given level and version combination are invalid or if this object is incompatible with the given level and version. |
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.SBMLDocument(SBMLDocument orig)
Copy constructor; creates a copy of this SBMLDocument.
orig | the object to copy. |
|
inherited |
Adds a copy of the given CVTerm object to this SBML object.
addCVTerm(CVTerm term, bool newBag) int addCVTerm(CVTerm term) int
term | the CVTerm to assign. |
newBag | if True , creates a new RDF bag with the same identifier as a previous bag, and if False , adds the term to an existing RDF bag with the same type of qualifier as the term being added. |
create
) for alternatives that do not lead to these issues.parameter
= value
. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
appendAnnotation(XMLNode annotation) int appendAnnotation(string annotation) int
Each variant is described separately below.
appendAnnotation(XMLNode annotation)
Appends the given annotation
to the 'annotation' subelement of this object.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Unlike SBase.setAnnotation() or SBase.setAnnotation(), this method allows other annotations to be preserved when an application adds its own data.
annotation | an XML structure that is to be copied and appended to the content of the 'annotation' subelement of this object. |
appendAnnotation(string annotation)
Appends the given annotation
to the 'annotation' subelement of this object.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Unlike SBase.setAnnotation() or SBase.setAnnotation(), this method allows other annotations to be preserved when an application adds its own data.
annotation | an XML string that is to be copied and appended to the content of the 'annotation' subelement of this object. |
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
appendNotes(XMLNode notes) int appendNotes(string notes) int
Each variant is described separately below.
appendNotes(string notes)
Appends the given notes
to the 'notes' subelement of this object.
The content of the parameter notes
is copied.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
notes | an XML string that is to appended to the content of the 'notes' subelement of this object. |
appendNotes(XMLNode notes)
Appends the given notes
to the 'notes' subelement of this object.
The content of notes
is copied.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
notes | an XML node structure that is to appended to the content of the 'notes' subelement of this object. |
def libsbml.SBMLDocument.checkConsistency | ( | self | ) |
Performs consistency checking and validation on this SBML document.
checkConsistency() long
If this method returns a nonzero value (meaning, one or more consistency checks have failed for SBML document), the failures may be due to warnings or errors. Callers should inspect the severity flag in the individual SBMLError objects returned by SBMLDocument.getError() to determine the nature of the failures.
def libsbml.SBMLDocument.checkConsistencyWithStrictUnits | ( | self | ) |
Performs consistency checking and validation on this SBML document using the ultra strict units validator that assumes that there are no hidden numerical conversion factors.
checkConsistencyWithStrictUnits() long
If this method returns a nonzero value (meaning, one or more consistency checks have failed for SBML document), the failures may be due to warnings or errors. Callers should inspect the severity flag in the individual SBMLError objects returned by SBMLDocument.getError() to determine the nature of the failures.
def libsbml.SBMLDocument.checkInternalConsistency | ( | self | ) |
Performs consistency checking on libSBML's internal representation of an SBML Model.
checkInternalConsistency() long
Callers should query the results of the consistency check by calling SBMLDocument.getError().
The distinction between this method and SBMLDocument.checkConsistency() is that this method reports on fundamental syntactic and structural errors that violate the XML Schema for SBML; by contrast, SBMLDocument.checkConsistency() performs more elaborate model verifications and also validation according to the validation rules written in the appendices of the SBML Level 2 Versions 2–4 specification documents.
def libsbml.SBMLDocument.checkL1Compatibility | ( | self, | |
inConversion = False |
|||
) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 1 and can be converted to Level 1.
checkL1Compatibility(bool inConversion) long checkL1Compatibility() long
Callers should query the results of the consistency check by calling SBMLDocument.getError().
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. def libsbml.SBMLDocument.checkL2v1Compatibility | ( | self, | |
inConversion = False |
|||
) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 2 Version 1 and can be converted to Level 2 Version 1.
checkL2v1Compatibility(bool inConversion) long checkL2v1Compatibility() long
Callers should query the results of the consistency check by calling SBMLDocument.getError().
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. def libsbml.SBMLDocument.checkL2v2Compatibility | ( | self, | |
inConversion = False |
|||
) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 2 Version 2 and can be converted to Level 2 Version 2.
checkL2v2Compatibility(bool inConversion) long checkL2v2Compatibility() long
Callers should query the results of the consistency check by calling SBMLDocument.getError().
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. def libsbml.SBMLDocument.checkL2v3Compatibility | ( | self, | |
inConversion = False |
|||
) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 2 Version 3 and can be converted to Level 2 Version 3.
checkL2v3Compatibility(bool inConversion) long checkL2v3Compatibility() long
Callers should query the results of the consistency check by calling SBMLDocument.getError().
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. def libsbml.SBMLDocument.checkL2v4Compatibility | ( | self | ) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 2 Version 4 and can be converted to Level 2 Version 4.
checkL2v4Compatibility() long
Callers should query the results of the consistency check by calling SBMLDocument.getError().
def libsbml.SBMLDocument.checkL2v5Compatibility | ( | self | ) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 2 Version 5 and can be converted to Level 2 Version 5.
checkL2v5Compatibility() long
Callers should query the results of the consistency check by calling SBMLDocument.getError().
def libsbml.SBMLDocument.checkL3v1Compatibility | ( | self | ) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 3 Version 1 and can be converted to Level 3 Version 1.
checkL3v1Compatibility() long
Callers should query the results of the consistency check by calling SBMLDocument.getError().
def libsbml.SBMLDocument.checkL3v2Compatibility | ( | self | ) |
Performs a set of consistency checks on the document to establish whether it is compatible with SBML Level 3 Version 2 and can be converted to Level 3 Version 2.
checkL3v2Compatibility() long
Callers should query the results of the consistency check by calling SBMLDocument.getError().
def libsbml.SBMLDocument.clone | ( | self | ) |
Creates and returns a deep copy of this SBMLDocument object.
clone() SBMLDocument
def libsbml.SBMLDocument.connectToChild | ( | self | ) |
connectToChild()
def libsbml.SBMLDocument.convert | ( | self, | |
props | |||
) |
Converts this document using the converter that best matches the given conversion properties.
convert(ConversionProperties props) int
props | the conversion properties to use. |
def libsbml.SBMLDocument.createModel | ( | self, | |
args | |||
) |
Creates a new Model inside this SBMLDocument, and returns a pointer to it.
createModel(string sid) Model createModel() Model
In SBML Level 2, the use of an identifier on a Model object is optional. This method takes an optional argument, sid
, for setting the identifier. If not supplied, the identifier attribute on the Model instance is not set.
sid | the identifier of the new Model to create. |
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 |
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) int
This 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. |
def libsbml.SBMLDocument.enableDefaultNS | ( | self, | |
package, | |||
flag | |||
) |
Set/unset default namespace to each top-level element defined in the given package extension.
enableDefaultNS(string package, bool flag) int
This works by adding a xmlns="..."
attribute. No prefix will be written when writing elements defined in the given package extension if True
is given as second argument.
package | the name or URI of the package extension. |
flag | boolean value to indicate whether to write a namespace prefix. |
|
inherited |
Enables or disables the given SBML Level 3 package on this object.
enablePackage(string pkgURI, string pkgPrefix, bool flag) int
This 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. |
def libsbml.SBMLDocument.expandFunctionDefinitions | ( | self | ) |
Removes FunctionDefinition constructs from the document and expands any instances of their use within <math>
elements.
expandFunctionDefinitions() bool
For example, suppose a Model contains a FunctionDefinition with identifier 'f'
representing the math expression: f(x, y) = x * y. Suppose further that there is a reaction in which the <math>
element of the KineticLaw object contains f(s, p)
, where s
and p
are other identifiers defined in the model. The outcome of invoking this method is that the <math>
of the KineticLaw now represents the expression s * p and the model no longer contains any FunctionDefinition objects.
True
if the transformation was successful, False
, otherwise.False
. def libsbml.SBMLDocument.expandInitialAssignments | ( | self | ) |
Removes InitialAssignment constructs from the document and replaces them with appropriate values.
expandInitialAssignments() bool
For example, suppose a Model contains a InitialAssignment to a symbol 'k'
where 'k'
is the identifier of a Parameter. The outcome of invoking this method is that the 'value' attribute of the Parameter definition is set to the result calculated using the InitialAssignment object's <math>
formula, and the corresponding InitialAssignment is then removed from the Model.
True
if the transformation was successful, False
, otherwise.False
. As part of that process, this method will check that it has values for any components referred to by the <math>
elements of InitialAssignment objects. In cases where not all of the values have been declared (e.g., if the mathematical expression refers to model entities that have no declared values), the InitialAssignment in question will not be removed and this method will return False
.
|
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() string
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 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() long
0
.
|
inherited |
|
inherited |
Returns a list of CVTerm objects in the annotations of this SBML object.
getCVTerms() List *
def libsbml.SBMLDocument.getDefaultLevel | ( | ) |
The default SBML Level of new SBMLDocument objects.
getDefaultLevel() long
def libsbml.SBMLDocument.getDefaultVersion | ( | ) |
The default Version of new SBMLDocument objects.
getDefaultVersion() long
|
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.def libsbml.SBMLDocument.getElementByMetaId | ( | self, | |
metaid | |||
) |
Returns the first child element it can find with the given metaid
, or itself if it has the given metaid
, or None
if no such object is found.
getElementByMetaId(string metaid) SBase
metaid | string representing the metaid of the object to find. |
metaid
. def libsbml.SBMLDocument.getElementBySId | ( | self, | |
id | |||
) |
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 of the object to find. |
id
. def libsbml.SBMLDocument.getElementName | ( | self | ) |
Returns the XML element name of this object, which for SBMLDocument, is always 'sbml'
.
getElementName() string
'sbml'
. def libsbml.SBMLDocument.getError | ( | self, | |
n | |||
) |
Returns the nth error or warning encountered during parsing, consistency checking, or attempted translation of this model.
getError(long n) SBMLError
Callers can use method XMLError.getSeverity() on the result to assess the severity of the problem. The possible severity levels range from informational messages to fatal errors.
n
, or return None
if n > (getNumErrors() - 1)
.n | the integer index of the error sought. |
def libsbml.SBMLDocument.getErrorLog | ( | self, | |
args | |||
) |
Returns the list of errors or warnings logged during parsing, consistency checking, or attempted translation of this model.
getErrorLog() SBMLErrorLog
def libsbml.SBMLDocument.getErrorWithSeverity | ( | self, | |
n, | |||
severity | |||
) |
Returns the nth error or warning with the given severity encountered during parsing, consistency checking, or attempted translation of this model.
getErrorWithSeverity(long n, long severity) SBMLError
n
, or return None
if n > (getNumErrors(severity) - 1)
.n | the integer index of the error sought. |
severity | the severity of the error sought. |
|
inherited |
Returns the value of the 'id' attribute of this SBML object, if it has one, or the 'variable' attribute of a Rule, or the 'symbol' attribute of an InitialAssignment.
getId() string
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.
|
inherited |
Returns the value of the 'id' attribute of this SBML object.
getIdAttribute() string
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.
|
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() long
0
.
|
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.
def libsbml.SBMLDocument.getLocationURI | ( | self, | |
args | |||
) |
Get the location of this SBMLDocument.
getLocationURI() string
If this document was read from a file or had its location set manually, that filename or set location will be returned, otherwise, an empty string is returned.
|
inherited |
Returns the value of the 'metaid' attribute of this SBML object.
getMetaId() string
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.
|
inherited |
def libsbml.SBMLDocument.getModel | ( | self, | |
args | |||
) |
Returns the Model object stored in this SBMLDocument.
getModel() Model
It is important to note that this method does not create a Model instance. The model in the SBMLDocument must have been created at some prior time, for example using SBMLDocument.createModel() or SBMLDocument.setModel(). This method returns None
if a model does not yet exist.
None
if no such model exists.
|
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() string
The '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.
def libsbml.SBMLDocument.getNamespaces | ( | self | ) |
Returns a list of XML Namespaces associated with the XML content of this SBML document.
getNamespaces() XMLNamespaces
|
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() string
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.
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
def libsbml.SBMLDocument.getNumErrors | ( | self, | |
args | |||
) |
This method has multiple variants; they differ in the arguments they accept.
getNumErrors() long getNumErrors(long severity) long
Each variant is described separately below.
getNumErrors(long severity)
Returns the number of errors or warnings encountered with the given severity during parsing, consistency checking, or attempted translation of this model.
severity | the severity of the error sought. |
getNumErrors()
Returns the number of errors or warnings encountered during parsing, consistency checking, or attempted translation of this model.
|
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. def libsbml.SBMLDocument.getPackageRequired | ( | self, | |
package | |||
) |
Returns the required
attribute of the given package extension.
getPackageRequired(string package) bool
package | the name or URI of the package extension. |
|
inherited |
Returns the Version of the SBML Level 3 package to which this element belongs to.
getPackageVersion() long
0
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.
def libsbml.SBMLDocument.getPkgRequired | ( | self, | |
package | |||
) |
Returns the required
attribute of the given package extension.
getPkgRequired(string package) bool
package | the name or URI of the package extension. |
|
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() string
This 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) long
In 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) long
In 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() int
int
, 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() string
This 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() string
int
, and SBO identifiers are stored simply as integers. def libsbml.SBMLDocument.getTypeCode | ( | self | ) |
Returns the libSBML type code for this SBML object.
getTypeCode() int
SBML_
. In the Python language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbml. Note that different Level 3 package plug-ins may use overlapping type codes; to identify the package to which a given object belongs, call the SBase.getPackageName()
method on the object.The exception to this is lists: all SBML-style list elements have the type SBML_LIST_OF, regardless of what package they are from.
|
inherited |
Gets the namespace URI to which this element belongs to.
getURI() string
For example, all elements that belong to SBML Level 3 Version 1 Core must would have the URI 'http://www.sbml.org/sbml/level3/version1/core'
; all elements that belong to Layout Extension Version 1 for SBML Level 3 Version 1 Core must would have the URI 'http://www.sbml.org/sbml/level3/version1/layout/version1'
.
This function first returns the URI for this element by looking into the SBMLNamespaces object of the document with the its package name. If not found, it will then look for the namespace associated with the element itself.
|
inherited |
Returns the Version within the SBML Level of the SBMLDocument object containing this object.
getVersion() long
|
inherited |
Predicate returning true
if this object's level/version and namespace values correspond to a valid SBML specification.
hasValidLevelVersionNamespaceCombination() bool
The valid combinations of SBML Level, Version and Namespace as of this release of libSBML are the following:
http
://www.sbml.org/sbml/level1
http
://www.sbml.org/sbml/level2
http
://www.sbml.org/sbml/level2/version2
http
://www.sbml.org/sbml/level2/version3
http
://www.sbml.org/sbml/level2/version4
http
://www.sbml.org/sbml/level3/version1/core
true
if the level, version and namespace values of this SBML object correspond to a valid set of values, false
otherwise. def libsbml.SBMLDocument.isDisabledIgnoredPackage | ( | self, | |
pkgURI | |||
) |
Returns True
if the given package extension is one of an ignored packages that has been disabled, otherwise returns False
.
isDisabledIgnoredPackage(string pkgURI) bool
An ignored package is one that is defined to be used in this SBML document, but the package is not enabled in this copy of libSBML. It may have been disabled to avoid reproducing the package information when writing out the file.
pkgURI | the URI of the package extension. |
True
if the package is being ignored and False
otherwise. def libsbml.SBMLDocument.isEnabledDefaultNS | ( | self, | |
package | |||
) |
Returns True
if a default namespace is added to each top-level element defined in the given package extension, otherwise returns False
.
isEnabledDefaultNS(string package) bool
This basically checks if the attribute xmlns="..."
is present.
package | the name or URI of the package extension. |
def libsbml.SBMLDocument.isIgnoredPackage | ( | self, | |
pkgURI | |||
) |
Returns True
if the given package extension is one of an ignored packages, otherwise returns False
.
isIgnoredPackage(string pkgURI) bool
An ignored package is one that is defined to be used in this SBML document, but the package is not enabled in this copy of libSBML.
pkgURI | the URI of the package extension. |
True
if the package is being ignored and False
otherwise. def libsbml.SBMLDocument.isIgnoredPkg | ( | self, | |
pkgURI | |||
) |
Returns True
if the given package extension is one of ignored packages, otherwise returns False
.
isIgnoredPkg(string pkgURI) bool
An ignored package is one that is defined to be used in this SBML document, but the package is not enabled in this copy of libSBML.
pkgURI | the URI of the package extension. |
|
inherited |
Predicate returning True
if the given SBML Level 3 package is enabled with this object.
isPackageEnabled(string pkgName) bool
The 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 the given SBML Level 3 package is enabled with this object.
isPkgEnabled(string pkgName) bool
The 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 |
Predicate returning True
if this object's 'annotation' subelement exists and has content.
isSetAnnotation() bool
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.
True
if a 'annotation' subelement exists, False
otherwise.
|
inherited |
Predicate returning True
if a call to getId() returns a non-empty string.
isSetId() bool
For 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() bool
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 'metaid' attribute is set.
isSetMetaId() bool
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.True
if the 'metaid' attribute of this SBML object is set, False
otherwise.def libsbml.SBMLDocument.isSetModel | ( | self | ) |
|
inherited |
Predicate returning True
if this object has a ModelHistory object attached to it.
isSetModelHistory() bool
True
if the ModelHistory of this object is set, False
otherwise.
|
inherited |
Predicate returning True
if this object's 'name' attribute is set.
isSetName() bool
The '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() bool
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.
True
if a 'notes' subelement exists, False
otherwise.def libsbml.SBMLDocument.isSetPackageRequired | ( | self, | |
package | |||
) |
Returns True
if the required attribute of the given package extension is defined, otherwise returns False
.
isSetPackageRequired(string package) bool
package | the name or URI of the package extension. |
def libsbml.SBMLDocument.isSetPkgRequired | ( | self, | |
package | |||
) |
Returns True
if the required attribute of the given package extension is defined, otherwise returns False
.
isSetPkgRequired(string package) bool
package | the name or URI of the package extension. |
|
inherited |
Predicate returning True
if this object's 'sboTerm' attribute is set.
isSetSBOTerm() bool
True
if the 'sboTerm' attribute of this SBML object is set, False
otherwise.
|
inherited |
Predicate returning true or false depending on whether the user data of this element has been set.
isSetUserData() bool
True
if this object's user data has been set, 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. def libsbml.SBMLDocument.printErrors | ( | self, | |
args | |||
) |
This method has multiple variants; they differ in the arguments they accept.
printErrors(ostream stream) printErrors() printErrors(ostream stream, long severity)
Each variant is described separately below.
printErrors(std::ostream stream, long severity)
Prints all the errors or warnings with the given severity encountered trying to parse, check, or translate this SBML document.
It prints the text to the stream given by the parameter stream
.
If no errors have occurred, i.e., getNumErrors(severity) == 0
, no output will be sent to the stream.
The format of the output is:
N error(s): line NNN: (id) message
stream | the ostream or ostringstream object indicating where the output should be printed. |
severity | of the errors sought. |
printErrors(std::ostream stream = std::cerr)
Prints all the errors or warnings encountered trying to parse, check, or translate this SBML document.
It prints the text to the stream given by the optional parameter stream
. If no parameter is given, it prints the output to the standard error stream.
If no errors have occurred, i.e., getNumErrors() == 0
, no output will be sent to the stream.
The format of the output is:
N error(s): line NNN: (id) message
stream | the ostream or ostringstream object indicating where the output should be printed. |
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 |
Removes this object from its parent.
removeFromParentAndDelete() int
If 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. |
|
inherited |
Replaces all uses of a given SIdRef
type attribute value with another value.
renameSIdRefs(string oldid, string newid)
SId
. In SBML Level 3, an explicit data type called SIdRef
was introduced for attribute values that refer to SId
values; in previous Levels of SBML, this data type did not exist and attributes were simply described to as 'referring to an identifier', but the effective data type was the same as SIdRef
in Level 3. These and other methods of libSBML refer to the type SIdRef
for all Levels of SBML, even if the corresponding SBML specification did not explicitly name the data type.This method works by looking at all attributes and (if appropriate) mathematical formulas in MathML content, comparing the referenced identifiers to the value of oldid
. If any matches are found, the matching values are replaced with newid
. The method does not descend into child elements.
oldid | the old identifier. |
newid | the new identifier. |
|
inherited |
Replaces all uses of a given UnitSIdRef
type attribute value with another value.
renameUnitSIdRefs(string oldid, string newid)
UnitSId
. In SBML Level 3, an explicit data type called UnitSIdRef
was introduced for attribute values that refer to UnitSId
values; in previous Levels of SBML, this data type did not exist and attributes were simply described to as 'referring to a unit identifier', but the effective data type was the same as UnitSIdRef
in Level 3. These and other methods of libSBML refer to the type UnitSIdRef
for all Levels of SBML, even if the corresponding SBML specification did not explicitly name the data type.This method works by looking at all unit identifier attribute values (including, if appropriate, inside mathematical formulas), comparing the referenced unit identifiers to the value of oldid
. If any matches are found, the matching values are replaced with newid
. The method does not descend into child elements.
oldid | the old identifier. |
newid | the new identifier. |
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
replaceTopLevelAnnotationElement(XMLNode annotation) int replaceTopLevelAnnotationElement(string annotation) int
Each variant is described separately below.
replaceTopLevelAnnotationElement(XMLNode annotation)
Replaces the given top-level element within the 'annotation' subelement of this SBML object and with the annotation element supplied.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
This method determines the name of the element to be replaced from the annotation argument. Functionally it is equivalent to calling removeTopLevelAnnotationElement(name)
followed by calling appendAnnotation(annotation_with_name)
, with the exception that the placement of the annotation element remains the same.
annotation | XMLNode representing the replacement top level annotation. |
replaceTopLevelAnnotationElement(string annotation)
Replaces the given top-level element within the 'annotation' subelement of this SBML object and with the annotation element supplied.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
This method determines the name of the element to be replaced from the annotation argument. Functionally it is equivalent to calling removeTopLevelAnnotationElement(name)
followed by calling appendAnnotation(annotation_with_name)
, with the exception that the placement of the annotation element remains the same.
annotation | string representing the replacement top level annotation. |
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
setAnnotation(XMLNode annotation) int setAnnotation(string annotation) int
Each variant is described separately below.
setAnnotation(XMLNode annotation)
Sets the value of the 'annotation' subelement of this SBML object.
The content of annotation
is copied, and any previous content of this object's 'annotation' subelement is deleted.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Call this method will result in any existing content of the 'annotation' subelement to be discarded. Unless you have taken steps to first copy and reconstitute any existing annotations into the annotation
that is about to be assigned, it is likely that performing such wholesale replacement is unfriendly towards other software applications whose annotations are discarded. An alternative may be to use SBase.appendAnnotation() or SBase.appendAnnotation().
annotation | an XML structure that is to be used as the new content of the 'annotation' subelement of this object. |
setAnnotation(string annotation)
Sets the value of the 'annotation' subelement of this SBML object.
The content of annotation
is copied, and any previous content of this object's 'annotation' subelement is deleted.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Call this method will result in any existing content of the 'annotation' subelement to be discarded. Unless you have taken steps to first copy and reconstitute any existing annotations into the annotation
that is about to be assigned, it is likely that performing such wholesale replacement is unfriendly towards other software applications whose annotations are discarded. An alternative may be to use SBase.appendAnnotation() or SBase.appendAnnotation().
annotation | an XML string that is to be used as the content of the 'annotation' subelement of this object. |
def libsbml.SBMLDocument.setConsistencyChecks | ( | self, | |
category, | |||
apply | |||
) |
setConsistencyChecks(long category, bool apply)
Controls the consistency checks that are performed when SBMLDocument.checkConsistency() is called.
This method works by adding or subtracting consistency checks from the set of all possible checks that SBMLDocument.checkConsistency() knows how to perform. This method may need to be called multiple times in order to achieve the desired combination of checks. The first argument (category
) in a call to this method indicates the category of consistency/error checks that are to be turned on or off, and the second argument (apply
, a boolean) indicates whether to turn it on (value of True
) or off (value of False
).
The possible categories (values to the argument category
) are the set of constants whose names begin with the characters LIBSBML_CAT_
in the interface class libsbml. The following are the possible choices:
LIBSBML_CAT_GENERAL_CONSISTENCY: Correctness and consistency of specific SBML language constructs. Performing this set of checks is highly recommended. With respect to the SBML specification, these concern failures in applying the validation rules numbered 2xxxx in the Level 2 Versions 2–4 and Level 3 Versions 1–2 specifications.
LIBSBML_CAT_IDENTIFIER_CONSISTENCY: Correctness and consistency of identifiers used for model entities. An example of inconsistency would be using a species identifier in a reaction rate formula without first having declared the species. With respect to the SBML specification, these concern failures in applying the validation rules numbered 103xx in the Level 2 Versions 2–4 and Level 3 Versions 1–2 specifications.
LIBSBML_CAT_UNITS_CONSISTENCY: Consistency of measurement units associated with quantities in a model. With respect to the SBML specification, these concern failures in applying the validation rules numbered 105xx in the Level 2 Versions 2–4 and Level 3 Versions 1–2 specifications.
LIBSBML_CAT_MATHML_CONSISTENCY: Syntax of MathML constructs. With respect to the SBML specification, these concern failures in applying the validation rules numbered 102xx in the Level 2 Versions 2–4 and Level 3 Versions 1–2 specifications.
LIBSBML_CAT_SBO_CONSISTENCY: Consistency and validity of SBO identifiers (if any) used in the model. With respect to the SBML specification, these concern failures in applying the validation rules numbered 107xx in the Level 2 Versions 2–4 and Level 3 Versions 1–2 specifications.
LIBSBML_CAT_OVERDETERMINED_MODEL: Static analysis of whether the system of equations implied by a model is mathematically overdetermined. With respect to the SBML specification, this is validation rule #10601 in the Level 2 Versions 2–4 and Level 3 Versions 1–2 specifications.
By default, all validation checks are applied to the model in an SBMLDocument object unless SBMLDocument.setConsistencyChecks() is called to indicate that only a subset should be applied. Further, this default (i.e., performing all checks) applies separately to each new SBMLDocument object created. In other words, each time a model is read using SBMLReader.readSBML(), SBMLReader.readSBMLFromString(), or the global functions readSBML() and readSBMLFromString(), a new SBMLDocument is created and for that document, a call to SBMLDocument.checkConsistency() will default to applying all possible checks. Calling programs must invoke SBMLDocument.setConsistencyChecks() for each such new model if they wish to change the consistency checks applied.
category | a value drawn fromthe set of SBML error categories indicating the consistency checking/validation to be turned on or off. |
apply | a boolean indicating whether the checks indicated by category should be applied or not. |
def libsbml.SBMLDocument.setConsistencyChecksForConversion | ( | self, | |
category, | |||
apply | |||
) |
setConsistencyChecksForConversion(long category, bool apply)
Controls the consistency checks that are performed when SBMLDocument.setLevelAndVersion() is called.
This method works by adding or subtracting consistency checks from the set of all possible checks that may be performed to avoid conversion to or from an invalid document. This method may need to be called multiple times in order to achieve the desired combination of checks. The first argument (category
) in a call to this method indicates the category of consistency/error checks that are to be turned on or off, and the second argument (apply
, a boolean) indicates whether to turn it on (value of True
) or off (value of False
).
The possible categories (values to the argument category
) are the set of constants whose names begin with the characters LIBSBML_CAT_
in the interface class libsbml. The following are the possible choices:
LIBSBML_CAT_GENERAL_CONSISTENCY: Correctness and consistency of specific SBML language constructs. Performing this set of checks is highly recommended. With respect to the SBML specification, these concern failures in applying the validation rules numbered 2xxxx in the Level 2 Versions 2–4 and Level 3 Versions 1–2 specifications.
LIBSBML_CAT_IDENTIFIER_CONSISTENCY: Correctness and consistency of identifiers used for model entities. An example of inconsistency would be using a species identifier in a reaction rate formula without first having declared the species. With respect to the SBML specification, these concern failures in applying the validation rules numbered 103xx in the Level 2 Versions 2–4 and Level 3 Versions 1–2 specifications.
LIBSBML_CAT_UNITS_CONSISTENCY: Consistency of measurement units associated with quantities in a model. With respect to the SBML specification, these concern failures in applying the validation rules numbered 105xx in the Level 2 Versions 2–4 and Level 3 Versions 1–2 specifications.
LIBSBML_CAT_MATHML_CONSISTENCY: Syntax of MathML constructs. With respect to the SBML specification, these concern failures in applying the validation rules numbered 102xx in the Level 2 Versions 2–4 and Level 3 Versions 1–2 specifications.
LIBSBML_CAT_SBO_CONSISTENCY: Consistency and validity of SBO identifiers (if any) used in the model. With respect to the SBML specification, these concern failures in applying the validation rules numbered 107xx in the Level 2 Versions 2–4 and Level 3 Versions 1–2 specifications.
LIBSBML_CAT_OVERDETERMINED_MODEL: Static analysis of whether the system of equations implied by a model is mathematically overdetermined. With respect to the SBML specification, this is validation rule #10601 in the Level 2 Versions 2–4 and Level 3 Versions 1–2 specifications.
By default, all validation checks are applied to the model in an SBMLDocument object unless SBMLDocument.setConsistencyChecks() is called to indicate that only a subset should be applied. Further, this default (i.e., performing all checks) applies separately to each new SBMLDocument object created. In other words, each time a model is read using SBMLReader.readSBML(), SBMLReader.readSBMLFromString(), or the global functions readSBML() and readSBMLFromString(), a new SBMLDocument is created and for that document, a call to SBMLDocument.checkConsistency() will default to applying all possible checks. Calling programs must invoke SBMLDocument.setConsistencyChecks() for each such new model if they wish to change the consistency checks applied.
category | a value drawn fromthe set of SBML error categories indicating the consistency checking/validation to be turned on or off. |
apply | a boolean indicating whether the checks indicated by category should be applied or not. |
|
inherited |
Sets the value of the 'id' attribute of this SBML object.
setId(string sid) int
sid
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) int
sid
is copied.SId
or a type derived from that, such as UnitSId
, depending on the object in question. All data types are defined as follows: letter ::= 'a'..'z','A'..'Z' digit ::= '0'..'9' idChar ::= letter | digit | '_' SId ::= ( letter | '_' ) idChar*The characters
(
and )
are used for grouping, the character *
'zero or more times', and the character |
indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId
, SIdRef
, and derived types.Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False
for objects of these classes.
With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.
sid | the string to use as the identifier of this object. |
def libsbml.SBMLDocument.setLevelAndVersion | ( | self, | |
level, | |||
version, | |||
strict = True , |
|||
ignorePackages = False |
|||
) |
Sets the SBML Level and Version of this SBMLDocument instance, attempting to convert the model as needed.
setLevelAndVersion(long level, long version, bool strict, bool ignorePackages) bool setLevelAndVersion(long level, long version, bool strict) bool setLevelAndVersion(long level, long version) bool
This method is the principal way in libSBML to convert models between Levels and Versions of SBML. Generally, models can be converted upward without difficulty (e.g., from SBML Level 1 to Level 2, or from an earlier Version of Level 2 to the latest Version of Level 2). Sometimes models can be translated downward as well, if they do not use constructs specific to more advanced Levels of SBML.
Before calling this method, callers may check compatibility directly using the methods SBMLDocument.checkL1Compatibility(), SBMLDocument.checkL2v1Compatibility(), SBMLDocument.checkL2v2Compatibility(), SBMLDocument.checkL2v3Compatibility(), SBMLDocument.checkL2v4Compatibility(), SBMLDocument.checkL2v5Compatibility(), SBMLDocument.checkL3v1Compatibility(), and SBMLDocument.checkL3v2Compatibility().
The valid combinations of SBML Level and Version as of this release of libSBML are the following:
Strict conversion applies the additional criteria that both the source and the target model must be consistent SBML. Users can control the consistency checks that are applied using the SBMLDocument.setConsistencyChecksForConversion() method. If either the source or the potential target model have validation errors, the conversion is not performed. When a strict conversion is successful, the underlying SBML object model is altered to reflect the new level and version. Thus, information that cannot be converted (e.g. sboTerms) will be lost.
level | the desired SBML Level. |
version | the desired Version within the SBML Level. |
strict | boolean indicating whether to check consistency of both the source and target model when performing conversion (defaults to true ). |
ignorePackages | boolean indicating whether the presence of packages should be ignored by the conversion routine (defaults to false ). |
True
if the level and version of the document were successfully set to the requested values (which may have required conversion of the model), False
otherwise.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. def libsbml.SBMLDocument.setLocationURI | ( | self, | |
uri | |||
) |
Sets the location of this SBMLDocument.
setLocationURI(string uri)
Called automatically when readSBMLFromFile is used, but may be set manually as well.
|
inherited |
Sets the value of the meta-identifier attribute of this SBML object.
setMetaId(string metaid) int
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.The string metaid
is copied.
metaid | the identifier string to use as the value of the 'metaid' attribute. |
def libsbml.SBMLDocument.setModel | ( | self, | |
m | |||
) |
Sets the Model for this SBMLDocument to a copy of the given Model.
setModel(Model m) int
m | the new Model to use. |
|
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) int
The string in name
is copied.
name | the new name for the SBML object. |
|
inherited |
Sets the namespaces relevant of this SBML object.
setNamespaces(XMLNamespaces xmlns) int
The content of xmlns
is copied, and this object's existing namespace content is deleted.
The SBMLNamespaces object encapsulates SBML Level/Version/namespaces information. It is used to communicate the SBML Level, Version, and (in Level 3) packages used in addition to SBML Level 3 Core.
xmlns | the namespaces to set. |
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
setNotes(XMLNode notes) int setNotes(string notes, bool addXHTMLMarkup) int setNotes(string notes) int
Each variant is described separately below.
setNotes(string notes, bool addXHTMLMarkup = false)
Sets the value of the 'notes' subelement of this SBML object to a copy of the string notes
.
The content of notes
is copied, and any existing content of this object's 'notes' subelement is deleted.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
The following code illustrates a very simple way of setting the notes using this method. Here, the object being annotated is the whole SBML document, but that is for illustration purposes only; you could of course use this same approach to annotate any other SBML component.
notes | an XML string that is to be used as the content of the 'notes' subelement of this object. |
addXHTMLMarkup | a boolean indicating whether to wrap the contents of the notes argument with XHTML paragraph (<p> ) tags. This is appropriate when the string in notes does not already containg the appropriate XHTML markup. |
parameter
= value
. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.setNotes(XMLNode notes)
Sets the value of the 'notes' subelement of this SBML object.
The content of notes
is copied, and any existing content of this object's 'notes' subelement is deleted.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
notes | an XML structure that is to be used as the content of the 'notes' subelement of this object. |
def libsbml.SBMLDocument.setPackageRequired | ( | self, | |
package, | |||
flag | |||
) |
Sets the required
attribute value of the given package extension.
setPackageRequired(string package, bool flag) int
package | the name or URI of the package extension. |
flag | Boolean value indicating whether the package is required. |
def libsbml.SBMLDocument.setPkgRequired | ( | self, | |
package, | |||
flag | |||
) |
Sets the value of the required
attribute for the given package.
setPkgRequired(string package, bool flag) int
package | the name or URI of the package extension. |
flag | a Boolean value. |
|
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 |
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() int
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.
|
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() int
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.
|
inherited |
Unsets the value of the 'id' attribute of this SBML object.
unsetIdAttribute() int
Most (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() int
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.
|
inherited |
Unsets the ModelHistory object attached to this object.
unsetModelHistory() int
|
inherited |
Unsets the value of the 'name' attribute of this SBML object.
unsetName() int
The '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() int
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.
|
inherited |
Unsets the value of the 'sboTerm' attribute of this SBML object.
unsetSBOTerm() int
|
inherited |
Unsets the user data of this element.
unsetUserData() int
def libsbml.SBMLDocument.validateSBML | ( | self | ) |
Performs consistency checking and validation on this SBML document.
validateSBML() long
If this method returns a nonzero value (meaning, one or more consistency checks have failed for SBML document), the failures may be due to warnings or errors. Callers should inspect the severity flag in the individual SBMLError objects returned by SBMLDocument.getError() to determine the nature of the failures.