mspass::utility::AntelopePfError Class Reference

Error class for AntelopePf object. More...

#include <AntelopePf.h>

Inheritance diagram for mspass::utility::AntelopePfError:

Collaboration diagram for mspass::utility::AntelopePfError:

Public Member Functions
	AntelopePfError (std::string mess)
	AntelopePfError (const char *mess)
void	log_error ()
Public Member Functions inherited from mspass::utility::MsPASSError
	MsPASSError ()
	MsPASSError (const std::string mess, const char *howbad)
	Construct from a std::string with badness defined by keywords in a string.
	MsPASSError (const std::string mess, const ErrorSeverity s=ErrorSeverity::Invalid)
	MsPASSError (const char *mess, const ErrorSeverity s)
void	log_error ()
void	log_error (std::ostream &ofs)
const char *	what () const noexcept
ErrorSeverity	severity () const

Additional Inherited Members
Protected Attributes inherited from mspass::utility::MsPASSError
std::string	message
ErrorSeverity	badness

Detailed Description

Error class for AntelopePf object.

This error object is similar to that for Metadata but tags all errors cleanly as originating from this child of Metadata. Note MsPASSError is a child of std::exception, so catch that to most easily fetch messages coming from this beast.

Constructor & Destructor Documentation

AntelopePfError() [1/3]

mspass::utility::AntelopePfError::AntelopePfError ( )

inline

                    {
    message = std::string("AntelopePfError->undefined error");
  };

AntelopePfError() [2/3]

mspass::utility::AntelopePfError::AntelopePfError ( std::string  mess )

inline

Construct an AntelopePfError from an std::string message.

Parameters

mess	message to append to the AntelopePfError prefix.

                                  {
    message = "AntelopePfError object message=" + mess;
  };

References mspass::utility::MsPASSError::message.

AntelopePfError() [3/3]

mspass::utility::AntelopePfError::AntelopePfError ( const char *  mess )

inline

Construct an AntelopePfError from a C string message.

Parameters

mess	message to append to the AntelopePfError prefix.

                                    {
    message = std::string("AntelopePfError object message=") + mess;
  };

References mspass::utility::MsPASSError::message.

Member Function Documentation

log_error()

void mspass::utility::AntelopePfError::log_error ( )

inline

Write the stored error message to std::cerr.

{ std::cerr << message << std::endl; };

References mspass::utility::MsPASSError::message.

---

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

• /home/runner/work/mspass/mspass/cxx/include/mspass/utility/AntelopePf.h