OpenBabel::OBError

OBError Class Reference

Customizable error handling and logging -- store a message, including the method yielding the error, causes, etc. More...

#include <openbabel/oberror.h>

List of all members.

Public Member Functions

 OBError (const std::string &method="", const std::string &errorMsg="", const std::string &explanation="", const std::string &possibleCause="", const std::string &suggestedRemedy="", const obMessageLevel=obDebug)
std::string message (void) const
std::string GetMethod ()
std::string GetError ()
std::string GetExplanation ()
std::string GetPossibleCause ()
std::string GetSuggestedRemedy ()
obMessageLevel GetLevel ()

Protected Attributes

std::string _method
std::string _errorMsg
std::string _explanation
std::string _possibleCause
std::string _suggestedRemedy
obMessageLevel _level

Friends

std::ostream & operator<< (std::ostream &os, const OBError &er)

Detailed Description

Customizable error handling and logging -- store a message, including the method yielding the error, causes, etc.

Constructor & Destructor Documentation

OBError ( const std::string &  method = "",
const std::string &  errorMsg = "",
const std::string &  explanation = "",
const std::string &  possibleCause = "",
const std::string &  suggestedRemedy = "",
const   obMessageLevel = obDebug 
)

Constructor for an error message e.g. OBError(__FUNCTION__, " message ").

Member Function Documentation

string message ( void   )  const

Returns:
A formatted message string, including optional explanations, etc.

std::string GetMethod (  )  [inline]

Returns:
The method which caused this error (typically supplied via the __FUNCTION__ compiler macro

std::string GetError (  )  [inline]

Returns:
The main error message

std::string GetExplanation (  )  [inline]

Returns:
A more detailed explanation of the error (optional)

std::string GetPossibleCause (  )  [inline]

Returns:
A possible cause for the error (optional)

std::string GetSuggestedRemedy (  )  [inline]

Returns:
The suggested workaround or remedy for the error (optional)

obMessageLevel GetLevel (  )  [inline]

Returns:
The severity level of this error

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const OBError &  er 
) [friend]

Output a formatted message string.

Member Data Documentation

std::string _method [protected]

The method causing the error (typically from the compiler macro __FUNCTION__).

std::string _errorMsg [protected]

The actual error message.

std::string _explanation [protected]

Optional explanation message: more detailed than the brief error.

std::string _possibleCause [protected]

Optional cause message.

std::string _suggestedRemedy [protected]

Optional workaround or remedy.

obMessageLevel _level [protected]

The severity level: used for filtering via OBMessageHandler.

The documentation for this class was generated from the following files: