ErrorUtil Namespace Reference

Classes
class	NekError

Enumerations
enum	ErrType { efatal, ewarning }

Functions
static void	SetErrorStream (std::ostream &o)
static bool	HasCustomErrorStream ()
static void	Error (ErrType type, const char *routine, int lineNumber, const char *msg, unsigned int level)
static void	Error (ErrType type, const char *routine, int lineNumber, const std::string &msg, unsigned int level)
static void	Error (ErrType type, const char *routine, int lineNumber, const char *msg)

Variables
static boost::optional < std::ostream & >	outStream

Enumeration Type Documentation

enum ErrorUtil::ErrType

Enumerator
efatal
ewarning

Definition at line 66 of file ErrorUtil.hpp.

    {
        efatal,
        ewarning
    }; 

Function Documentation

static void ErrorUtil::Error ( ErrType  type, const char *  routine, int  lineNumber, const char *  msg, unsigned int  level  )

inlinestatic

Definition at line 78 of file ErrorUtil.hpp.

References efatal, and ewarning.

Referenced by Error().

    {
        // The user of outStream is primarily for the unit tests.
        // The unit tests often generate errors on purpose to make sure
        // invalid usage is flagged appropriately.  Printing the error
        // messages to cerr made the unit test output hard to parse.

        std::string baseMsg = std::string("Level ") +
            boost::lexical_cast<std::string>(level) +
            std::string(" assertion violation\n") +
#if defined(NEKTAR_DEBUG) || defined(NEKTAR_FULLDEBUG)
            std::string("Where   : ") + boost::lexical_cast<std::string>(routine) +  std::string("[") +  boost::lexical_cast<std::string>(lineNumber) +  std::string("]\n") + std::string("Message : ") +
#endif
            msg;

        // Default rank is zero. If MPI used and initialised, populate with
        // the correct rank. Messages are only printed on rank zero.
        int rank = 0;
#if defined(NEKTAR_USE_MPI)
        int flag;
        MPI_Initialized(&flag);
        if(flag)
        {
            MPI_Comm_rank(MPI_COMM_WORLD,&rank);
        }
#endif

        std::string btMessage("");
#if defined(NEKTAR_FULLDEBUG)
#ifndef _WIN32
        void *btArray[40];
        int btSize;
        char **btStrings;

        btSize = backtrace(btArray, 40);
        btStrings = backtrace_symbols(btArray, btSize);

        for (int i = 0 ; i < btSize ; ++i)
        {
            btMessage +=  std::string(btStrings[i]) + "\n";
        }
        free(btStrings);
#endif
#endif

        switch (type)
        {
        case efatal:
            if (!rank)
            {
                if (outStream)
                {
                    (*outStream) << btMessage;
                    (*outStream) << "Fatal   : " << baseMsg << std::endl;
                }
                else
                {
                    std::cerr << btMessage;
                    std::cerr << std::endl << "Fatal   : " << baseMsg
                              << std::endl;
                }
            }
#if defined(NEKTAR_USE_MPI)
            if (flag)
            {
                MPI_Barrier(MPI_COMM_WORLD);
            }
#endif
            throw NekError(baseMsg);
            break;
        case ewarning:
            if (!rank)
            {
                if (outStream)
                {
                    (*outStream) << btMessage;
                    (*outStream) << "Warning: " << baseMsg << std::endl;
                }
                else
                {
                    std::cerr << btMessage;
                    std::cerr << "Warning: " << baseMsg << std::endl;
                }
            }
            break;
        default:
            std::cerr << "Unknown warning type: " << baseMsg << std::endl;
        }
    }

static void ErrorUtil::Error ( ErrType  type, const char *  routine, int  lineNumber, const std::string &  msg, unsigned int  level  )

inlinestatic

Definition at line 168 of file ErrorUtil.hpp.

References Error().

    {
        Error(type, routine, lineNumber, msg.c_str(), level);
    }

static void ErrorUtil::Error ( ErrType  type, const char *  routine, int  lineNumber, const char *  msg  )

inlinestatic

Definition at line 173 of file ErrorUtil.hpp.

References Error().

    {
        Error(type, routine, lineNumber, msg, 0);
    }

static bool ErrorUtil::HasCustomErrorStream ( )

inlinestatic

Definition at line 61 of file ErrorUtil.hpp.

    {
        return outStream ? true : false;
    }

static void ErrorUtil::SetErrorStream ( std::ostream &  o )

inlinestatic

Definition at line 56 of file ErrorUtil.hpp.

    {
        outStream = o;
    }

Variable Documentation

boost::optional<std::ostream&> ErrorUtil::outStream

static

Definition at line 54 of file ErrorUtil.hpp.