ioda::Exception Class Reference

The ioda exception class. More...

#include <Exception.h>

Inheritance diagram for ioda::Exception:

Collaboration diagram for ioda::Exception:

Public Member Functions
	Exception (const ::ioda::source_location &loc=source_location::current(), const Options &opts=Options{})
	Exception (const char *msg, const ::ioda::source_location &loc=source_location::current(), const Options &opts=Options{})
virtual	~Exception () noexcept
virtual const char *	what () const noexcept
	Print the error message. More...
template<class T >
Exception &	add (const std::string &key, const T value)
	Add a key-value pair to the error message. More...

Private Member Functions
void	invalidate ()
void	add_source_location (const ::ioda::source_location &loc)

Private Attributes
Options	opts_
std::string	emessage_

Detailed Description

The ioda exception class.

IODA is used to ingest data from external sources (ioda-converters), provides the runtime interface for JEDI's data access, and is used to analyze files for offline diagnostics. As a result, ioda is perhaps the one jedi component that must build everywhere with minimal dependencies. We do not want to deploy the full stack in all situations, particularly in difficult-to-configure Python environments (Anaconda), so we do not want to use eckit exceptions in the core ioda-engines code.

This class is the default exception class for ioda. All ioda errors should use this class.

USAGE EXAMPLES:

1. To throw a regular error:

   throw ioda::Exception();

2. To throw a basic error with a single-line message:

   throw ioda::Exception("This is an error");

3. To throw an error with some data:

   throw ioda::Exception().add<std::string>("Reason", "Some descriptive error goes here.")
                          .add<int>("status-code", 42);

Definition at line 54 of file Exception.h.

Constructor & Destructor Documentation

Exception() [1/2]

Exception::Exception	(	const ::ioda::source_location &	loc = source_location::current(),
		const Options &	opts = Options{}
	)

Definition at line 14 of file Exception.cpp.

Here is the call graph for this function:

Exception() [2/2]

Exception::Exception ( const char *  msg, const ::ioda::source_location &  loc = source_location::current(), const Options &  opts = Options{}  )

explicit

Definition at line 18 of file Exception.cpp.

Here is the call graph for this function:

~Exception()

Exception::~Exception ( )

virtualdefaultnoexcept

Member Function Documentation

add()

template<class T >

Exception& ioda::Exception::add ( const std::string &  key, const T  value  )

inline

Add a key-value pair to the error message.

Definition at line 75 of file Exception.h.

Here is the call graph for this function:

Here is the caller graph for this function:

add_source_location()

void Exception::add_source_location ( const ::ioda::source_location &  loc )

private

Definition at line 28 of file Exception.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

invalidate()

void Exception::invalidate ( )

private

Definition at line 26 of file Exception.cpp.

what()

const char * Exception::what ( ) const

virtualnoexcept

Print the error message.

Todo:

Make this truly noexcept. Should never throw unless a memory corruption error has occurred, in which case the program will terminate anyways.

Definition at line 35 of file Exception.cpp.

Here is the call graph for this function:

Member Data Documentation

emessage_

std::string ioda::Exception::emessage_

mutableprivate

Definition at line 56 of file Exception.h.

opts_

Options ioda::Exception::opts_

private

Definition at line 55 of file Exception.h.

---

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

• Exception.h
• Exception.cpp