libSBML C++ API  libSBML 5.8.0 C++ API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SBMLReader.h File Reference

Detailed Description

Reads an SBML Document into memory.

Author
Ben Bornstein
Include dependency graph for SBMLReader.h:
This graph shows which files directly or indirectly include this file:

Classes

class  SBMLReader
 Methods for reading SBML from files and text strings. More...
 

Functions

SBMLDocument_treadSBML (const char *filename)
 Reads an SBML document from the given file filename. More...
 
SBMLDocument_treadSBMLFromFile (const char *filename)
 
SBMLDocument_treadSBMLFromString (const char *xml)
 Reads an SBML document from a string assumed to be in XML format. More...
 

Function Documentation

SBMLDocument_t* readSBML ( const char *  filename)

Reads an SBML document from the given file filename.

If filename does not exist, or it is not an SBML file, an error will be logged in the error log of the SBMLDocument object returned by this method. Calling programs can inspect this error log to determine the nature of the problem. Please refer to the definition of SBMLDocument for more information about the error reporting mechanism.

Returns
a pointer to the SBMLDocument read.
SBMLDocument_t* readSBMLFromFile ( const char *  filename)
SBMLDocument_t* readSBMLFromString ( const char *  xml)

Reads an SBML document from a string assumed to be in XML format.

If the string does not begin with XML declaration,

<?xml version='1.0' encoding='UTF-8'?>

an XML declaration string will be prepended.

This method will report an error if the given string xml is not SBML. The error will be logged in the error log of the SBMLDocument object returned by this method. Calling programs can inspect this error log to determine the nature of the problem. Please refer to the definition of SBMLDocument for more information about the error reporting mechanism.

Returns
a pointer to the SBMLDocument read.