libSBML C++ API  5.18.0
XMLErrorLog Class Reference
Inheritance diagram for XMLErrorLog:
[legend]

Detailed Description

Log of diagnostics reported during XML 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. 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(unsigned int 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

void changeErrorSeverity (XMLErrorSeverity_t originalSeverity, XMLErrorSeverity_t targetSeverity, std::string package="all")
 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 (const unsigned int errorId) const
 Returns true if XMLErrorLog contains an errorId. More...
 
const XMLErrorgetError (unsigned int n) const
 Returns the nth XMLError object in this log. More...
 
unsigned int getNumErrors () const
 Returns the number of errors that have been logged. More...
 
XMLErrorSeverityOverride_t getSeverityOverride () const
 Returns the current override. More...
 
bool isSeverityOverridden () const
 Returns a boolean indicating whether or not the severity has been overridden. More...
 
void printErrors (std::ostream &stream=std::cerr) const
 Prints all the errors or warnings stored in this error log. More...
 
void printErrors (std::ostream &stream, unsigned int severity) const
 Prints the errors or warnings with given severity stored in this error log. More...
 
void setSeverityOverride (XMLErrorSeverityOverride_t severity)
 Set the severity override. More...
 
std::string toString () const
 Writes all errors contained in this log to a string and returns it. More...
 
void unsetSeverityOverride ()
 Usets an existing override. More...
 

Member Function Documentation

void XMLErrorLog::changeErrorSeverity ( XMLErrorSeverity_t  originalSeverity,
XMLErrorSeverity_t  targetSeverity,
std::string  package = "all" 
)

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.
Parameters
originalSeveritythe severity code to match.
targetSeveritythe severity code to use as the new severity.
packagea 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.
See also
isSeverityOverridden()
getSeverityOverride()
setSeverityOverride()
unsetSeverityOverride()
void XMLErrorLog::clearLog ( )

Deletes all errors from this log.

bool XMLErrorLog::contains ( const unsigned int  errorId) const

Returns true if XMLErrorLog contains an errorId.

Parameters
errorIdthe error identifier of the error to be found.
const XMLError * XMLErrorLog::getError ( unsigned int  n) const

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 NULL 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 NULL if n is greater than or equal to getNumErrors().
See also
getNumErrors()
unsigned int XMLErrorLog::getNumErrors ( ) const

Returns the number of errors that have been logged.

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

Returns
the number of errors that have been logged.
XMLErrorSeverityOverride_t XMLErrorLog::getSeverityOverride ( ) const

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.
Returns
a severity override code. The possible values are drawn from the enumeration XMLErrorSeverityOverride_t:
See also
isSeverityOverridden()
setSeverityOverride()
unsetSeverityOverride()
changeErrorSeverity()
bool XMLErrorLog::isSeverityOverridden ( ) const

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.
Returns
true if an error severity override has been set, false otherwise.
See also
getSeverityOverride()
setSeverityOverride()
unsetSeverityOverride()
changeErrorSeverity()
void XMLErrorLog::printErrors ( std::ostream &  stream = std::cerr) const

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.

Parameters
streamthe ostream or ostringstream object indicating where the output should be printed.
void XMLErrorLog::printErrors ( std::ostream &  stream,
unsigned int  severity 
) const

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.

Parameters
streamthe ostream or ostringstream object indicating where the output should be printed.
severitythe severity of the errors sought.
void XMLErrorLog::setSeverityOverride ( XMLErrorSeverityOverride_t  severity)

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.
Parameters
severityan 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.
See also
isSeverityOverridden()
getSeverityOverride()
unsetSeverityOverride()
changeErrorSeverity()
string XMLErrorLog::toString ( ) const

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()
void XMLErrorLog::unsetSeverityOverride ( )

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.
See also
getSeverityOverride()
setSeverityOverride()
isSeverityOverridden()
changeErrorSeverity()