libSBML C++ API  libSBML 5.8.0 C++ API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SBMLFileResolver Class Reference
Inheritance diagram for SBMLFileResolver:
[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 SBMLFileResolver class is the class used for the resolving URIs for relative or absolute files for SBML documents.

Public Member Functions

virtual void addAdditionalDir (const std::string &dir)
 Adds a directory to the list of additional directories in which to search for files to resolve. More...
 
virtual void clearAdditionalDirs ()
 Removes the list of additional directories in which to search for files to resolve. More...
 
virtual SBMLFileResolverclone () const
 Creates and returns a deep copy of this SBMLFileResolver object. More...
 
SBMLFileResolveroperator= (const SBMLFileResolver &rhs)
 Assignment operator for SBMLFileResolver. 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...
 
 SBMLFileResolver ()
 Creates a new SBMLFileResolver object. More...
 
 SBMLFileResolver (const SBMLFileResolver &c)
 Copy constructor; creates a copy of an SBMLFileResolver object. More...
 
virtual void setAdditionalDirs (const std::vector< std::string > &dirs)
 Sets the list of additional directories in which to search for files to resolve. More...
 
virtual ~SBMLFileResolver ()
 Destroy this SBMLFileResolver object. More...
 

Constructor & Destructor Documentation

SBMLFileResolver::SBMLFileResolver ( )

Creates a new SBMLFileResolver object.

SBMLFileResolver::SBMLFileResolver ( const SBMLFileResolver c)

Copy constructor; creates a copy of an SBMLFileResolver object.

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

Destroy this SBMLFileResolver object.

Member Function Documentation

void SBMLFileResolver::addAdditionalDir ( const std::string &  dir)
virtual

Adds a directory to the list of additional directories in which to search for files to resolve.

Parameters
dirThe directory to add
void SBMLFileResolver::clearAdditionalDirs ( )
virtual

Removes the list of additional directories in which to search for files to resolve.

Only absolute or relative directories will be searched.

SBMLFileResolver * SBMLFileResolver::clone ( ) const
virtual

Creates and returns a deep copy of this SBMLFileResolver object.

Returns
a (deep) copy of this SBMLFileResolver object.

Reimplemented from SBMLResolver.

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

Assignment operator for SBMLFileResolver.

Parameters
rhsThe object whose values are used as the basis of the assignment.
Exceptions
SBMLConstructorExceptionThrown if the argument rhs is NULL.
SBMLDocument * SBMLFileResolver::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 from SBMLResolver.

SBMLUri * SBMLFileResolver::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 from SBMLResolver.

void SBMLFileResolver::setAdditionalDirs ( const std::vector< std::string > &  dirs)
virtual

Sets the list of additional directories in which to search for files to resolve.

Parameters
dirsA vector of strings which contain directories