libSBML Python API
5.18.0
|
This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.
SBML Level 3 “packages” add features on top of SBML Level 3 Core. When a model definition uses an SBML package, it must declare the Level and Version of SBML Core and the Version of the package being used. The package name, the SBML Level and Version, and the package Version correspond uniquely to an XML namespace added to the XML encoding of the SBML model.
LibSBML Level 3 extensions are implementations of support for SBML Level 3 packages. Each package is implemented as a separate extension. To allow software applications to query the level and version information of an extension's package implementation, libSBML uses specialized object classes. For the extension implementing the SBML “multi” package, the object class is MultiPkgNamespaces. (This class is a specialization of a common base class called SBMLExtensionNamespaces
that is not exposed in the libSBML programming language interfaces other than C++.)
Objects of class MultiPkgNamespaces can be passed to constructors of SBML components defined by “multi” in order to ensure that the correct component structure is created. This is necessary because different versions of an SBML Level 3 package may introduce differences in the definition of the components defined by the package. (For example, later editions of a package may introduce new attributes on a component that are not present in earlier editions of the package specification.)
Public Member Functions | |
def | addNamespace (self, uri, prefix) |
Add an XML namespace (a pair of URI and prefix) to the set of namespaces within this SBMLNamespaces object. More... | |
def | addNamespaces (self, xmlns) |
Add the given XML namespaces list to the set of namespaces within this SBMLNamespaces object. More... | |
def | addPackageNamespace (self, args) |
Add an XML namespace (a pair of URI and prefix) of a package extension to the set of namespaces within this SBMLNamespaces object. More... | |
def | addPackageNamespaces (self, xmlns) |
Add the XML namespaces of package extensions in the given XMLNamespace object to the set of namespaces within this SBMLNamespaces object (Non-package XML namespaces are not added by this function). More... | |
def | clone (self) |
Creates and returns a deep copy of this SBMLExtensionNamespaces. More... | |
def | freeSBMLNamespaces (supportedNS) |
Frees the list of supported namespaces as generated by getSupportedNamespaces(). More... | |
def | getLevel (self, args) |
Get the SBML Level of this SBMLNamespaces object. More... | |
def | getNamespaces (self, args) |
Get the XML namespaces list for this SBMLNamespaces object. More... | |
def | getPackageName (self) |
Returns the name of the main package for this namespace. More... | |
def | getSBMLNamespaceURI (level, version) |
Returns a string representing the SBML XML namespace for the given level and version of SBML. More... | |
def | getSupportedNamespaces () |
Returns a list of all supported SBMLNamespaces in this version of libsbml. More... | |
def | getURI (self) |
Returns a string representing the SBML XML namespace of this object. More... | |
def | getVersion (self, args) |
Get the SBML Version of this SBMLNamespaces object. More... | |
def | isSBMLNamespace (uri) |
Predicate returning True if the given URL is one of SBML XML namespaces. More... | |
def | isValidCombination (self) |
Predicate returning True if the given set of namespaces represent a valid set. More... | |
def | removeNamespace (self, uri) |
Removes an XML namespace from the set of namespaces within this SBMLNamespaces object. More... | |
def | removePackageNamespace (self, level, version, pkgName, pkgVersion) |
Removes an XML namespace of a package extension from the set of namespaces within this SBMLNamespaces object. More... | |
|
inherited |
Add an XML namespace (a pair of URI and prefix) to the set of namespaces within this SBMLNamespaces object.
addNamespace(string uri, string prefix) int
uri | the XML namespace to be added. |
prefix | the prefix of the namespace to be added. |
|
inherited |
Add the given XML namespaces list to the set of namespaces within this SBMLNamespaces object.
addNamespaces(XMLNamespaces xmlns) int
The following code gives an example of how one could add the XHTML namespace to the list of namespaces recorded by the top-level <sbml>
element of a model. It gives the new namespace a prefix of html
.
xmlns | the XML namespaces to be added. |
|
inherited |
Add an XML namespace (a pair of URI and prefix) of a package extension to the set of namespaces within this SBMLNamespaces object.
addPackageNamespace(string pkgName, long pkgVersion, string prefix) int addPackageNamespace(string pkgName, long pkgVersion) int
The SBML Level and SBML Version of this object is used.
pkgName | the string of package name (e.g. 'layout', 'multi'). |
pkgVersion | the package version. |
prefix | the prefix of the package namespace to be added. The package's name will be used if the given string is empty (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 |
Add the XML namespaces of package extensions in the given XMLNamespace object to the set of namespaces within this SBMLNamespaces object (Non-package XML namespaces are not added by this function).
addPackageNamespaces(XMLNamespaces xmlns) int
xmlns | the XML namespaces to be added. |
None
. def libsbml.MultiPkgNamespaces.clone | ( | self | ) |
Creates and returns a deep copy of this SBMLExtensionNamespaces.
clone() MultiPkgNamespaces
|
inherited |
Frees the list of supported namespaces as generated by getSupportedNamespaces().
freeSBMLNamespaces(List * supportedNS)
supportedNS | the list to be freed. |
|
inherited |
Get the SBML Level of this SBMLNamespaces object.
getLevel() long
|
inherited |
Get the XML namespaces list for this SBMLNamespaces object.
getNamespaces() XMLNamespaces
The plural name (SBMLNamespaces) is not a mistake, because in SBML Level 3, objects may have extensions added by Level 3 packages used by a given model and therefore may have multiple namespaces associated with them. In SBML Levels below Level 3, the SBMLNamespaces object only records one SBML Level/Version/namespace combination at a time. Most constructors for SBML objects in libSBML take a SBMLNamespaces object as an argument, thereby allowing the constructor to produce the proper combination of attributes and other internal data structures for the given SBML Level and Version.
def libsbml.MultiPkgNamespaces.getPackageName | ( | self | ) |
Returns the name of the main package for this namespace.
getPackageName() string
|
inherited |
Returns a string representing the SBML XML namespace for the given level
and version
of SBML.
getSBMLNamespaceURI(long level, long version) string
level | the SBML level. |
version | the SBML version. |
|
inherited |
Returns a list of all supported SBMLNamespaces in this version of libsbml.
getSupportedNamespaces() List *
def libsbml.MultiPkgNamespaces.getURI | ( | self | ) |
Returns a string representing the SBML XML namespace of this object.
getURI() string
|
inherited |
Get the SBML Version of this SBMLNamespaces object.
getVersion() long
|
inherited |
Predicate returning True
if the given URL is one of SBML XML namespaces.
isSBMLNamespace(string uri) bool
uri | the URI of namespace. |
True
if the 'uri' is one of SBML namespaces, False
otherwise.
|
inherited |
Predicate returning True
if the given set of namespaces represent a valid set.
True
if the set of namespaces is valid, False
otherwise.isValidCombination() bool
|
inherited |
Removes an XML namespace from the set of namespaces within this SBMLNamespaces object.
removeNamespace(string uri) int
uri | the XML namespace to be added. |
|
inherited |
Removes an XML namespace of a package extension from the set of namespaces within this SBMLNamespaces object.
removePackageNamespace(long level, long version, string pkgName, long pkgVersion) int
level | the SBML level. |
version | the SBML version. |
pkgName | the string of package name (e.g. 'layout', 'multi'). |
pkgVersion | the package version. |