libSBML Python API
5.10.0
|
{comp}
comp Registry of all SBML resolvers.This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. It is a class used in the implementation of extra functionality provided by libSBML.
LibSBML provides facilities for resolving SBML documents in various ways from a given URI. Resolvers are implemented as objects derived from the class SBMLResolver.
The resolver registry maintains a list of known resolvers and provides methods for discovering them. It is implemented as a singleton object of class SBMLResolverRegistry. Callers can use the method SBMLResolverRegistry.getNumResolvers() to find out how many resolvers are registered, then use SBMLResolverRegistry.getResolverByIndex() to iterate over each one;
Public Member Functions | |
def | addResolver |
def | getInstance |
def | getNumResolvers |
def | getResolverByIndex |
def | removeResolver |
def | resolve |
def | resolveUri |
def libsbml.SBMLResolverRegistry.addResolver | ( | self, | |
args | |||
) |
Python method signature(s):
addResolver(SBMLResolverRegistry self, SBMLResolver resolver)int
Adds the given resolver to the registry of SBML resolvers.
resolver | the resolver to add to the registry. |
def libsbml.SBMLResolverRegistry.getInstance | ( | ) |
{comp}
comp Registry of all SBML resolvers.This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. It is a class used in the implementation of extra functionality provided by libSBML.
LibSBML provides facilities for resolving SBML documents in various ways from a given URI. Resolvers are implemented as objects derived from the class SBMLResolver.
The resolver registry maintains a list of known resolvers and provides methods for discovering them. It is implemented as a singleton object of class SBMLResolverRegistry. Callers can use the method SBMLResolverRegistry.getNumResolvers() to find out how many resolvers are registered, then use SBMLResolverRegistry.getResolverByIndex() to iterate over each one;
getInstance()SBMLResolverRegistry
Returns the singleton instance for the resolver registry.
Prior to using the registry, callers have to obtain a copy of the registry. This static method provides the means for doing that.
def libsbml.SBMLResolverRegistry.getNumResolvers | ( | self | ) |
Python method signature(s):
getNumResolvers(SBMLResolverRegistry self)int
Returns the number of resolvers known by the registry.
def libsbml.SBMLResolverRegistry.getResolverByIndex | ( | self, | |
args | |||
) |
Python method signature(s):
getResolverByIndex(SBMLResolverRegistry self, int index)SBMLResolver
Returns the resolver with the given index number.
Resolvers are given arbitrary index numbers by the registry. Callers can use the method SBMLResolverRegistry.getNumResolvers() to find out how many resolvers are registered, then use this method to iterate over the list and obtain each one in turn.
index | the zero-based index of the resolver to fetch. |
None
if the number is less than 0
or there is no resolver at the given index position. def libsbml.SBMLResolverRegistry.removeResolver | ( | self, | |
args | |||
) |
Python method signature(s):
removeResolver(SBMLResolverRegistry self, int index)int
Removes the resolver with the given index.
index | the index of the resolver to be removed |
def libsbml.SBMLResolverRegistry.resolve | ( | self, | |
args | |||
) |
Python method signature(s):
resolve(SBMLResolverRegistry self, string uri, string baseUri="")SBMLDocument resolve(SBMLResolverRegistry self, string uri)
SBMLDocument
Resolves the document for the given URI.
uri | the URI to the target document |
baseUri | base URI, in case the URI is a relative one |
def libsbml.SBMLResolverRegistry.resolveUri | ( | self, | |
args | |||
) |
Python method signature(s):
resolveUri(SBMLResolverRegistry self, string uri, string baseUri="")SBMLUri resolveUri(SBMLResolverRegistry self, string uri)
SBMLUri
Resolves the full URI for the given URI without actually reading the document.
uri | the URI to the target document |
baseUri | base URI, in case the URI is a relative one |