Proto
Static Public Member Functions | Static Protected Attributes
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 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). More...
 
static void Warning (const char *const a_msg=m_nullString)
 Print out message to cerr and continue.
 

Static Protected Attributes

static const char *const m_nullString = ""
 A null string used as a default argument by the other member functions.
 

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

◆ Abort()

template<typename T >
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.


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