libSBML C# API
libSBML 5.8.0 C# API
|
Log of errors and other events encountered during SBML processing.
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. Each SBMLDocument maintains its own SBMLErrorLog. When a libSBML operation on SBML content results in an error, or when there is something worth noting about the SBML content, the issue is reported as an SBMLError object stored in the SBMLErrorLog list.
SBMLErrorLog is derived from XMLErrorLog, an object class that serves exactly the same purpose but for the XML parsing layer. XMLErrorLog provides crucial methods such as getNumErrors() for determining how many SBMLError or XMLError objects are in the log. SBMLErrorLog inherits these methods.
The general approach to working with SBMLErrorLog in user programs involves first obtaining a pointer to a log from a libSBML object such as SBMLDocument. Callers should then use getNumErrors() to inquire how many objects there are in the list. (The answer may be 0.) If there is at least one SBMLError object in the SBMLErrorLog instance, callers can then iterate over the list using SBMLErrorLog::getError(), using methods provided by the SBMLError class to find out the error code and associated information such as the error severity, the message, and the line number in the input.
If you wish to simply print the error strings for a human to read, an easier and more direct way might be to use SBMLDocument::printErrors().
Public Member Functions | |
void | add (XMLError error) |
Logs the given XMLError. More... | |
void | add (SBMLError error) |
Adds the given SBMLError to the log. More... | |
void | clearLog () |
Deletes all errors from this log. More... | |
bool | contains (long errorId) |
Returns true if SBMLErrorLog contains an errorId. More... | |
override void | Dispose () |
override bool | Equals (Object sb) |
new SBMLError | getError (long n) |
Returns the nth SBMLError object in this log. More... | |
override int | GetHashCode () |
long | getNumErrors () |
Returns the number of errors that have been logged. More... | |
long | getNumFailsWithSeverity (long severity) |
Returns the number of errors that have been logged with the given severity code. More... | |
void | logError (long errorId, long level, long version, string details, long line, long column, long severity, long category) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logError (long errorId, long level, long version, string details, long line, long column, long severity) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logError (long errorId, long level, long version, string details, long line, long column) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logError (long errorId, long level, long version, string details, long line) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logError (long errorId, long level, long version, string details) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logError (long errorId, long level, long version) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logError (long errorId, long level) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logError (long errorId) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logError () |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logPackageError (string package, long errorId, long pkgVersion, long level, long version, string details, long line, long column, long severity, long category) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logPackageError (string package, long errorId, long pkgVersion, long level, long version, string details, long line, long column, long severity) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logPackageError (string package, long errorId, long pkgVersion, long level, long version, string details, long line, long column) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logPackageError (string package, long errorId, long pkgVersion, long level, long version, string details, long line) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logPackageError (string package, long errorId, long pkgVersion, long level, long version, string details) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logPackageError (string package, long errorId, long pkgVersion, long level, long version) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logPackageError (string package, long errorId, long pkgVersion, long level) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logPackageError (string package, long errorId, long pkgVersion) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logPackageError (string package, long errorId) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logPackageError (string package) |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | logPackageError () |
Convenience function that combines creating an SBMLError object and adding it to the log. More... | |
void | printErrors (OStream stream) |
Prints all the errors or warnings stored in this error log. More... | |
void | printErrors () |
Prints all the errors or warnings stored in this error log. More... | |
void | remove (long errorId) |
Removes an error having errorId from the SBMLError list. More... | |
SBMLErrorLog () | |
Creates a new, empty SBMLErrorLog. More... | |
string | toString () |
Writes all errors contained in this log to a string and returns it. More... | |
Static Public Member Functions | |
static bool | operator!= (XMLErrorLog lhs, XMLErrorLog rhs) |
static bool | operator== (XMLErrorLog lhs, XMLErrorLog rhs) |
Protected Attributes | |
bool | swigCMemOwn |
libsbmlcs.SBMLErrorLog.SBMLErrorLog | ( | ) |
Creates a new, empty SBMLErrorLog.
|
inherited |
void libsbmlcs.SBMLErrorLog.add | ( | SBMLError | error | ) |
|
inherited |
Deletes all errors from this log.
bool libsbmlcs.SBMLErrorLog.contains | ( | long | errorId | ) |
Returns true if SBMLErrorLog contains an errorId.
errorId | the error identifier of the error to be found. |
|
virtual |
Reimplemented from libsbmlcs.XMLErrorLog.
|
inherited |
new SBMLError libsbmlcs.SBMLErrorLog.getError | ( | long | n | ) |
Returns the nth SBMLError 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 getNumErrors() method. Attempts to use an error index number that exceeds the actual number of errors in the log will result in a null
being returned.
n | the index number of the error to retrieve (with 0 being the first error). |
null
if n
is greater than or equal to getNumErrors().
|
inherited |
|
inherited |
Returns the number of errors that have been logged.
To retrieve individual errors from the log, callers may use XMLErrorLog::getError(long n) .
long libsbmlcs.SBMLErrorLog.getNumFailsWithSeverity | ( | long | severity | ) |
Returns the number of errors that have been logged with the given severity code.
LibSBML associates severity levels with every SBMLError object to provide an indication of how serious the problem is. Severities range from informational diagnostics to fatal (irrecoverable) errors. Given an SBMLError object instance, a caller can interrogate it for its severity level using methods such as SBMLError::getSeverity(), SBMLError::isFatal(), and so on. The present method encapsulates iteration and interrogation of all objects in an SBMLErrorLog, making it easy to check for the presence of error objects with specific severity levels.
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level, | ||
long | version, | ||
string | details, | ||
long | line, | ||
long | column, | ||
long | severity, | ||
long | category | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level, | ||
long | version, | ||
string | details, | ||
long | line, | ||
long | column, | ||
long | severity | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level, | ||
long | version, | ||
string | details, | ||
long | line, | ||
long | column | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level, | ||
long | version, | ||
string | details, | ||
long | line | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level, | ||
long | version, | ||
string | details | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level, | ||
long | version | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId | ) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logError | ( | ) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level, | ||
long | version, | ||
string | details, | ||
long | line, | ||
long | column, | ||
long | severity, | ||
long | category | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level, | ||
long | version, | ||
string | details, | ||
long | line, | ||
long | column, | ||
long | severity | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level, | ||
long | version, | ||
string | details, | ||
long | line, | ||
long | column | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level, | ||
long | version, | ||
string | details, | ||
long | line | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level, | ||
long | version, | ||
string | details | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level, | ||
long | version | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId | ||
) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package | ) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | ) |
Convenience function that combines creating an SBMLError object and adding it to the log.
errorId | a long integer, the identification number of the error. |
level | a long integer, the SBML Level |
version | a long integer, the SBML Level's Version |
details | a string containing additional details about the error. If the error code in errorId is one that is recognized by SBMLError, the given message is appended to a predefined message associated with the given code. If the error code is not recognized, the message is stored as-is as the text of the error. |
line | a long integer, the line number at which the error occured. |
column | a long integer, the column number at which the error occured. |
severity | an integer indicating severity of the error. |
category | an integer indicating the category to which the error belongs. |
|
staticinherited |
|
staticinherited |
|
inherited |
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
stream | the ostream or ostringstream object indicating where the output should be printed. |
|
inherited |
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
stream | the ostream or ostringstream object indicating where the output should be printed. |
void libsbmlcs.SBMLErrorLog.remove | ( | long | errorId | ) |
Removes an error having errorId from the SBMLError list.
Only the first item will be removed if there are multiple errors with the given errorId.
errorId | the error identifier of the error to be removed. |
|
inherited |
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.
|
protectedinherited |