libSBML C++ API
5.18.0
|
Reads an SBML Document into memory. More...
Classes | |
class | SBMLReader |
File and text-string SBML reader. More... | |
Functions | |
SBMLDocument_t * | readSBML (const char *filename) |
Reads an SBML document from the given file. More... | |
SBMLDocument_t * | readSBMLFromFile (const char *filename) |
Reads an SBML document from the given file. More... | |
SBMLDocument_t * | readSBMLFromString (const char *xml) |
Reads an SBML document from a text string. More... | |
Reads an SBML Document into memory.
SBMLDocument_t* readSBML | ( | const char * | filename | ) |
Reads an SBML document from the given file.
If the file named filename
does not exist or its content is not valid SBML, one or more errors will be logged with the SBMLDocument object returned by this method. Callers can use the methods on SBMLDocument such as , SBMLDocument::getNumErrors() and SBMLDocument::getError() to get the errors. The object returned by SBMLDocument::getError() is an SBMLError object, and it has methods to get the error code, category, and severity level of the problem, as well as a textual description of the problem. The possible severity levels range from informational messages to fatal errors; see the documentation for SBMLError for more information.
If the file filename
could not be read, the file-reading error will appear first. The error code (a value drawn from the enumeration XMLErrorCode_t) can provide a clue about what happened. For example, a file might be unreadable (either because it does not actually exist or because the user does not have the necessary access privileges to read it) or some sort of file operation error may have been reported by the underlying operating system. Callers can check for these situations using a program fragment such as the following:
".gz"
(for example, "myfile.xml.gz"
), the file is assumed to be compressed in gzip format and will be automatically decompressed upon reading. Similarly, if the given filename ends with ".zip"
or ".bz2"
, the file is assumed to be compressed in zip or bzip2 format (respectively). Files whose names lack these suffixes will be read uncompressed. Note that if the file is in zip format but the archive contains more than one file, only the first file in the archive will be read and the rest ignored.SBMLDocument_t* readSBMLFromFile | ( | const char * | filename | ) |
Reads an SBML document from the given file.
If the file named filename
does not exist or its content is not valid SBML, one or more errors will be logged with the SBMLDocument object returned by this method. Callers can use the methods on SBMLDocument such as , SBMLDocument::getNumErrors() and SBMLDocument::getError() to get the errors. The object returned by SBMLDocument::getError() is an SBMLError object, and it has methods to get the error code, category, and severity level of the problem, as well as a textual description of the problem. The possible severity levels range from informational messages to fatal errors; see the documentation for SBMLError for more information.
If the file filename
could not be read, the file-reading error will appear first. The error code (a value drawn from the enumeration XMLErrorCode_t) can provide a clue about what happened. For example, a file might be unreadable (either because it does not actually exist or because the user does not have the necessary access privileges to read it) or some sort of file operation error may have been reported by the underlying operating system. Callers can check for these situations using a program fragment such as the following:
".gz"
(for example, "myfile.xml.gz"
), the file is assumed to be compressed in gzip format and will be automatically decompressed upon reading. Similarly, if the given filename ends with ".zip"
or ".bz2"
, the file is assumed to be compressed in zip or bzip2 format (respectively). Files whose names lack these suffixes will be read uncompressed. Note that if the file is in zip format but the archive contains more than one file, only the first file in the archive will be read and the rest ignored.filename | the name or full pathname of the file to be read. |
filename
. SBMLDocument_t* readSBMLFromString | ( | const char * | xml | ) |
Reads an SBML document from a text string.
This method is flexible with respect to the presence of an XML declaration at the beginning of the string. In particular, if the string in xml
does not begin with the XML declaration
<?xml version='1.0' encoding='UTF-8'?>
then this method will automatically prepend the declaration to xml
.
This method will log a fatal error if the content given in the parameter xml
is not in SBML format. See the method documentation for SBMLReader::readSBML() for an example of code for testing the returned error code.
xml | a string containing a full SBML model. |
xml
.