libSBML Python API  5.10.0
 All Classes Namespaces Files Functions Variables Modules Pages
libsbml.SBMLResolverRegistry Class Reference
Inheritance diagram for libsbml.SBMLResolverRegistry:
[legend]

Detailed Description

{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;

See also
SBMLFileResolver

Public Member Functions

def addResolver
 
def getInstance
 
def getNumResolvers
 
def getResolverByIndex
 
def removeResolver
 
def resolve
 
def resolveUri
 

Member Function Documentation

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.

Parameters
resolverthe resolver to add to the registry.
Returns
integer value indicating the success/failure of the operation. The possible values are:
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;

See also
SBMLFileResolver Python method signature(s):
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.

Returns
the singleton for the resolver registry.
def libsbml.SBMLResolverRegistry.getNumResolvers (   self)

Python method signature(s):

getNumResolvers(SBMLResolverRegistry self)   int

Returns the number of resolvers known by the registry.

Returns
the number of registered resolvers.
See also
getResolverByIndex()
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.

Parameters
indexthe zero-based index of the resolver to fetch.
Returns
the resolver with the given index number, or 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.

Parameters
indexthe index of the resolver to be removed
Returns
integer value indicating the success/failure of the operation. The possible values are:
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.

Parameters
urithe URI to the target document
baseUribase URI, in case the URI is a relative one
Returns
the document, if this resolver can resolve the document or None.
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.

Parameters
urithe URI to the target document
baseUribase URI, in case the URI is a relative one
Returns
the full URI to the document, if this resolver can resolve the document or None.