libSBML Perl API  libSBML 5.8.0 Perl API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SBMLResolver Class Reference
Inheritance diagram for SBMLResolver:
[legend]

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: classes of objects that resolve SBML documents.

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

Public Member Functions

virtual SBMLResolverclone () const
 Creates and returns a deep copy of this SBMLResolver object. More...
 
SBMLResolveroperator= (const SBMLResolver &rhs)
 Assignment operator for SBMLResolver. More...
 
virtual SBMLDocumentresolve (const std::string &uri, const std::string &baseUri="") const
 Resolves the document for the given URI. More...
 
virtual SBMLUriresolveUri (const std::string &uri, const std::string &baseUri="") const
 Resolves the full URI for the given URI without actually reading the document. More...
 
 SBMLResolver ()
 Creates a new SBMLResolver object. More...
 
 SBMLResolver (const SBMLResolver &c)
 Copy constructor; creates a copy of an SBMLResolver object. More...
 
virtual ~SBMLResolver ()
 Destroy this SBMLResolver object. More...
 

Constructor & Destructor Documentation

SBMLResolver::SBMLResolver ( )

Creates a new SBMLResolver object.

SBMLResolver::SBMLResolver ( const SBMLResolver c)

Copy constructor; creates a copy of an SBMLResolver object.

Parameters
cthe SBMLResolver object to copy.
Exceptions
SBMLConstructorExceptionThrown if the argument orig is NULL.
SBMLResolver::~SBMLResolver ( )
virtual

Destroy this SBMLResolver object.

Member Function Documentation

SBMLResolver * SBMLResolver::clone ( ) const
virtual

Creates and returns a deep copy of this SBMLResolver object.

Returns
a (deep) copy of this SBMLResolver object.

Reimplemented in SBMLFileResolver.

SBMLResolver & SBMLResolver::operator= ( const SBMLResolver rhs)

Assignment operator for SBMLResolver.

Parameters
rhsThe object whose values are used as the basis of the assignment.
Exceptions
SBMLConstructorExceptionThrown if the argument rhs is NULL.
SBMLDocument * SBMLResolver::resolve ( const std::string &  uri,
const std::string &  baseUri = "" 
) const
virtual

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

Reimplemented in SBMLFileResolver.

SBMLUri * SBMLResolver::resolveUri ( const std::string &  uri,
const std::string &  baseUri = "" 
) const
virtual

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

Reimplemented in SBMLFileResolver.