Proto::MayDay< T > Class Template Reference

Error-reporting Functions. More...

#include <Proto_MayDay.H>

Static Public Member Functions
static void	Error (const char *const a_msg=m_nullString, int exit_code=CH_DEFAULT_ERROR_CODE)
	Print out message to cerr and exit with the specified exit code. More...
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). More...
static void	Warning (const char *const a_msg=m_nullString)
	Print out message to cerr and continue. More...

Static Public Attributes
static bool	s_debugSpew
static const char *const	version

Static Protected Attributes
static const char *const	m_nullString

Detailed Description

template<typename T = void>
class Proto::MayDay< T >

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

Error()

template<typename T = void>

static void Proto::MayDay< T >::Error ( const char *const  a_msg = m_nullString, int  exit_code = CH_DEFAULT_ERROR_CODE  )

inlinestatic

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

Abort()

template<typename T = void>

static void Proto::MayDay< T >::Abort ( const char *const  a_msg = m_nullString )

inlinestatic

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.

Warning()

template<typename T = void>

static void Proto::MayDay< T >::Warning ( const char *const  a_msg = m_nullString )

inlinestatic

Print out message to cerr and continue.

Member Data Documentation

s_debugSpew

template<typename T = void>

bool Proto::MayDay< T >::s_debugSpew

static

version

template<typename T = void>

const char* const Proto::MayDay< T >::version

static

m_nullString

template<typename T = void>

const char* const Proto::MayDay< T >::m_nullString

staticprotected

---

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

• Proto_MayDay.H