MayDay Class Reference

Error-reporting Functions. More...

#include <MayDay.H>

List of all members.

Static Public Member Functions
static void	Error (const char *const a_msg=m_nullString, int m_exitCode=CH_DEFAULT_ERROR_CODE)
	Print out message to cerr and exit with the specified exit code.
static void	Abort (const char *const a_msg=m_nullString)
	Print out message to cerr and exit via abort() (if serial) or MPI_Abort() (if parallel).
static void	Warning (const char *const a_msg=m_nullString)
	Print out message to cerr and continue.
Static Public Attributes
static const char *const	version
Static Protected Attributes
static const char *const	m_nullString
	A null string used as a default argument by the other member functions.

---

Detailed Description

Error-reporting Functions.

This class consists entirely of static error-reporting functions that are used throughout the MayDay implementation together with a version string. In the best of all possible worlds we'd use a namespace, but we aren't there, yet :-) Note that all the output functions add a terminating exclamation mark, so there is no need to add any punction to sentences that get output explicitly.

---

Member Function Documentation

static void MayDay::Abort (  const char *const   a_msg = m_nullString  )  [static]

Print out message to cerr and exit via abort() (if serial) or MPI_Abort() (if parallel). The exit code depends on the compiler and MPI implementation.

static void MayDay::Error (  const char *const   a_msg = m_nullString, int  m_exitCode = CH_DEFAULT_ERROR_CODE )  [static]

Print out message to cerr and exit with the specified exit code.

static void MayDay::Warning (  const char *const   a_msg = m_nullString  )  [static]

Print out message to cerr and continue.

---

Member Data Documentation

const char* const MayDay::m_nullString [static, protected]

A null string used as a default argument by the other member functions.

const char* const MayDay::version [static]

---

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

• MayDay.H

---