libsbmlcs.SBMLResolver Class Reference

Inheritance diagram for libsbmlcs.SBMLResolver:

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 :

• SBMLFileResolver

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

See also

SBMLUri

Public Member Functions
SBMLResolver	clone ()
	Creates and returns a deep copy of this SBMLResolver object. More...
virtual void	Dispose ()
SBMLDocument	resolve (string uri, string baseUri)
	Resolves the document for the given URI. More...
SBMLDocument	resolve (string uri)
	Resolves the document for the given URI. More...
SBMLUri	resolveUri (string uri, string baseUri)
	Resolves the full URI for the given URI without actually reading the document. More...
SBMLUri	resolveUri (string uri)
	Resolves the full URI for the given URI without actually reading the document. More...
	SBMLResolver ()
	Creates a new SBMLResolver object. More...
	SBMLResolver (SBMLResolver c)
	Copy constructor. More...

Protected Attributes
bool	swigCMemOwn

Constructor & Destructor Documentation

libsbmlcs.SBMLResolver.SBMLResolver

(

)

Creates a new SBMLResolver object.

libsbmlcs.SBMLResolver.SBMLResolver

(

SBMLResolver

c

)

Copy constructor.

Creates a copy of an SBMLResolver object.

Parameters

c	the SBMLResolver object to copy.

Exceptions

SBMLConstructorException

Thrown if the argument orig is null.

Member Function Documentation

SBMLResolver libsbmlcs.SBMLResolver.clone

(

)

Creates and returns a deep copy of this SBMLResolver object.

Returns

a (deep) copy of this SBMLResolver object.

virtual void libsbmlcs.SBMLResolver.Dispose ( )

virtual

Reimplemented in libsbmlcs.SBMLFileResolver.

SBMLDocument libsbmlcs.SBMLResolver.resolve	(	string	uri,
		string	baseUri
	)

Resolves the document for the given URI.

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 null.

SBMLDocument libsbmlcs.SBMLResolver.resolve

(

string

uri

)

Resolves the document for the given URI.

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 null.

SBMLUri libsbmlcs.SBMLResolver.resolveUri	(	string	uri,
		string	baseUri
	)

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

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 null.

SBMLUri libsbmlcs.SBMLResolver.resolveUri

(

string

uri

)

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

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 null.

Member Data Documentation

bool libsbmlcs.SBMLResolver.swigCMemOwn

protected