Utopia::KeyError Class Reference

For access to a dict-like structure with a bad key. More...

#include <exceptions.hh>

Inheritance diagram for Utopia::KeyError:

Collaboration diagram for Utopia::KeyError:

Public Member Functions
	KeyError (const std::string &key, const DataIO::Config &node, const std::string &prefix="")
	Construct a KeyError exception, which has a standardized what message.
Public Member Functions inherited from Utopia::Exception
	Exception (const std::string &what_arg, const int exit_code_arg=1)
	Construct an Utopia-specific exception.
	Exception (const char *what_arg, const int exit_code_arg=1)
	Construct an Utopia-specific exception.

Private Member Functions
std::string	generate_what_arg (std::string key, DataIO::Config node, std::string prefix)
	Generates the what argument for the key error.

Additional Inherited Members
Public Attributes inherited from Utopia::Exception
const int	exit_code
	The exit code to use when exiting due to this exception.

Detailed Description

For access to a dict-like structure with a bad key.

Constructor & Destructor Documentation

KeyError()

Utopia::KeyError::KeyError ( const std::string &  key, const DataIO::Config &  node, const std::string &  prefix = ""  )

inline

Construct a KeyError exception, which has a standardized what message.

    :
        Exception(generate_what_arg(key, node, prefix))
    {}

Member Function Documentation

generate_what_arg()

std::string Utopia::KeyError::generate_what_arg ( std::string  key, DataIO::Config  node, std::string  prefix  )

inlineprivate

Generates the what argument for the key error.

    {
        std::stringstream msg;
 
        if (prefix.length()) {
            msg << prefix << std::endl;
        }
 
        msg << "KeyError: " << key << std::endl;
 
        if (not node) {
            msg << "The given node is a Zombie! Make sure the node you are "
                << "trying to read from is valid." << std::endl;
        }
        else if (node.size() == 0) {
            msg << "The given node contains no entries! Make sure the desired "
                << "key is available."
                << std::endl;
        }
        else {
            // Emit the node to give more clues at what might have gone wrong
            msg << "Make sure the desired key is available. The content of "
                << "the given node is as follows:" << std::endl
                << YAML::Dump(node) << std::endl;
        }
 
        return msg.str();
    }

---

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

• include/utopia/core/exceptions.hh