ML Reference
Namespaces
MeVis/Foundation/Sources/MLUtilities/mlLogging.h File Reference
#include "mlUtilsSystem.h"
#include "mlTypeDefs.h"
#include "mlSystemWarningsDisable.h"
#include <sstream>
#include "mlSystemWarningsRestore.h"

Go to the source code of this file.

Namespaces

namespace  ml
 

Define the namespace name like in the ML. Default is ml.


Defines

Public macros for logging errors, warnings and information messages

Each of the macros returns an ostream which allows to pipe additional details into the message.

These macros are equivalent to the older ML_PRINT_* macros which only took a string for the message details.

Example: 

 if (outIndex<0) {
   mlError("SomeClass::SomeMethod", ML_BAD_PARAMETER) << "returning NULL, excepted outIndex>=0, but got outIndex==" << outIndex; 
 }
#define mlFatalError(FUNCTION, ERRORCODE)   ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_FATAL, ERRORCODE, FUNCTION).getStream()
 Logs a fatal error for FUNCTION with MLErrorCode ERRORCODE.
#define mlError(FUNCTION, ERRORCODE)   ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_ERROR, ERRORCODE, FUNCTION).getStream()
 Logs an error for FUNCTION with MLErrorCode ERRORCODE.
#define mlWarning(FUNCTION, ERRORCODE)   ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_WARNING, ERRORCODE, FUNCTION).getStream()
 Logs a warning for FUNCTION with MLErrorCode ERRORCODE.
#define mlInfo(FUNCTION)   ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_INFORMATION, ML_RESULT_OK, FUNCTION).getStream()
 Logs an informational message.
#define mlFatalErrorWithDump(FUNCTION, ERRORCODE, OBJECT)   ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_FATAL, ERRORCODE, FUNCTION, (OBJECT), ML_NAMESPACE::internal::MLSecureGetRuntimeTypeId((OBJECT))).getStream()
 Logs a fatal error for FUNCTION with MLErrorCode ERRORCODE and additionally dumps the given OBJECT (which needs to support getTypeId()).
#define mlErrorWithDump(FUNCTION, ERRORCODE, OBJECT)   ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_ERROR, ERRORCODE, FUNCTION, (OBJECT), ML_NAMESPACE::internal::MLSecureGetRuntimeTypeId((OBJECT))).getStream()
 Logs an error for FUNCTION with MLErrorCode ERRORCODE and additionally dumps the given OBJECT (which needs to support getTypeId()).
#define mlWarningWithDump(FUNCTION, ERRORCODE, OBJECT)   ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_WARNING, ERRORCODE, FUNCTION, (OBJECT), ML_NAMESPACE::internal::MLSecureGetRuntimeTypeId((OBJECT))).getStream()
 Logs a warning for FUNCTION with MLErrorCode ERRORCODE and additionally dumps the given OBJECT (which needs to support getTypeId()).
#define mlInfoWithDump(FUNCTION, OBJECT)   ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_INFORMATION, ML_RESULT_OK, FUNCTION, (OBJECT), ML_NAMESPACE::internal::MLSecureGetRuntimeTypeId((OBJECT))).getStream()
 Logs an informational message for FUNCTION and additionally dumps the given OBJECT (which needs to support getTypeId()).

Detailed Description

Author:
Florian Link
Date:
2009/10

Definition in file mlLogging.h.