libSBML Python API
5.10.0
|
{comp}
comp A resolver for documents stored on a file system.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.
In SBML, resolvers come into play with the SBML Level 3 Hierarchical Model Composition package (“comp”); 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 identifiers used in “comp” are URIs (Uniform Resource Identifiers).
SBMLFileResolver is a class implementing the ability to resolve URIs to files. It works on the local file system only. It can resolve relative and absolute paths, and directories to be searched can be specified using the methodsSBMLFileResolver.addAdditionalDir() and SBMLFileResolver.clearAdditionalDirs().
Public Member Functions | |
def | addAdditionalDir |
def | clearAdditionalDirs |
def | clone |
def | resolve |
def | resolveUri |
def libsbml.SBMLFileResolver.addAdditionalDir | ( | self, | |
args | |||
) |
Python method signature(s):
addAdditionalDir(SBMLFileResolver self, string dir)
Adds a directory to the list of directories to search for files to resolve.
dir | the directory to add. |
def libsbml.SBMLFileResolver.clearAdditionalDirs | ( | self | ) |
Python method signature(s):
clearAdditionalDirs(SBMLFileResolver self)
Removes the list of directories to search for files to resolve.
After this method is called, SBMLFileResolver.resolve() will only search absolute or relative directories. New directories can be added using SBMLFileResolver.addAdditionalDir().
def libsbml.SBMLFileResolver.clone | ( | self | ) |
{comp}
comp A resolver for documents stored on a file system.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.
In SBML, resolvers come into play with the SBML Level 3 Hierarchical Model Composition package (“comp”); 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 identifiers used in “comp” are URIs (Uniform Resource Identifiers).
SBMLFileResolver is a class implementing the ability to resolve URIs to files. It works on the local file system only. It can resolve relative and absolute paths, and directories to be searched can be specified using the methodsSBMLFileResolver.addAdditionalDir() and SBMLFileResolver.clearAdditionalDirs().
clone(SBMLFileResolver self)SBMLFileResolver
Creates and returns a deep copy of this SBMLFileResolver object.
def libsbml.SBMLFileResolver.resolve | ( | self, | |
args | |||
) |
Python method signature(s):
resolve(SBMLFileResolver self, string uri, string baseUri="")SBMLDocument resolve(SBMLFileResolver self, string uri)
SBMLDocument
Resolves the document for the given URI.
uri | the URI to the target document |
baseUri | base URI, in case the URI is a relative one |
def libsbml.SBMLFileResolver.resolveUri | ( | self, | |
args | |||
) |
Python method signature(s):
resolveUri(SBMLFileResolver self, string uri, string baseUri="")SBMLUri resolveUri(SBMLFileResolver self, string uri)
SBMLUri
Resolves the full URI for a given URI without actually reading the document.
uri | the URI to the target document |
baseUri | base URI, in case the URI is a relative one |