Errors reported by MoorDyn

Collaboration diagram for Errors reported by MoorDyn:

Modules
	The list of error codes returned by the C API

Macros
#define	MAKE_EXCEPTION(name)
	Simple macro to define custom exceptions. More...
#define	MOORDYN_THROW(err, msg)
	Exception thrown for invalid input files. More...
#define	MOORDYN_CATCHER(err, msg)

Typedefs
typedef int	moordyn::error_id
	Error identifier.

Detailed Description

Macro Definition Documentation

MAKE_EXCEPTION

#define MAKE_EXCEPTION

(

name

)

Value:

    class name : public std::runtime_error                                     \
    {                                                                          \
      public:                                                                  \
        name(const char* msg)                                                  \
          : std::runtime_error(msg)                                            \
        {                                                                      \
        }                                                                      \
    };

Simple macro to define custom exceptions.

MOORDYN_CATCHER

#define MOORDYN_CATCHER	(		err,
			msg
	)

Catch thrown exceptions and convert them in an error_id. It also gives the message on the Exception. This macro will only handle known exceptions, i.e. the ones declared in moordyn_errors. You can add more catch() instances afterwards

MOORDYN_THROW

#define MOORDYN_THROW	(		err,
			msg
	)

Value:

    switch (err) {                                                             \
        case MOORDYN_SUCCESS:                                                  \
            break;                                                             \
        case MOORDYN_INVALID_INPUT_FILE:                                       \
            throw moordyn::input_file_error(msg);                              \
            break;                                                             \
        case MOORDYN_INVALID_OUTPUT_FILE:                                      \
            throw moordyn::output_file_error(msg);                             \
            break;                                                             \
        case MOORDYN_INVALID_INPUT:                                            \
            throw moordyn::input_error(msg);                                   \
            break;                                                             \
        case MOORDYN_NAN_ERROR:                                                \
            throw moordyn::nan_error(msg);                                     \
            break;                                                             \
        case MOORDYN_MEM_ERROR:                                                \
            throw moordyn::mem_error(msg);                                     \
            break;                                                             \
        case MOORDYN_INVALID_VALUE:                                            \
            throw moordyn::invalid_value_error(msg);                           \
            break;                                                             \
        case MOORDYN_NON_IMPLEMENTED:                                          \
            throw moordyn::non_implemented_error(msg);                         \
            break;                                                             \
        default:                                                               \
            throw moordyn::unhandled_error(msg);                               \
            break;                                                             \
    }

Exception thrown for invalid input files.

Exception thrown for invalid output files Exception thrown for invalid input values Exception thrown when NaN values are encountered Exception thrown when memory errors are triggered Exception thrown when invalid values are found Exception thrown when something is not implemented yet Exception thrown when an invalid type is asked Exception thrown for other uhandled errors Throw the exception associated with the provided error. Do nothing if MOORDYN_SUCCESS is passed