MeVisLab Toolbox Reference
|
#include <utility>
#include <type_traits>
#include "mlConfig.h"
#include "mlMacros.h"
#include "mlLogging.h"
Go to the source code of this file.
Private additional macro which is compiled in ML_PRINT_ERROR output macros.
It can be used to add additional error log code to the default error output macros. In the standard MeVis case we compile it empty. NOT TO BE USED DIRECTLY BY APPLICATION/USER CODE!
Definition at line 132 of file mlErrorMacros.h.
Private additional macro which is used to print assert boxes on e.g., (fatal) errors.
It is added to the end of ML_PRINT_ERROR and ML_PRINT_FATAL_ERROR macros. In the standard MeVis case we compile it empty, some other error handling contexts may compile pop up windows etc. into it to terminate on (fatal) errors. NOT TO BE USED DIRECTLY BY APPLICATION/USER CODE!
Definition at line 145 of file mlErrorMacros.h.
Private additional macro which is compiled in ML_PRINT_FATAL_ERROR output macros.
It can be used to add additional error log code to the default fatal error output macros. In the standard MeVis case we compile it empty. NOT TO BE USED DIRECTLY BY APPLICATION/USER CODE!
Definition at line 138 of file mlErrorMacros.h.
Private additional macro which is compiled in ML_PRINT_INFORMATION macros.
It can be used to add additional information log code to the default information output macros. In the standard MeVis case we compile it empty. NOT TO BE USED DIRECTLY BY APPLICATION/USER CODE!
Definition at line 120 of file mlErrorMacros.h.
Macro to send an error message to the error output system of the ML.
Should be used whenever a error is detected which can be handled to notify the ML and appended error handlers. This macro is intended for ML internal use. Please use ML_PRINT_ERROR normally.
FUNC_NAME | is a string describing the error position, typically ClassName::MethodName. |
REASON | should be an MLErrorCode describing the error type. |
HANDLING | is a string describing what the program does to handle the error, e.g., returning from the method or switching to another mode. |
RT_OBJ | is a pointer to a runtime typed object causing this error. If a dump function is registered in the ML C-API it will be dumped. If NULL it will be ignored. |
RTYPE | is the runtime type of RTYPE or NULL. If NULL it will be ignored. |
Definition at line 199 of file mlErrorMacros.h.
Macro to send a fatal error message to the error output system of the ML.
Should be used whenever a fatal error is detected to notify the ML and appended error handlers. This macro is intended for ML internal use. Please use ML_PRINT_FATAL_ERROR normally.
FUNC_NAME | is a string describing the error position, typically ClassName::MethodName. |
REASON | should be an MLErrorCode describing the error type. |
HANDLING | is a string describing what the program does to handle the error (if possible), e.g., returning from the method. |
RT_OBJ | is a pointer to a runtime typed object causing this error. If a dump function is registered in the ML C-API it will be dumped. If NULL it will be ignored. |
RTYPE | is the runtime type of RTYPE or NULL. If NULL it will be ignored. |
Definition at line 173 of file mlErrorMacros.h.
Macro to send an information message to the error output system of the ML.
Should be used whenever a basic system information must be sent to the application log or error management system. It is not intended as a debugging output; use mlDebug macros for that. This macro is intended for ML internal use. Please use ML_PRINT_INFORMATION normally.
FUNC_NAME | is a string describing the code position, typically ClassName::MethodName. |
REASON | should be an MLErrorCode describing the information or error type. |
HANDLING | is a string describing what the program does to handle the message, e.g., returning from the method or switching to another mode. |
RT_OBJ | is a pointer to a runtime typed object causing this information. If a dump function is registered in the ML C-API it will be dumped. If nullptr it will be ignored. |
RTYPE | is the runtime type of RTYPE or nullptr. If nullptr it will be ignored. |
Definition at line 253 of file mlErrorMacros.h.
Macro to send a warning message to the error output system of the ML.
Should be used whenever an inadequate situation is detected which is not really problematic but which should be notified or handled. So the ML and appended error handlers are notified correctly. This macro is intended for ML internal use. Please use ML_PRINT_WARNING normally.
FUNC_NAME | is a string describing the error position, typically ClassName::MethodName. |
REASON | should be an MLErrorCode describing the warning/error type. |
HANDLING | is a string describing what the program does to handle the reason of the warning, e.g., returning from the method or switching to another mode. |
RT_OBJ | is a pointer to a runtime typed object causing this warning. If a dump function is registered in the ML C-API it will be dumped. If nullptr it will be ignored. |
RTYPE | is the runtime type of RTYPE or nullptr. If nullptr it will be ignored. |
Definition at line 226 of file mlErrorMacros.h.
Private additional macro which is compiled in ML_PRINT_WARNING macros.
It can be used to add additional warning log code to the default warn output macros. In the standard MeVis case we compile it empty. NOT TO BE USED DIRECTLY BY APPLICATION/USER CODE!
Definition at line 126 of file mlErrorMacros.h.
#define ML_CATCH catch(...){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_UNKNOWN_EXCEPTION); } |
Definition at line 65 of file mlErrorMacros.h.
#define ML_CATCH_BLOCK | ( | __paramType | ) | catch(__paramType) |
Definition at line 70 of file mlErrorMacros.h.
#define ML_CATCH_RETHROW catch(...){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_UNKNOWN_EXCEPTION); throw; } |
Definition at line 69 of file mlErrorMacros.h.
#define ML_CATCH_RETURN catch(...){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_UNKNOWN_EXCEPTION); return; } |
Definition at line 66 of file mlErrorMacros.h.
#define ML_CATCH_RETURN_FALSE catch(...){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_UNKNOWN_EXCEPTION); return false; } |
Definition at line 67 of file mlErrorMacros.h.
#define ML_CATCH_RETURN_NULL catch(...){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_UNKNOWN_EXCEPTION); return 0; } |
Definition at line 68 of file mlErrorMacros.h.
#define ML_CHECK | ( | x | ) | if (!(x)){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_BAD_POINTER_OR_0); } |
Definition at line 80 of file mlErrorMacros.h.
#define ML_CHECK_FLOAT | ( | x | ) | if (MLValueIs0WOM(x)){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_BAD_POINTER_OR_0); } |
Definition at line 102 of file mlErrorMacros.h.
Referenced by ml::TQuaternion< DT >::compDiv(), ml::Tvec3< DT >::divideByLastComp(), ml::TQuaternion< DT >::operator/(), ml::TQuaternion< DT >::operator/=(), and ml::TQuaternion< DT >::sgn().
#define ML_CHECK_FLOAT_RETURN | ( | x | ) | if (MLValueIs0WOM(x)){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_BAD_POINTER_OR_0); return; } |
Definition at line 103 of file mlErrorMacros.h.
#define ML_CHECK_FLOAT_RETURN_FALSE | ( | x | ) | if (MLValueIs0WOM(x)){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_BAD_POINTER_OR_0); return false; } |
Definition at line 104 of file mlErrorMacros.h.
#define ML_CHECK_FLOAT_RETURN_NULL | ( | x | ) | if (MLValueIs0WOM(x)){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_BAD_POINTER_OR_0); return 0; } |
Definition at line 105 of file mlErrorMacros.h.
#define ML_CHECK_FLOAT_RUNTIME_TYPE | ( | x | ) | if (MLValueIs0WOM(x)){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_TYPE_NOT_REGISTERED); throw ML_TYPE_NOT_REGISTERED; } |
Definition at line 107 of file mlErrorMacros.h.
#define ML_CHECK_FLOAT_THROW | ( | x | ) | if (MLValueIs0WOM(x)){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_BAD_POINTER_OR_0); throw ML_BAD_POINTER_OR_0; } |
Definition at line 106 of file mlErrorMacros.h.
Referenced by ml::Tvec4< DT >::divideByLastComp(), ml::operator/(), ml::operator/(), ml::Tmat5< DT >::operator/=(), ml::perspective3D(), and ml::Tvec2< DT >::Tvec2().
Definition at line 84 of file mlErrorMacros.h.
#define ML_CHECK_RETURN | ( | x | ) | if (!(x)){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_BAD_POINTER_OR_0); return; } |
Definition at line 86 of file mlErrorMacros.h.
#define ML_CHECK_RETURN_FALSE | ( | x | ) | if (!(x)){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_BAD_POINTER_OR_0); return false; } |
Definition at line 87 of file mlErrorMacros.h.
#define ML_CHECK_RETURN_NULL | ( | x | ) | if (!(x)){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_BAD_POINTER_OR_0); return 0; } |
Definition at line 88 of file mlErrorMacros.h.
#define ML_CHECK_RUNTIME_TYPE | ( | x | ) | if (!(x)){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_TYPE_NOT_REGISTERED); throw ML_TYPE_NOT_REGISTERED; } |
Definition at line 90 of file mlErrorMacros.h.
Referenced by ml::ListContainerTemplate< T >::ListContainerTemplate().
#define ML_CHECK_THROW | ( | x | ) | if (!(x)){ MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_BAD_POINTER_OR_0); throw ML_BAD_POINTER_OR_0; } |
Definition at line 89 of file mlErrorMacros.h.
Referenced by ml::TSubImage< DATATYPE >::calculateMinMax(), ml::TVector< TVectorBase >::compMod(), ml::TSubImage< DATATYPE >::convertPointerToSubImagePosition(), ml::TVector< TVectorBase >::copy(), ml::TSubImage< DATATYPE >::copySubImageTyped(), ml::TVector< TVectorBase >::divCeil(), ml::TSubImage< DATATYPE >::fill(), ml::TVector< TVectorBase >::getVectorPosition(), ml::Tmat6< DT >::operator/=(), ml::TVector< TVectorBase >::operator/=(), and ml::TVector< TVectorBase >::TVector().
#define ML_HARAKIRI MLPrintAndNotifyFatal(__FILE__, __LINE__, ML_BAD_POINTER_OR_0); |
This logs the fatal error with file and line number.
Definition at line 93 of file mlErrorMacros.h.
Referenced by ml::MLTStdTypeInfos< VTYP >::MLTStdTypeInfos().
Like _ML_PRINT_ERROR_DUMP(FUNC_NAME, REASON, HANDLING, RT_OBJ, RTYPE) with RT_OBJ
as parameter which will be dumped in the error case.
Definition at line 293 of file mlErrorMacros.h.
#define ML_PRINT_ERROR_DUMP_NON_NULL | ( | FUNC_NAME, | |
REASON, | |||
HANDLING, | |||
RT_OBJ ) _ML_PRINT_ERROR_DUMP(FUNC_NAME, REASON, HANDLING, RT_OBJ, (RT_OBJ)->getTypeId()) |
Like _ML_PRINT_ERROR_DUMP(FUNC_NAME, REASON, HANDLING, RT_OBJ, RTYPE) with non-null RT_OBJ
as parameter which will be dumped in the error case.
Definition at line 301 of file mlErrorMacros.h.
Like _ML_PRINT_FATAL_ERROR_DUMP(FUNC_NAME, REASON, HANDLING, RT_OBJ, RTYPE) with RT_OBJ
as parameter which will be dumped in the error case.
Definition at line 278 of file mlErrorMacros.h.
#define ML_PRINT_FATAL_ERROR_DUMP_NON_NULL | ( | FUNC_NAME, | |
REASON, | |||
HANDLING, | |||
RT_OBJ ) _ML_PRINT_FATAL_ERROR_DUMP(FUNC_NAME, REASON, HANDLING, RT_OBJ, (RT_OBJ)->getTypeId()) |
Like _ML_PRINT_FATAL_ERROR_DUMP(FUNC_NAME, REASON, HANDLING, RT_OBJ, RTYPE) with non-null RT_OBJ
as parameter which will be dumped in the error case.
Definition at line 286 of file mlErrorMacros.h.
Like _ML_PRINT_INFORMATION_DUMP(FUNC_NAME, REASON, HANDLING, RT_OBJ, RTYPE) with RT_OBJ
as parameter which will be dumped in the error case.
Definition at line 316 of file mlErrorMacros.h.
Like _ML_PRINT_WARNING_DUMP(FUNC_NAME, REASON, HANDLING, RT_OBJ, RTYPE) with RT_OBJ
as parameter which will be dumped in the error case.
Definition at line 308 of file mlErrorMacros.h.
Definition at line 64 of file mlErrorMacros.h.