mspass::utility::MetadataGetError Class Reference

Error thrown when get operators fail. More...

#include <Metadata.h>

Inheritance diagram for mspass::utility::MetadataGetError:

Collaboration diagram for mspass::utility::MetadataGetError:

Public Member Functions
	MetadataGetError ()
	MetadataGetError (const std::string key, const char *Texpected)
	MetadataGetError (const char *boostmessage, const std::string key, const char *Texpected, const char *Tactual)
	Constructor called when type requested does not match contents.
	MetadataGetError (const std::string key, const char *Texpected, const char *Tactual, const std::string detail)
	Constructor called when compatible scalar conversion fails.
	MetadataGetError (const MetadataGetError &parent)
MetadataGetError	operator= (const MetadataGetError &parent)
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

Public Attributes
std::stringstream	ss

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

Detailed Description

Error thrown when get operators fail.

This is a convenience class used to construct a more informative set of errors when get operations fail.

Constructor & Destructor Documentation

MetadataGetError() [1/5]

mspass::utility::MetadataGetError::MetadataGetError ( )

inline

Default constructor used by containers and exception mechanics.

      : MsPASSError() {}; // seems necessary to not default this with gcc

MetadataGetError() [2/5]

mspass::utility::MetadataGetError::MetadataGetError ( const std::string  key, const char *  Texpected  )

inline

Constructor called when a key is not found in the Metadata.

Parameters

key	is the Metadata key that could not be found.
Texpected	is the type name (return of typeid name method) trying to extract.

                                                               {
 
    std::string pretty_name(boost::core::demangle(Texpected));
    ss << "Error trying to extract Metadata with key=" << key << std::endl
       << "No value associated with this key is set in Metadata object"
       << std::endl
       << "Expected an entry of type=" << pretty_name << std::endl;
    message = ss.str();
    badness = ErrorSeverity::Suspect;
  };

References mspass::utility::MsPASSError::badness, mspass::utility::MsPASSError::message, and ss.

MetadataGetError() [3/5]

mspass::utility::MetadataGetError::MetadataGetError ( const char *  boostmessage, const std::string  key, const char *  Texpected, const char *  Tactual  )

inline

Constructor called when type requested does not match contents.

This implementation uses a pickle style map container where the contents of the map can by any type. We use boost::any to provide sanity checks on types. This is creates the error message thrown when the type of the return does not match the type requested.

                                                               {
    ss << "Error in Metadata get method.   Type mismatch in attempt to get "
       << "data with key=" << key << std::endl
       << "boost::any bad_any_cast wrote this message:  " << std::endl
       << boostmessage << std::endl;
    std::string name_e(boost::core::demangle(Texpected));
    ss << "Trying to convert to data of type=" << name_e << std::endl;
    std::string name_a(boost::core::demangle(Tactual));
    ss << "Actual entry has type=" << name_a << std::endl;
    message = ss.str();
    badness = ErrorSeverity::Suspect;
  };

References mspass::utility::MsPASSError::badness, mspass::utility::MsPASSError::message, and ss.

MetadataGetError() [4/5]

mspass::utility::MetadataGetError::MetadataGetError ( const std::string  key, const char *  Texpected, const char *  Tactual, const std::string  detail  )

inline

Constructor called when compatible scalar conversion fails.

This form is used by typed getter wrappers that accept compatible scalar types (for example, integer metadata for a double request), but still need to reject semantic mismatches such as a fractional value for an integer request.

                                                                {
    ss << "Error in Metadata get method. Type mismatch in attempt to get "
       << "data with key=" << key << std::endl;
    std::string name_e(boost::core::demangle(Texpected));
    ss << "Trying to convert to data of type=" << name_e << std::endl;
    std::string name_a(boost::core::demangle(Tactual));
    ss << "Actual entry has type=" << name_a << std::endl;
    ss << detail << std::endl;
    message = ss.str();
    badness = ErrorSeverity::Suspect;
  };

References mspass::utility::MsPASSError::badness, mspass::utility::MsPASSError::message, and ss.

MetadataGetError() [5/5]

mspass::utility::MetadataGetError::MetadataGetError ( const MetadataGetError &  parent )

inline

Copy constructor preserving the message and severity.

                                                   {
    message = parent.message;
    badness = parent.badness;
  };

References mspass::utility::MsPASSError::badness, and mspass::utility::MsPASSError::message.

Member Function Documentation

operator=()

MetadataGetError mspass::utility::MetadataGetError::operator= ( const MetadataGetError &  parent )

inline

Assignment operator preserving the message and severity.

                                                             {
    if (this != &parent) {
      message = parent.message;
      badness = parent.badness;
    }
    return *this;
  };

References mspass::utility::MsPASSError::badness, and mspass::utility::MsPASSError::message.

Member Data Documentation

ss

std::stringstream mspass::utility::MetadataGetError::ss

Stream used internally to assemble the final error message.

---

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

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