libSBML C# API
libSBML 5.16.0 C# API
|
{core}
Log of diagnostics reported during 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) |
void | add (SWIGTYPE_p_std__vectorT_XMLError_p_t errors) |
void | add (SBMLError error) |
void | changeErrorSeverity (int originalSeverity, int targetSeverity, string package) |
Changes the severity override for errors in the log that have a given severity. More... | |
void | changeErrorSeverity (int originalSeverity, int targetSeverity) |
Changes the severity override for errors in the log that have a given severity. 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... | |
SBMLError | getErrorWithSeverity (long n, long severity) |
Returns the nth SBMLError object with given severity 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... | |
int | getSeverityOverride () |
Returns the current override. More... | |
bool | isSeverityOverridden () |
Returns a boolean indicating whether or not the severity has been overridden. More... | |
void | logError (long errorId, long level, long version, string details, long line, long column, long severity, long category) |
void | logError (long errorId, long level, long version, string details, long line, long column, long severity) |
void | logError (long errorId, long level, long version, string details, long line, long column) |
void | logError (long errorId, long level, long version, string details, long line) |
void | logError (long errorId, long level, long version, string details) |
void | logError (long errorId, long level, long version) |
void | logError (long errorId, long level) |
void | logError (long errorId) |
void | logError () |
void | logPackageError (string package, long errorId, long pkgVersion, long level, long version, string details, long line, long column, long severity, long category) |
void | logPackageError (string package, long errorId, long pkgVersion, long level, long version, string details, long line, long column, long severity) |
void | logPackageError (string package, long errorId, long pkgVersion, long level, long version, string details, long line, long column) |
void | logPackageError (string package, long errorId, long pkgVersion, long level, long version, string details, long line) |
void | logPackageError (string package, long errorId, long pkgVersion, long level, long version, string details) |
void | logPackageError (string package, long errorId, long pkgVersion, long level, long version) |
void | logPackageError (string package, long errorId, long pkgVersion, long level) |
void | logPackageError (string package, long errorId, long pkgVersion) |
void | logPackageError (string package, long errorId) |
void | logPackageError (string package) |
void | logPackageError () |
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 | printErrors (OStream stream, long severity) |
Prints the errors or warnings with given severity stored in this error log. More... | |
void | remove (long errorId) |
Removes an error having errorId from the SBMLError list. More... | |
void | removeAll (long errorId) |
Removes all errors having errorId from the SBMLError list. More... | |
SBMLErrorLog () | |
SBMLErrorLog (SBMLErrorLog orig) | |
void | setSeverityOverride (int severity) |
Set the severity override. More... | |
string | toString () |
Writes all errors contained in this log to a string and returns it. More... | |
void | unsetSeverityOverride () |
Usets an existing override. 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 | ( | ) |
libsbmlcs.SBMLErrorLog.SBMLErrorLog | ( | SBMLErrorLog | orig | ) |
|
inherited |
|
inherited |
void libsbmlcs.SBMLErrorLog.add | ( | SBMLError | error | ) |
|
inherited |
Changes the severity override for errors in the log that have a given severity.
This method searches through the list of errors in the log, comparing each one's severity to the value of originalSeverity
. For each error encountered with that severity logged by the named package
, the severity of the error is reset to targetSeverity
.
The severity override mechanism in XMLErrorLog is intended to help applications handle error conditions in ways that may be more convenient for those applications. It is possible to use the mechanism to override the severity code of errors logged by libSBML, and even to disable error logging completely. An override stays in effect until the override is changed again by the calling application.
originalSeverity | the severity code to match. |
targetSeverity | the severity code to use as the new severity. |
package | a string, the name of an SBML Level 3 package extension to use to narrow the search for errors. A value of 'all' signifies to match against errors logged from any package; a value of a package nickname such as 'comp' signifies to limit consideration to errors from just that package. If no value is provided, 'all' is the default. |
|
inherited |
Changes the severity override for errors in the log that have a given severity.
This method searches through the list of errors in the log, comparing each one's severity to the value of originalSeverity
. For each error encountered with that severity logged by the named package
, the severity of the error is reset to targetSeverity
.
The severity override mechanism in XMLErrorLog is intended to help applications handle error conditions in ways that may be more convenient for those applications. It is possible to use the mechanism to override the severity code of errors logged by libSBML, and even to disable error logging completely. An override stays in effect until the override is changed again by the calling application.
originalSeverity | the severity code to match. |
targetSeverity | the severity code to use as the new severity. |
package | a string, the name of an SBML Level 3 package extension to use to narrow the search for errors. A value of 'all' signifies to match against errors logged from any package; a value of a package nickname such as 'comp' signifies to limit consideration to errors from just that package. If no value is provided, 'all' is the default. |
|
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().SBMLError libsbmlcs.SBMLErrorLog.getErrorWithSeverity | ( | long | n, |
long | severity | ||
) |
Returns the nth SBMLError object with given severity in this log.
Index n
is counted from 0. Callers should first inquire about the number of items in the log by using the getNumFailsWithSeverity()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). |
severity | the severity of the error to retrieve. |
null
if n
is greater than or equal to getNumFailsWithSeverity().
|
inherited |
|
inherited |
Returns the number of errors that have been logged.
To retrieve individual errors from the log, callers may use XMLErrorLog::getError(unsigned int 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.
|
inherited |
Returns the current override.
The severity override mechanism in XMLErrorLog is intended to help applications handle error conditions in ways that may be more convenient for those applications. It is possible to use the mechanism to override the severity code of errors logged by libSBML, and even to disable error logging completely. An override stays in effect until the override is changed again by the calling application.
LIBSBML_OVERRIDE_
:
|
inherited |
Returns a boolean indicating whether or not the severity has been overridden.
The severity override mechanism in XMLErrorLog is intended to help applications handle error conditions in ways that may be more convenient for those applications. It is possible to use the mechanism to override the severity code of errors logged by libSBML, and even to disable error logging completely. An override stays in effect until the override is changed again by the calling application.
true
if an error severity override has been set, false
otherwise.void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level, | ||
long | version, | ||
string | details, | ||
long | line, | ||
long | column, | ||
long | severity, | ||
long | category | ||
) |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level, | ||
long | version, | ||
string | details, | ||
long | line, | ||
long | column, | ||
long | severity | ||
) |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level, | ||
long | version, | ||
string | details, | ||
long | line, | ||
long | column | ||
) |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level, | ||
long | version, | ||
string | details, | ||
long | line | ||
) |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level, | ||
long | version, | ||
string | details | ||
) |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level, | ||
long | version | ||
) |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId, |
long | level | ||
) |
void libsbmlcs.SBMLErrorLog.logError | ( | long | errorId | ) |
void libsbmlcs.SBMLErrorLog.logError | ( | ) |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level, | ||
long | version, | ||
string | details, | ||
long | line, | ||
long | column, | ||
long | severity, | ||
long | category | ||
) |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level, | ||
long | version, | ||
string | details, | ||
long | line, | ||
long | column, | ||
long | severity | ||
) |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level, | ||
long | version, | ||
string | details, | ||
long | line, | ||
long | column | ||
) |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level, | ||
long | version, | ||
string | details, | ||
long | line | ||
) |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level, | ||
long | version, | ||
string | details | ||
) |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level, | ||
long | version | ||
) |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion, | ||
long | level | ||
) |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId, | ||
long | pkgVersion | ||
) |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package, |
long | errorId | ||
) |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | string | package | ) |
void libsbmlcs.SBMLErrorLog.logPackageError | ( | ) |
|
staticinherited |
|
staticinherited |
|
inherited |
Prints all the errors or warnings stored in this error log.
This method prints the text to the stream given by the optional parameter stream
. If no stream is given, the method prints the output to the standard error stream.
The format of the output is:
N error(s): line NNN: (id) message
If no errors have occurred, i.e., getNumErrors() == 0
, then no output will be produced.
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.
This method prints the text to the stream given by the optional parameter stream
. If no stream is given, the method prints the output to the standard error stream.
The format of the output is:
N error(s): line NNN: (id) message
If no errors have occurred, i.e., getNumErrors() == 0
, then no output will be produced.
stream | the ostream or ostringstream object indicating where the output should be printed. |
|
inherited |
Prints the errors or warnings with given severity stored in this error log.
This method prints the text to the stream given by the optional parameter stream
. If no stream is given, the method prints the output to the standard error stream.
The format of the output is:
N error(s): line NNN: (id) message
If no errors with that severity was found, then no output will be produced.
stream | the ostream or ostringstream object indicating where the output should be printed. |
severity | the severity of the errors sought. |
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. |
void libsbmlcs.SBMLErrorLog.removeAll | ( | long | errorId | ) |
Removes all errors having errorId from the SBMLError list.
errorId | the error identifier of the error to be removed. |
|
inherited |
Set the severity override.
The severity override mechanism in XMLErrorLog is intended to help applications handle error conditions in ways that may be more convenient for those applications. It is possible to use the mechanism to override the severity code of errors logged by libSBML, and even to disable error logging completely. An override stays in effect until the override is changed again by the calling application.
severity | an override code indicating what to do. If the value is LIBSBML_OVERRIDE_DISABLED (the default setting) all errors logged will be given the severity specified in their usual definition. If the value is LIBSBML_OVERRIDE_WARNING, then all errors will be logged as warnings. If the value is LIBSBML_OVERRIDE_DONT_LOG, no error will be logged, regardless of their severity. |
|
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.
|
inherited |
Usets an existing override.
The severity override mechanism in XMLErrorLog is intended to help applications handle error conditions in ways that may be more convenient for those applications. It is possible to use the mechanism to override the severity code of errors logged by libSBML, and even to disable error logging completely. An override stays in effect until the override is changed again by the calling application.
|
protectedinherited |