libSBML C# API  libSBML 5.8.0 C# API
 All Classes Namespaces Files Functions Variables Properties Pages
libsbmlcs.XMLInputStream Class Reference
Inheritance diagram for libsbmlcs.XMLInputStream:
[legend]

Public Member Functions

virtual void Dispose ()
 
string getEncoding ()
 
XMLErrorLog getErrorLog ()
 
SBMLNamespaces getSBMLNamespaces ()
 Prints a string representation of the underlying token stream, for debugging purposes. More...
 
string getVersion ()
 
bool isEOF ()
 
bool isError ()
 
bool isGood ()
 
XMLToken next ()
 Consumes the next XMLToken and return it. More...
 
XMLToken peek ()
 Returns the next XMLToken without consuming it. More...
 
int setErrorLog (XMLErrorLog log)
 Sets the XMLErrorLog this stream will use to log errors. More...
 
void setSBMLNamespaces (SBMLNamespaces sbmlns)
 Prints a string representation of the underlying token stream, for debugging purposes. More...
 
void skipPastEnd (XMLToken element)
 Consume zero or more XMLTokens up to and including the corresponding end XML element or EOF. More...
 
void skipText ()
 Consume zero or more XMLTokens up to but not including the next XML element or EOF. More...
 
string toString ()
 Prints a string representation of the underlying token stream, for debugging purposes. More...
 
 XMLInputStream (string content, bool isFile, string library, XMLErrorLog errorLog)
 Creates a new XMLInputStream. More...
 
 XMLInputStream (string content, bool isFile, string library)
 Creates a new XMLInputStream. More...
 
 XMLInputStream (string content, bool isFile)
 Creates a new XMLInputStream. More...
 
 XMLInputStream (string content)
 Creates a new XMLInputStream. More...
 

Protected Attributes

bool swigCMemOwn
 

Constructor & Destructor Documentation

libsbmlcs.XMLInputStream.XMLInputStream ( string  content,
bool  isFile,
string  library,
XMLErrorLog  errorLog 
)

Creates a new XMLInputStream.

content the source of the stream.

isFile bool flag to indicate whether content is a file name. If true, content is assumed to be the file from which the XML content is to be read. If false, content is taken to be a string that is the content to be read.

library the name of the parser library to use.

errorLog the XMLErrorLog object to use.

libsbmlcs.XMLInputStream.XMLInputStream ( string  content,
bool  isFile,
string  library 
)

Creates a new XMLInputStream.

content the source of the stream.

isFile bool flag to indicate whether content is a file name. If true, content is assumed to be the file from which the XML content is to be read. If false, content is taken to be a string that is the content to be read.

library the name of the parser library to use.

errorLog the XMLErrorLog object to use.

libsbmlcs.XMLInputStream.XMLInputStream ( string  content,
bool  isFile 
)

Creates a new XMLInputStream.

content the source of the stream.

isFile bool flag to indicate whether content is a file name. If true, content is assumed to be the file from which the XML content is to be read. If false, content is taken to be a string that is the content to be read.

library the name of the parser library to use.

errorLog the XMLErrorLog object to use.

libsbmlcs.XMLInputStream.XMLInputStream ( string  content)

Creates a new XMLInputStream.

content the source of the stream.

isFile bool flag to indicate whether content is a file name. If true, content is assumed to be the file from which the XML content is to be read. If false, content is taken to be a string that is the content to be read.

library the name of the parser library to use.

errorLog the XMLErrorLog object to use.

Member Function Documentation

virtual void libsbmlcs.XMLInputStream.Dispose ( )
virtual
string libsbmlcs.XMLInputStream.getEncoding ( )
Returns
the encoding of the XML stream.
XMLErrorLog libsbmlcs.XMLInputStream.getErrorLog ( )
Returns
an XMLErrorLog which can be used to log XML parse errors and other validation errors (and messages).
SBMLNamespaces libsbmlcs.XMLInputStream.getSBMLNamespaces ( )

Prints a string representation of the underlying token stream, for debugging purposes.

string libsbmlcs.XMLInputStream.getVersion ( )
Returns
the version of the XML stream.
bool libsbmlcs.XMLInputStream.isEOF ( )
Returns
true if end of file (stream) has been reached, false otherwise.
bool libsbmlcs.XMLInputStream.isError ( )
Returns
true if a fatal error occurred while reading from this stream.
bool libsbmlcs.XMLInputStream.isGood ( )
Returns
true if the stream is in a good state (i.e. isEOF() and isError() are both false), false otherwise.
XMLToken libsbmlcs.XMLInputStream.next ( )

Consumes the next XMLToken and return it.

Returns
the next XMLToken or EOF (XMLToken.isEOF() == true).
XMLToken libsbmlcs.XMLInputStream.peek ( )

Returns the next XMLToken without consuming it.

A subsequent call to either peek() or next() will return the same token.

Returns
the next XMLToken or EOF (XMLToken.isEOF() == true).
int libsbmlcs.XMLInputStream.setErrorLog ( XMLErrorLog  log)

Sets the XMLErrorLog this stream will use to log errors.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
void libsbmlcs.XMLInputStream.setSBMLNamespaces ( SBMLNamespaces  sbmlns)

Prints a string representation of the underlying token stream, for debugging purposes.

void libsbmlcs.XMLInputStream.skipPastEnd ( XMLToken  element)

Consume zero or more XMLTokens up to and including the corresponding end XML element or EOF.

void libsbmlcs.XMLInputStream.skipText ( )

Consume zero or more XMLTokens up to but not including the next XML element or EOF.

string libsbmlcs.XMLInputStream.toString ( )

Prints a string representation of the underlying token stream, for debugging purposes.

Member Data Documentation

bool libsbmlcs.XMLInputStream.swigCMemOwn
protected