#include <openbabel/oberror.h>
Public Member Functions | |
| OBMessageHandler () | |
| ~OBMessageHandler () | |
| void | ThrowError (OBError err) |
| void | ThrowError (const std::string &method, const std::string &errorMsg, obMessageLevel level=obDebug) |
| std::vector< std::string > | GetMessagesOfLevel (const obMessageLevel) |
| void | StartLogging () |
| void | StopLogging () |
| void | SetMaxLogEntries (unsigned int max) |
| unsigned int | GetMaxLogEntries () |
| void | ClearLog () |
| void | SetOutputLevel (const obMessageLevel level) |
| obMessageLevel | GetOutputLevel () |
| void | SetOutputStream (std::ostream *os) |
| std::ostream * | GetOutputStream () |
| bool | StartErrorWrap () |
| bool | StopErrorWrap () |
| unsigned int | GetErrorMessageCount () |
| unsigned int | GetWarningMessageCount () |
| unsigned int | GetInfoMessageCount () |
| unsigned int | GetAuditMessageCount () |
| unsigned int | GetDebugMessageCount () |
| std::string | GetMessageSummary () |
Protected Attributes | |
| unsigned int | _messageCount [5] |
| std::deque< OBError > | _messageList |
| obMessageLevel | _outputLevel |
| std::ostream * | _outputStream |
| bool | _logging |
| unsigned int | _maxEntries |
| std::streambuf * | _inWrapStreamBuf |
| std::streambuf * | _filterStreamBuf |
OBMessageHandler represents a configurable error system for Open Babel.
A global error log is defined by the Open Babel library for use of internal code as well as code built on top of Open Babel. This class allows flexible filtering based on urgency (defined by the obMessageLevel type), an "audit log" of molecular changes, including recall using the GetMessagesOfLevel method, etc.
The default is to only log and output errors of priority obMessageLevel::obError or obMessageLevel::obWarning.
Long-running code may wish to set the size of the in-memory error log using the StartLogging / StopLogging methods and SetMaxLogEntries. Otherwise, the error log may easily fill up, requiring large amounts of memory.
If you wish to divert error output to a different std::ostream (i.e., for graphical display, or a file log), use the SetOutputStream method -- the default goes to the std::clog stream. Furthermore, some older code uses std::cerr for direct error output, rather than the ThrowError() methods in this class. To prevent this, you can turn on "error wrapping" using the StartErrorWrap method -- this behavior is turned off by default.
To make it easy to use the OBMessageHandler class and error logging facilities, a global log is defined:
OBERROR extern OBMessageHandler obErrorLog;
Therefore, it is very easy to log errors:
if (atomIndex < 1 || atomIndex > mol.NumAtoms() ) obErrorLog.ThrowError(__FUNCTION__, "Requested Atom Out of Range", obDebug);
or
stringstream errorMsg; errorMsg << " Could not parse line in type translation table types.txt -- incorect number of columns"; errorMsg << " found " << vc.size() << " expected " << _ncols << "."; obErrorLog.ThrowError(__FUNCTION__, errorMsg.str(), obInfo);
The __FUNCTION__ builtin is defined by many compilers (e.g., GCC) but can be defined to an empty string on some platforms without this compiler extension.
Output from the error log typically looks like:
============================== Open Babel Audit Log in ReadChemObject OpenBabel::Read molecule Protein Data Bank format ============================== Open Babel Information in ParseConectRecord WARNING: Problems reading a PDB file Problems reading a CONECT record. According to the PDB specification, the record should have 70 columns, but OpenBabel found 61 columns.
| OBMessageHandler | ( | ) |
| ~OBMessageHandler | ( | ) |
| void ThrowError | ( | const std::string & | method, | |
| const std::string & | errorMsg, | |||
| obMessageLevel | level = obDebug | |||
| ) |
Throw an error in the specified method with an appropriate level.
| std::vector< std::string > GetMessagesOfLevel | ( | const | obMessageLevel | ) |
| void StartLogging | ( | ) | [inline] |
Start logging messages (default).
| void StopLogging | ( | ) | [inline] |
Stop logging messages completely.
| void SetMaxLogEntries | ( | unsigned int | max | ) | [inline] |
Set the maximum number of entries (or 0 for no limit).
| unsigned int GetMaxLogEntries | ( | ) | [inline] |
| void ClearLog | ( | ) | [inline] |
Clear the current message log entirely.
| void SetOutputLevel | ( | const obMessageLevel | level | ) | [inline] |
Set the level of messages to output (i.e., messages with at least this priority will be output).
| obMessageLevel GetOutputLevel | ( | ) | [inline] |
| void SetOutputStream | ( | std::ostream * | os | ) | [inline] |
| std::ostream* GetOutputStream | ( | ) | [inline] |
| bool StartErrorWrap | ( | ) |
Start "wrapping" messages to cerr into ThrowError calls.
| bool StopErrorWrap | ( | ) |
Turn off "wrapping" messages, restoring normal cerr use (default).
| unsigned int GetErrorMessageCount | ( | ) | [inline] |
| unsigned int GetWarningMessageCount | ( | ) | [inline] |
| unsigned int GetInfoMessageCount | ( | ) | [inline] |
| unsigned int GetAuditMessageCount | ( | ) | [inline] |
| unsigned int GetDebugMessageCount | ( | ) | [inline] |
| string GetMessageSummary | ( | ) |
unsigned int _messageCount[5] [protected] |
Count of messages at each message level.
std::deque<OBError> _messageList [protected] |
Log of messages for later retrieval via GetMessagesOfLevel().
obMessageLevel _outputLevel [protected] |
Filtering level for messages and logging (messages of lower priority will be ignored.
std::ostream* _outputStream [protected] |
bool _logging [protected] |
Whether messages will be logged into _messageList.
unsigned int _maxEntries [protected] |
The maximum size of _messageList log.
std::streambuf* _inWrapStreamBuf [protected] |
The default stream buffer for the output stream (saved if wrapping is ued).
std::streambuf* _filterStreamBuf [protected] |
The filtered obLogBuf stream buffer to wrap error messages.
This file is part of the documentation for Open Babel, version 2.1.0.
1.5.2.