libsbml.SBMLResolver Class Reference

Inheritance diagram for libsbml.SBMLResolver:

Detailed Description

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.18.0:

• SBMLFileResolver

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

See also

SBMLUri

Public Member Functions
def	__init__ (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...
def	clone (self)
	Creates and returns a deep copy of this SBMLResolver object. More...
def	resolve (self, args)
	Resolves the document for the given URI. More...
def	resolveUri (self, args)
	Resolves the full URI for the given URI without actually reading the document. More...

Constructor & Destructor Documentation

def libsbml.SBMLResolver.__init__	(		self,
			args
	)

This method has multiple variants; they differ in the arguments they accept.

__init__()   SBMLResolver
__init__(SBMLResolver c)   SBMLResolver

Each variant is described separately below.

---

Method variant with the following signature:

SBMLResolver()

Creates a new SBMLResolver object.

---

Method variant with the following signature:

SBMLResolver(SBMLResolver c)

Copy constructor. Creates a copy of an SBMLResolver object.

Parameters

c	the SBMLResolver object to copy.

Member Function Documentation

def libsbml.SBMLResolver.clone

(

self

)

Creates and returns a deep copy of this SBMLResolver object.

clone()   SBMLResolver

Returns

a (deep) copy of this SBMLResolver object.

def libsbml.SBMLResolver.resolve	(		self,
			args
	)

Resolves the document for the given URI.

resolve(string uri, string baseUri)   SBMLDocument
resolve(string uri)   SBMLDocument

Parameters

uri	the URI to the target document.
baseUri	base 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
	)

Resolves the full URI for the given URI without actually reading the document.

resolveUri(string uri, string baseUri)   SBMLUri
resolveUri(string uri)   SBMLUri

Parameters

uri	the URI to the target document.
baseUri	base 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.