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

Detailed Description

{comp}

comp Base class for 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.

The SBMLResolver class is the base class for the various SBML resolvers: facilities that take a unique identifier as input and return the document associated with that identifier. In SBML, resolvers come into play with the SBML Level 3 Hierarchical Model Composition package; this package includes features that allow a model to be composed from pieces that are external to a given SBML document, which implies the need to be able to identify and locate those external pieces. The SBMLResolver class and its subclasses provide facilities for software applications to be able to do these tasks.

LibSBML provides a number of built-in resolvers, and applications can create their own by subclassing SBMLResolver and following the examples of the existing resolvers. The following are the built-in resolvers in libSBML 5.10.0 :

More resolvers may be provided by libSBML in the future. Application authors may also write their own.

See also
SBMLUri

Public Member Functions

def clone
 
def resolve
 
def resolveUri
 

Member Function Documentation

def libsbml.SBMLResolver.clone (   self)

{comp}

comp Base class for 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.

The SBMLResolver class is the base class for the various SBML resolvers: facilities that take a unique identifier as input and return the document associated with that identifier. In SBML, resolvers come into play with the SBML Level 3 Hierarchical Model Composition package; this package includes features that allow a model to be composed from pieces that are external to a given SBML document, which implies the need to be able to identify and locate those external pieces. The SBMLResolver class and its subclasses provide facilities for software applications to be able to do these tasks.

LibSBML provides a number of built-in resolvers, and applications can create their own by subclassing SBMLResolver and following the examples of the existing resolvers. The following are the built-in resolvers in libSBML 5.10.0 :

More resolvers may be provided by libSBML in the future. Application authors may also write their own.

See also
SBMLUri Python method signature(s):
clone(SBMLResolver self)   SBMLResolver

Creates and returns a deep copy of this SBMLResolver object.

Returns
a (deep) copy of this SBMLResolver object.
def libsbml.SBMLResolver.resolve (   self,
  args 
)

Python method signature(s):

resolve(SBMLResolver self, string uri, string baseUri="")   SBMLDocument
resolve(SBMLResolver 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.SBMLResolver.resolveUri (   self,
  args 
)

Python method signature(s):

resolveUri(SBMLResolver self, string uri, string baseUri="")   SBMLUri
resolveUri(SBMLResolver 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.