mspass::utility::MetadataGetError Class Reference

Error thrown when get operators fail. More...

#include <Metadata.h>

Inheritance diagram for mspass::utility::MetadataGetError:

Public Member Functions
	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 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/4]

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

inline

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

MetadataGetError() [2/4]

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

inline

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

Parameters

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, and mspass::utility::MsPASSError::message.

MetadataGetError() [3/4]

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 attem 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, and mspass::utility::MsPASSError::message.

MetadataGetError() [4/4]

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

inline

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

Member Function Documentation

operator=()

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

inline

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

---

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

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