MsPASSError.h

#ifndef _MSPASS_ERROR_H_
#define _MSPASS_ERROR_H_
#include <iostream>
#include <exception>
namespace mspass {
namespace utility{
 
enum class ErrorSeverity
{
    Fatal,
    Invalid,
    Suspect,
    Complaint,
    Debug,
    Informational
};
 
 
mspass::utility::ErrorSeverity string2severity(const std::string howbad);
std::string severity2string(const mspass::utility::ErrorSeverity es);
 
class MsPASSError : public std::exception
{
public:
 
    MsPASSError(){
        message="MsPASS library error\n";
        badness=ErrorSeverity::Fatal;
    };
    MsPASSError(const std::string mess,const char *howbad){
        message=mess;
        std::string s(howbad);
        /* this small helper function parses s to conver to the
        enum class of badness*/
        badness=string2severity(s);
    };
    MsPASSError(const std::string mess,const ErrorSeverity s=ErrorSeverity::Invalid)
        {
            message=mess;
            badness=s;
        };
    MsPASSError(const char *mess,const ErrorSeverity s){
        message=std::string(mess);
        badness=s;
    };
void log_error(){
  std::cerr << message << std::endl;
};
void log_error(std::ostream& ofs)
{
    ofs << message <<std::endl;
}
  const char * what() const noexcept{return message.c_str();};
    ErrorSeverity severity() const {return badness;};
protected:
        std::string message;
        ErrorSeverity badness;
};
/* Helper function prototypes.  The following set of functions proved necessary
because of a limitation in pybind11.  It appears there is no easy way to bind
a full interface to MsPASSError when it is handled as an exception.   As a result
neither the badness attribute (if made public) nor the severity method are
visible when treated as an exception in python.   To circumvent this the what
method writes a string representation of badness to the message.   Bound versions
of the functions below can be used in python programs to test severity of
a thrown MsPASSError.
*/
bool error_says_data_bad(const mspass::utility::MsPASSError& err);
 
std::string parse_message_error_severity(const mspass::utility::MsPASSError& err);
mspass::utility::ErrorSeverity message_error_severity(const mspass::utility::MsPASSError& err);
} // end utility namespace
}  // End mspass namespace declaration
#endif