libSBML Python API
5.18.0
|
The ReplacedElement class was introduced by the SBML Level 3 Hierarchical Model Composition (“comp”) package to allow submodel elements to be replaced, but still allow references to those elements to be valid. A ReplacedElement object is essentially a pointer to a submodel object that should be considered 'replaced'. The object holding the ReplacedElement instance is the one doing the replacing; the object pointed to by the ReplacedElement object is the object being replaced.
A replacement implies that dependencies involving the replaced object must be updated: all references to the replaced object elsewhere in the model are taken to refer to the replacement object instead. For example, if one species replaces another, then any reference to the original species in mathematical formulas, or lists of reactants or products or modifiers in reactions, or initial assignments, or any other SBML construct, are taken to refer to the replacement species, with its value possibly modified by either this object's 'conversionFactor' attribute or the relevant submodel's conversion factors. Moreover, any annotations that refer to the replaced species' 'metaid' value must be made to refer to the replacement species' 'metaid' value instead; and anything else that referred either to an object identifier (i.e., attributes such as the 'id' attribute whose types inherit from the SId primitive data type) or the meta identifier (i.e., the 'metaid' attribute or any other attribute that inherits from the ID primitive data type) must be made to refer to the replacement species object instead.
It is worth noting that local parameters (inside Reaction objects) pose an interesting edge case for these rules. In order to determine which element is pointed to by a <cn>
element within the <math>
element of a KineticLaw object, it is necessary to examine the local parameters of that kinetic law's parent Reaction object. Whether the <cn>
element is considered to point to something new, then, depends on whether it pointed to the local parameter and whether that local parameter was replaced, even if the text of the element matched the SId value of another element in the model. Note that local parameters may only effectively be replaced by global parameters, since references to its SId are only valid from within the Reaction element to which it belongs.
When referencing an element within the Submodel pointed to by the 'submodelRef' attribute (defined in libSBML in the Replacing class), any of the four attributes inherited from SBaseRef for the purpose may be used (portRef, idRef, unitRef, or metaIdRef), or a new optional attribute 'deletion' may be used. This attribute must be the identifier of a Deletion object in the parent Model of the ReplacedElement (i.e., the value of some Deletion object's 'id' attribute). When 'deletion' is set, it means the ReplacedElement object is actually an annotation to indicate that the replacement object replaces something deleted from a submodel. The use of the 'deletion' attribute overrides the use of the attributes inherited from SBaseRef: instead of using, e.g., 'portRef' or 'idRef', the ReplacedElement instance sets 'deletion' to the identifier of the Deletion object. In addition, the referenced Deletion must be a child of the Submodel referenced by the 'submodelRef' attribute.
The use of ReplacedElement objects to refer to deletions has no effect on the composition of models or the mathematical properties of the result. It serves instead to help record the decision-making process that lead to a given model. It can be particularly useful for visualization purposes, as well as to serve as scaffolding where other types of annotations can be added using the normal Annotation subcomponents available on all SBase objects in SBML.
As with the Submodel class, it may be that the units of the replaced element may not match the units of the replacement element. In this case, the optional 'conversionFactor' attribute may be used. This attribute, if present, defines how to transform or rescale the replaced object's value so that it is appropriate for the new contexts in which the object appears. This attribute takes a value of type SIdRef, and the value must refer to a Parameter object instance defined in the model. This parameter then acts as a conversion factor.
The value of the conversion factor should be defined such that a single unit of the replaced element multiplied by the conversion factor should equal a single unit of the replacement element, and the units of the conversion factor should be commensurate with that transformation. The referenced Parameter may be non-constant, particularly if a Species is replaced by a Species with a different 'hasOnlySubstanceUnits' attribute value, thus changing amount to concentration, or visa versa.
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 | clearReferencedElement (self) |
Removes the saved referenced element, if it had been saved earlier. More... | |
def | clone (self) |
Creates and returns a deep copy of this ReplacedElement object. More... | |
def | connectToChild (self) |
def | createSBaseRef (self) |
Creates a new, empty SBaseRef, adds it to this SBaseRef and returns the created SBaseRef. More... | |
def | deleteDisabledPlugins (self, recursive=True) |
Deletes all information stored in disabled plugins. More... | |
def | disablePackage (self, pkgURI, pkgPrefix) |
Disables the given SBML Level 3 package on this object. More... | |
def | enablePackage (self, pkgURI, pkgPrefix, flag) |
Enables or disables the given SBML Level 3 package on this object. More... | |
def | getAncestorOfType (self, args) |
This method has multiple variants; they differ in the arguments they accept. More... | |
def | getAnnotation (self, args) |
Returns the content of the 'annotation' subelement of this object as a tree of XMLNode objects. More... | |
def | getAnnotationString (self, args) |
Returns the content of the 'annotation' subelement of this object as a character string. More... | |
def | getColumn (self) |
Returns the column number where this object first appears in the XML representation of the SBML document. More... | |
def | getConversionFactor (self) |
Returns the value of the 'conversionFactor' attribute of this ReplacedElement. 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 | getDeletion (self) |
Returns the value of the 'deletion' attribute of this ReplacedElement. 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 SBML object. 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 | getIdRef (self) |
Returns the value of the 'idRef' attribute of this SBaseRef. More... | |
def | getLevel (self) |
Returns the SBML Level of the SBMLDocument object containing this object. More... | |
def | getLine (self) |
Returns the line number where this object first appears in the XML representation of the SBML document. More... | |
def | getListOfAllElements (self, filter=None) |
Returns an SBaseList of all child SBase objects, including those nested to an arbitrary depth. More... | |
def | getListOfAllElementsFromPlugins (self, filter=None) |
Returns a List of all child SBase objects contained in SBML package plug-ins. More... | |
def | getMetaId (self) |
Returns the value of the 'metaid' attribute of this SBML object. More... | |
def | getMetaIdRef (self) |
Returns the value of the 'metaIdRef' attribute of this SBaseRef. More... | |
def | getModel (self) |
Returns the Model object for the SBML Document in which the current object is located. More... | |
def | getModelHistory (self, args) |
Returns the ModelHistory object, if any, attached to this object. More... | |
def | getName (self) |
Returns the value of the 'name' attribute of this SBML object. More... | |
def | getNamespaces (self) |
Returns a list of the XML Namespaces declared on the SBML document owning this object. More... | |
def | getNotes (self, args) |
Returns the content of the 'notes' subelement of this object as a tree of XMLNode objects. More... | |
def | getNotesString (self, args) |
Returns the content of the 'notes' subelement of this object as a string. More... | |
def | getNumCVTerms (self) |
Returns the number of CVTerm objects in the annotations of this SBML object. More... | |
def | getNumDisabledPlugins (self) |
Returns the number of disabled plug-in objects (extension interfaces) for SBML Level 3 package extensions known. More... | |
def | getNumPlugins (self) |
Returns the number of plug-in objects (extenstion interfaces) for SBML Level 3 package extensions known. More... | |
def | getNumReferents (self) |
Returns how many elements are being referred to by this ReplacedElement. More... | |
def | getPackageCoreVersion (self) |
Returns the SBML Core Version within the SBML Level of the actual object. More... | |
def | getPackageName (self) |
Returns the package name of this plugin object. More... | |
def | getPackageURI (self) |
Returns the XML namespace (URI) of the package extension of this object. More... | |
def | getPackageVersion (self) |
Returns the package version of the package extension of this plugin object. More... | |
def | getParentModel (child) |
Returns the Model object to which the referenced child object belongs. More... | |
def | getParentSBMLObject (self, args) |
Returns the parent SBML object containing this object. More... | |
def | getPlugin (self, args) |
This method has multiple variants; they differ in the arguments they accept. More... | |
def | getPortRef (self) |
Returns the value of the 'portRef' attribute of this SBaseRef. More... | |
def | getPrefix (self) |
Returns the XML namespace prefix of this element. More... | |
def | getReferencedElement (self) |
Returns the object pointed to by this element. More... | |
def | getReferencedElementFrom (self, model) |
Finds the SBase object this ReplacedElement object points to, if any. 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 | getSBaseRef (self, args) |
Get the child sBaseRef of this sBaseRef. 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 | getSubmodelRef (self) |
Returns the value of the 'submodelRef' attribute of this SBaseRef. More... | |
def | getTypeCode (self) |
Returns the libSBML type code of this object instance. More... | |
def | getUnitRef (self) |
Returns the value of the 'unitRef' attribute of this SBaseRef. More... | |
def | getURI (self) |
Gets the namespace URI to which this element belongs to. More... | |
def | getVersion (self) |
Returns the Version within the SBML Level of the SBMLDocument object containing this object. More... | |
def | hasRequiredAttributes (self) |
Returns True if getNumReferents() is exactly 1 and if the submodelRef is set. More... | |
def | hasValidLevelVersionNamespaceCombination (self) |
Predicate returning true if this object's level/version and namespace values correspond to a valid SBML specification. More... | |
def | 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 | isSetConversionFactor (self) |
Predicate returning True or False depending on whether this ReplacedElement's 'conversionFactor' attribute has been set. More... | |
def | isSetDeletion (self) |
Predicate returning True or False depending on whether this SBaseRef's 'deletion' attribute has been set. More... | |
def | isSetId (self) |
Predicate returning True if a call to getId() returns a non-empty string. More... | |
def | isSetIdAttribute (self) |
Predicate returning True if this object's 'id' attribute is set. More... | |
def | isSetIdRef (self) |
Predicate returning True or False depending on whether this SBaseRef's 'idRef' attribute has been set. More... | |
def | isSetMetaId (self) |
Predicate returning True if this object's 'metaid' attribute is set. More... | |
def | isSetMetaIdRef (self) |
Predicate returning True or False depending on whether this SBaseRef's 'metaIdRef' attribute has been set. More... | |
def | isSetModelHistory (self) |
Predicate returning True if this object has a ModelHistory object attached to it. More... | |
def | isSetName (self) |
Predicate returning True if this object's 'name' attribute is set. More... | |
def | isSetNotes (self) |
Predicate returning True if this object's 'notes' subelement exists and has content. More... | |
def | isSetPortRef (self) |
Predicate returning True or False depending on whether this SBaseRef's 'portRef' attribute has been set. More... | |
def | isSetSBaseRef (self) |
Predicate for testing whether the sBaseRef for this SBaseRef is set. More... | |
def | isSetSBOTerm (self) |
Predicate returning True if this object's 'sboTerm' attribute is set. More... | |
def | isSetSubmodelRef (self) |
Predicate returning True or False depending on whether this SBaseRef's 'submodelRef' attribute has been set. More... | |
def | isSetUnitRef (self) |
Predicate returning True or False depending on whether this SBaseRef's 'unitRef' attribute has been 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 | performDeletion (self) |
DEPRECATED FUNCTION: DO NOT USE. More... | |
def | performReplacement (self) |
DEPRECATED FUNCTION: DO NOT USE. More... | |
def | removeFromParentAndDelete (self) |
Finds this SBaseRef's parent, which can either be a List or can be another SBaseRef, and tells it to remove this. 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 | saveReferencedElement (self) |
Finds and stores the referenced object. More... | |
def | setAnnotation (self, args) |
This method has multiple variants; they differ in the arguments they accept. More... | |
def | setConversionFactor (self, id) |
Sets the value of the 'conversionFactor' attribute of this ReplacedElement. More... | |
def | setDeletion (self, id) |
Sets the value of the 'deletion' attribute of this ReplacedElement. More... | |
def | setId (self, sid) |
Sets the value of the 'id' attribute of this SBML object. More... | |
def | setIdAttribute (self, sid) |
Sets the value of the 'id' attribute of this SBML object. More... | |
def | setIdRef (self, id) |
Sets the value of the 'idRef' attribute of this SBaseRef. More... | |
def | setMetaId (self, metaid) |
Sets the value of the meta-identifier attribute of this SBML object. More... | |
def | setMetaIdRef (self, id) |
Sets the value of the 'metaIdRef' attribute of this SBaseRef. 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 | setPortRef (self, id) |
Sets the value of the 'portRef' attribute of this SBaseRef. More... | |
def | setSBaseRef (self, sBaseRef) |
Sets the sBaseRef definition of this SBaseRef to a copy of the given SBaseRef object instance. More... | |
def | setSBOTerm (self, args) |
This method has multiple variants; they differ in the arguments they accept. More... | |
def | setSubmodelRef (self, id) |
Sets the value of the 'submodelRef' attribute of this SBaseRef. More... | |
def | setUnitRef (self, id) |
Sets the value of the 'unitRef' attribute of this SBaseRef. 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 | unsetConversionFactor (self) |
Unsets the value of the 'conversionFactor' attribute of this ReplacedElement. More... | |
def | unsetCVTerms (self) |
Clears the list of CVTerm objects attached to this SBML object. More... | |
def | unsetDeletion (self) |
Unsets the value of the 'deletion' attribute of this ReplacedElement. 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 | unsetIdRef (self) |
Unsets the value of the 'idRef' attribute of this SBaseRef. More... | |
def | unsetMetaId (self) |
Unsets the value of the 'metaid' attribute of this SBML object. More... | |
def | unsetMetaIdRef (self) |
Unsets the value of the 'metaIdRef' attribute of this SBaseRef. 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 | unsetPortRef (self) |
Unsets the value of the 'portRef' attribute of this SBaseRef. More... | |
def | unsetSBaseRef (self) |
Unsets the child SBaseRef of this SBaseRef. More... | |
def | unsetSBOTerm (self) |
Unsets the value of the 'sboTerm' attribute of this SBML object. More... | |
def | unsetSubmodelRef (self) |
Unsets the value of the 'SubmodelRef' attribute of this SBaseRef. More... | |
def | unsetUnitRef (self) |
Unsets the value of the 'unitRef' attribute of this SBaseRef. More... | |
def | unsetUserData (self) |
Unsets the user data of this element. More... | |
def libsbml.ReplacedElement.__init__ | ( | self, | |
args | |||
) |
This method has multiple variants; they differ in the arguments they accept.
__init__(long level, long version, long pkgVersion) ReplacedElement __init__(long level, long version) ReplacedElement __init__(long level) ReplacedElement __init__() ReplacedElement __init__(CompPkgNamespaces compns) ReplacedElement __init__(ReplacedElement source) ReplacedElement
Each variant is described separately below.
ReplacedElement(long level = CompExtension.getDefaultLevel(), long version = CompExtension.getDefaultVersion(), long pkgVersion = CompExtension.getDefaultPackageVersion())
Creates a new ReplacedElement with the given level, version, and package version.
level | the SBML Level. |
version | the Version within the SBML Level. |
pkgVersion | the version of the package. |
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.ReplacedElement(CompPkgNamespaces compns)
Creates a new ReplacedElement with the given CompPkgNamespaces object.
compns | the CompPkgNamespaces object. |
ReplacedElement(ReplacedElement source)
Copy constructor.
source | the instance 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. |
|
inherited |
Removes the saved referenced element, if it had been saved earlier.
clearReferencedElement()
def libsbml.ReplacedElement.clone | ( | self | ) |
Creates and returns a deep copy of this ReplacedElement object.
clone() ReplacedElement
|
inherited |
connectToChild()
|
inherited |
|
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. |
|
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. |
|
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
.def libsbml.ReplacedElement.getConversionFactor | ( | self | ) |
Returns the value of the 'conversionFactor' attribute of this ReplacedElement.
getConversionFactor() string
|
inherited |
|
inherited |
Returns a list of CVTerm objects in the annotations of this SBML object.
getCVTerms() List *
def libsbml.ReplacedElement.getDeletion | ( | self | ) |
Returns the value of the 'deletion' attribute of this ReplacedElement.
getDeletion() string
|
inherited |
Returns the nth disabled plug-in object (extension interface) for an SBML Level 3 package extension.
getDisabledPlugin(long n) SBasePlugin
If no such plugin exists, None is returned.
n | the index of the disabled plug-in to return. |
n
is invalid, None
is returned.
|
inherited |
Returns the first child element it can find with 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
.
|
inherited |
def libsbml.ReplacedElement.getElementName | ( | self | ) |
Returns the XML element name of this SBML object.
getElementName() string
|
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 |
|
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.
|
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 |
|
inherited |
|
inherited |
Returns the ModelHistory object, if any, attached to this object.
getModelHistory() ModelHistory
None
if none exist.
|
inherited |
Returns the value of the 'name' attribute of this SBML object.
getName() 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.
|
inherited |
Returns a list of the XML Namespaces declared on the SBML document owning this object.
getNamespaces() XMLNamespaces
The SBMLNamespaces object encapsulates SBML Level/Version/namespaces information. It is used to communicate the SBML Level, Version, and (in Level 3) packages used in addition to SBML Level 3 Core.
None
in certain very usual circumstances where a namespace is not set.
|
inherited |
Returns the content of the 'notes' subelement of this object as a tree of XMLNode objects.
getNotes() XMLNode
The format of 'notes' elements conform to the definition of XHTML 1.0. However, the content cannot be entirely free-form; it must satisfy certain requirements defined in the SBML specifications for specific SBML Levels. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); this method implements a verification process that lets callers check whether the content of a given XMLNode object conforms to the SBML requirements for 'notes' and 'message' structure. Developers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations of using 'notes' in SBML. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
The 'notes' element content returned by this method will be in XML form, but libSBML does not provide an object model specifically for the content of notes. Callers will need to traverse the XML tree structure using the facilities available on XMLNode and related objects. For an alternative method of accessing the notes, see getNotesString().
|
inherited |
Returns the content of the 'notes' subelement of this object as a string.
getNotesString() 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
|
inherited |
Returns the number of plug-in objects (extenstion interfaces) for SBML Level 3 package extensions known.
getNumPlugins() long
def libsbml.ReplacedElement.getNumReferents | ( | self | ) |
Returns how many elements are being referred to by this ReplacedElement.
getNumReferents() int
A valid ReplacedElement will have exactly one. Possible referents are deletion, port, idRef, unitRef, and metaIdRef.
|
inherited |
Returns the SBML Core Version within the SBML Level of the actual object.
getPackageCoreVersion() long
|
inherited |
Returns the package name of this plugin object.
getPackageName() string
|
inherited |
Returns the XML namespace (URI) of the package extension of this object.
getPackageURI() string
|
inherited |
Returns the package version of the package extension of this plugin object.
getPackageVersion() long
|
inherited |
|
inherited |
Returns the parent SBML object containing this object.
getParentSBMLObject() SBase
This returns the immediately-containing object. This method is convenient when holding an object nested inside other objects in an SBML model.
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
getPlugin(string package) SBasePlugin getPlugin(long n) SBasePlugin
Each variant is described separately below.
getPlugin(long n)
Returns the nth plug-in object (extension interface) for an SBML Level 3 package extension. The returned plug-in will be the appropriate type of plugin requested: calling Model.getPlugin() will return an FbcModelPlugin; calling Parameter.getPlugin() will return CompSBasePlugin, etc.
If no such plugin exists, None is returned.
n | the index of the plug-in to return. |
n
is invalid, None
is returned.getPlugin(string package)
Returns a plug-in object (extension interface) for an SBML Level 3 package extension with the given package name or URI. The returned plug-in will be the appropriate type of plugin requested: calling Model.getPlugin() will return an FbcModelPlugin; calling Parameter.getPlugin() will return CompSBasePlugin, etc.
If no such plugin exists, None is returned.
package | the name or URI of the package. |
|
inherited |
|
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 object pointed to by this element.
getReferencedElement() SBase
If that element was previously found and set with 'saveReferencedElement', that element is returned; otherwise, 'saveReferencedElement' is called first, and the found element is returned.
def libsbml.ReplacedElement.getReferencedElementFrom | ( | self, | |
model | |||
) |
Finds the SBase object this ReplacedElement object points to, if any.
getReferencedElementFrom(Model model) SBase
|
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 |
|
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.
|
inherited |
def libsbml.ReplacedElement.getTypeCode | ( | self | ) |
Returns the libSBML type code of this object instance.
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 |
|
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 |
Returns True
if getNumReferents() is exactly 1 and if the submodelRef is set.
hasRequiredAttributes() bool
|
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.
|
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.def libsbml.ReplacedElement.isSetConversionFactor | ( | self | ) |
Predicate returning True
or False
depending on whether this ReplacedElement's 'conversionFactor' attribute has been set.
isSetConversionFactor() bool
True
if this ReplacedElement's 'conversionFactor' attribute has been set, otherwise False
is returned. def libsbml.ReplacedElement.isSetDeletion | ( | self | ) |
Predicate returning True
or False
depending on whether this SBaseRef's 'deletion' attribute has been set.
isSetDeletion() bool
True
if this ReplacedElement's 'deletion' attribute has been set, otherwise False
is returned.
|
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 |
|
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.
|
inherited |
|
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.
|
inherited |
|
inherited |
|
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 |
|
inherited |
|
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.
|
inherited |
DEPRECATED FUNCTION: DO NOT USE.
Deletes the referenced object, plus any other elements that element points to through ReplacedElement or ReplacedBy children.
performDeletion() int
Instead of calling this function directly, use 'CompModelPlugin::instantiateSubmodels' instead, which deals with all the intricacies of replacements and deletions, and gives you access to the non-flattened hierarchical form of the model.
|
inherited |
DEPRECATED FUNCTION: DO NOT USE.
To retain old functionality, this function calls performReplacementAndCollect, and then actually removes the now-redundant element.
performReplacement() int
However, this can lead to doubly-deleted elements, as well as the incorrect interpretation of some models. The replacement function performReplacementAndCollect has been marked protected, in the hopes that people will instead simply use CompModelPlugin::instantiateSubmodels, which hides all the complexity while still allowing access to a non-flattened version of a hierarchical model.
|
inherited |
|
inherited |
Removes the top-level element within the 'annotation' subelement of this SBML object with the given name and optional URI.
removeTopLevelAnnotationElement(string elementName, string elementURI, bool removeEmpty) int removeTopLevelAnnotationElement(string elementName, string elementURI) int removeTopLevelAnnotationElement(string elementName) int
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Calling this method allows a particular annotation element to be removed whilst the remaining annotations remain intact.
elementName | a string representing the name of the top level annotation element that is to be removed. |
elementURI | an optional string that is used to check both the name and URI of the top level element to be removed. |
removeEmpty | if after removing of the element, the annotation is empty, and the removeEmpty argument is true, the annotation node will be deleted (default). |
parameter
= value
. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.
|
inherited |
Replaces all uses of a given meta identifier attribute value with another value.
renameMetaIdRefs(string oldid, string newid)
ID
; the SBML object attribute itself is typically named metaid
. All attributes that hold values referring to values of type ID
are of the XML data type IDREF
. They are also sometimes informally referred to as 'metaid refs', in analogy to the SBML-defined type SIdRef
.This method works by looking at all meta-identifier attribute values, comparing the identifiers to the value of oldid
. If any matches are found, the matching identifiers are replaced with newid
. The method does not descend into child elements.
oldid | the old identifier. |
newid | the new identifier. |
def libsbml.ReplacedElement.renameSIdRefs | ( | self, | |
oldid, | |||
newid | |||
) |
Replaces all uses of a given SIdRef
type attribute value with another value.
renameSIdRefs(string oldid, string newid)
SId
. In SBML Level 3, an explicit data type called SIdRef
was introduced for attribute values that refer to SId
values; in previous Levels of SBML, this data type did not exist and attributes were simply described to as 'referring to an identifier', but the effective data type was the same as SIdRef
in Level 3. These and other methods of libSBML refer to the type SIdRef
for all Levels of SBML, even if the corresponding SBML specification did not explicitly name the data type.This method works by looking at all attributes and (if appropriate) mathematical formulas in MathML content, comparing the referenced identifiers to the value of oldid
. If any matches are found, the matching values are replaced with newid
. The method does not descend into child elements.
oldid | the old identifier. |
newid | the new identifier. |
|
inherited |
Replaces all uses of a given UnitSIdRef
type attribute value with another value.
renameUnitSIdRefs(string oldid, string newid)
UnitSId
. In SBML Level 3, an explicit data type called UnitSIdRef
was introduced for attribute values that refer to UnitSId
values; in previous Levels of SBML, this data type did not exist and attributes were simply described to as 'referring to a unit identifier', but the effective data type was the same as UnitSIdRef
in Level 3. These and other methods of libSBML refer to the type UnitSIdRef
for all Levels of SBML, even if the corresponding SBML specification did not explicitly name the data type.This method works by looking at all unit identifier attribute values (including, if appropriate, inside mathematical formulas), comparing the referenced unit identifiers to the value of oldid
. If any matches are found, the matching values are replaced with newid
. The method does not descend into child elements.
oldid | the old identifier. |
newid | the new identifier. |
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
replaceTopLevelAnnotationElement(XMLNode annotation) int replaceTopLevelAnnotationElement(string annotation) int
Each variant is described separately below.
replaceTopLevelAnnotationElement(XMLNode annotation)
Replaces the given top-level element within the 'annotation' subelement of this SBML object and with the annotation element supplied.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
This method determines the name of the element to be replaced from the annotation argument. Functionally it is equivalent to calling removeTopLevelAnnotationElement(name)
followed by calling appendAnnotation(annotation_with_name)
, with the exception that the placement of the annotation element remains the same.
annotation | XMLNode representing the replacement top level annotation. |
replaceTopLevelAnnotationElement(string annotation)
Replaces the given top-level element within the 'annotation' subelement of this SBML object and with the annotation element supplied.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
This method determines the name of the element to be replaced from the annotation argument. Functionally it is equivalent to calling removeTopLevelAnnotationElement(name)
followed by calling appendAnnotation(annotation_with_name)
, with the exception that the placement of the annotation element remains the same.
annotation | string representing the replacement top level annotation. |
|
inherited |
Finds and stores the referenced object.
saveReferencedElement() int
Finds the Submodel to which it refers, getting the instantiated Model inside that Submodel, calling 'getReferencedElementFrom' on that model, and storing the result.
|
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.ReplacedElement.setConversionFactor | ( | self, | |
id | |||
) |
Sets the value of the 'conversionFactor' attribute of this ReplacedElement.
setConversionFactor(string id) int
def libsbml.ReplacedElement.setDeletion | ( | self, | |
id | |||
) |
Sets the value of the 'deletion' attribute of this ReplacedElement.
setDeletion(string id) int
This method fails if the id is not a valid syntax for an SIdRef (LIBSBML_INVALID_ATTRIBUTE_VALUE), or if the SBaseRef already points to an element of the submodel using a different interface (LIBSBML_OPERATION_FAILED). A ReplacedElement must use exactly one method to point to a submodel element: deletion, port, idRef, unitRef, or metaIdRef.
|
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. |
|
inherited |
Sets the value of the 'idRef' attribute of this SBaseRef.
setIdRef(string id) int
This method fails if the id is not a valid syntax for an SIdRef
(LIBSBML_INVALID_ATTRIBUTE_VALUE), or if the SBaseRef already points to an element of the submodel using a different interface (LIBSBML_OPERATION_FAILED). A sBaseRef must use exactly one method to point to a submodel element.
|
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. |
|
inherited |
Sets the value of the 'metaIdRef' attribute of this SBaseRef.
setMetaIdRef(string id) int
This method fails if the id is not a valid syntax for an IDREF
(LIBSBML_INVALID_ATTRIBUTE_VALUE), or if the SBaseRef already points to an element of the submodel using a different interface (LIBSBML_OPERATION_FAILED). An sBaseRef must use exactly one method to point to a submodel element.
|
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. |
|
inherited |
Sets the value of the 'portRef' attribute of this SBaseRef.
setPortRef(string id) int
Fails if the id is not a valid syntax for a PortSIdRef
(LIBSBML_INVALID_ATTRIBUTE_VALUE), or if the SBaseRef already points to an element of the submodel using a different interface (LIBSBML_OPERATION_FAILED). An SBaseRef must use exactly one method to point to a submodel element.
|
inherited |
Sets the sBaseRef definition of this SBaseRef to a copy of the given SBaseRef object instance.
setSBaseRef(SBaseRef sBaseRef) int
This method fails if the added sBaseRef does not match the level/version/package of the parent object or if the added sBaseRef cannot be copied.
sBaseRef | the SBaseRef object instance to use. |
|
inherited |
This method has multiple variants; they differ in the arguments they accept.
setSBOTerm(int value) int setSBOTerm(string sboid) int
Each variant is described separately below.
setSBOTerm(int value)
Sets the value of the 'sboTerm' attribute.
int
, and SBO identifiers are stored simply as integers. value | the NNNNNNN integer portion of the SBO identifier. |
setSBOTerm(string sboid)
Sets the value of the 'sboTerm' attribute by string.
int
, and SBO identifiers are stored simply as integers.
|
inherited |
Sets the value of the 'submodelRef' attribute of this SBaseRef.
setSubmodelRef(string id) int
Fails if the id is not a valid syntax for an SIdRef.
|
inherited |
Sets the value of the 'unitRef' attribute of this SBaseRef.
setUnitRef(string id) int
This method fails if the id is not a valid syntax for a UnitSIdRef
(LIBSBML_INVALID_ATTRIBUTE_VALUE), or if the SBaseRef already points to an element of the submodel using a different interface (LIBSBML_OPERATION_FAILED). A sBaseRef must use exactly one method to point to a submodel element.
|
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.
def libsbml.ReplacedElement.unsetConversionFactor | ( | self | ) |
Unsets the value of the 'conversionFactor' attribute of this ReplacedElement.
unsetConversionFactor() int
|
inherited |
Clears the list of CVTerm objects attached to this SBML object.
unsetCVTerms() int
def libsbml.ReplacedElement.unsetDeletion | ( | self | ) |
Unsets the value of the 'deletion' attribute of this ReplacedElement.
unsetDeletion() 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 'idRef' attribute of this SBaseRef.
unsetIdRef() 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 '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 value of the 'metaIdRef' attribute of this SBaseRef.
unsetMetaIdRef() int
|
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 'portRef' attribute of this SBaseRef.
unsetPortRef() int
|
inherited |
|
inherited |
Unsets the value of the 'sboTerm' attribute of this SBML object.
unsetSBOTerm() int
|
inherited |
Unsets the value of the 'SubmodelRef' attribute of this SBaseRef.
unsetSubmodelRef() int
|
inherited |
Unsets the value of the 'unitRef' attribute of this SBaseRef.
unsetUnitRef() int
|
inherited |
Unsets the user data of this element.
unsetUserData() int