libSBML Python API  5.8.0
 All Classes Namespaces Files Functions Variables Pages
libsbml.XMLErrorLog Class Reference
Inheritance diagram for libsbml.XMLErrorLog:
[legend]

Detailed Description

Log of errors and other events encountered while processing an XML file or data stream.

This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.

The error log is a list. The XML layer of libSBML maintains an error log associated with a given XML document or data stream. When an operation results in an error, or when there is something wrong with the XML content, the problem is reported as an XMLError object stored in the XMLErrorLog list. Potential problems range from low-level issues (such as the inability to open a file) to XML syntax errors (such as mismatched tags or other problems).

A typical approach for using this error log is to first use getNumErrors() to inquire how many XMLError object instances it contains, and then to iterate over the list of objects one at a time using getError(long n) const. Indexing in the list begins at 0.

In normal circumstances, programs using libSBML will actually obtain an SBMLErrorLog rather than an XMLErrorLog. The former is subclassed from XMLErrorLog and simply wraps commands for working with SBMLError objects rather than the low-level XMLError objects. Classes such as SBMLDocument use the higher-level SBMLErrorLog.

Public Member Functions

def add
 
def clearLog
 
def getError
 
def getNumErrors
 
def printErrors
 
def toString
 

Member Function Documentation

def libsbml.XMLErrorLog.add (   self,
  args 
)

Python method signature(s):

add(XMLErrorLog self, XMLError error)
def libsbml.XMLErrorLog.clearLog (   self)

Python method signature(s):

clearLog(XMLErrorLog self)

Deletes all errors from this log.

def libsbml.XMLErrorLog.getError (   self,
  args 
)

Python method signature(s):

getError(XMLErrorLog self, long n)   XMLError

Returns the nth XMLError object in this log.

Index n is counted from 0. Callers should first inquire about the number of items in the log by using the method getNumErrors(). Attempts to use an error index number that exceeds the actual number of errors in the log will result in a None being returned.

Parameters
nthe index number of the error to retrieve (with 0 being the first error).
Returns
the nth XMLError in this log, or None if n is greater than or equal to getNumErrors().
See Also
getNumErrors()
def libsbml.XMLErrorLog.getNumErrors (   self)

Log of errors and other events encountered while processing an XML file or data stream.

This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.

The error log is a list. The XML layer of libSBML maintains an error log associated with a given XML document or data stream. When an operation results in an error, or when there is something wrong with the XML content, the problem is reported as an XMLError object stored in the XMLErrorLog list. Potential problems range from low-level issues (such as the inability to open a file) to XML syntax errors (such as mismatched tags or other problems).

A typical approach for using this error log is to first use getNumErrors() to inquire how many XMLError object instances it contains, and then to iterate over the list of objects one at a time using getError(long n) const. Indexing in the list begins at 0.

In normal circumstances, programs using libSBML will actually obtain an SBMLErrorLog rather than an XMLErrorLog. The former is subclassed from XMLErrorLog and simply wraps commands for working with SBMLError objects rather than the low-level XMLError objects. Classes such as SBMLDocument use the higher-level SBMLErrorLog. Python method signature(s):

getNumErrors(XMLErrorLog self)   long

Returns the number of errors that have been logged.

To retrieve individual errors from the log, callers may use XMLErrorLog.getError() .

Returns
the number of errors that have been logged.
def libsbml.XMLErrorLog.printErrors (   self,
  args 
)

Python method signature(s):

printErrors(XMLErrorLog self, ostream stream=cerr)
printErrors(XMLErrorLog self)

Prints all the errors or warnings stored in this error log

It prints the text to the stream given by the optional parameter stream. If no parameter is given, it prints the output to the standard error stream.

If no errors have occurred, i.e., getNumErrors() == 0, no output will be sent to the stream.

The format of the output is:

    N error(s):
      line NNN: (id) message
Parameters
streamthe ostream or ostringstream object indicating where the output should be printed.
Documentation note:
The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.
def libsbml.XMLErrorLog.toString (   self)

Python method signature(s):

toString(XMLErrorLog self)   string

Writes all errors contained in this log to a string and returns it.

This method uses printErrors() to format the diagnostic messages. Please consult that method for information about the organization of the messages in the string returned by this method.

Returns
a string containing all logged errors and warnings.
See Also
printErrors()