mlFilterMessage.h File Reference

Header file of helper class to store and handle error messages occuring in filter calls as well as to convert them to std::strings. More...

#include "MLFileListToolsSystem.h"
#include <mlModuleIncludes.h>
#include <list>

Go to the source code of this file.

Classes
class	ml::FilterMessage
	Helper class to store and handle error messages occuring in filter calls as well as to convert them to std::strings. More...

Namespaces
	ml
	Main documentation file for ML users and developers.

Macros
#define	_SEND_FILTER_MESSAGE(MESSAGE_PRINT_MACRO, MESSAGE_LIST, MESSAGE_TYPE, FILE, LINE, FUNCTION, ERROR_CODE, HANDLING)
	Helper macro to post a message to the available output channel, either into MESSAGE_LIST or with MESSAGE_PRINT_MACRO. More...

Typedefs
typedef std::list< FilterMessage >	ml::FilterMessageList
	List of messages which can occur during filter calls. More...

Functions
std::string	ml::dumpFilterMessageList (const FilterMessageList &msgList)
	Convenience function which dumps an entire list of filter messages into one string. More...

Detailed Description

Header file of helper class to store and handle error messages occuring in filter calls as well as to convert them to std::strings.

Author

Wolf Spindler

Date

2015-06-17

Definition in file mlFilterMessage.h.

Macro Definition Documentation

_SEND_FILTER_MESSAGE

#define _SEND_FILTER_MESSAGE	(		MESSAGE_PRINT_MACRO,
			MESSAGE_LIST,
			MESSAGE_TYPE,
			FILE,
			LINE,
			FUNCTION,
			ERROR_CODE,
			HANDLING
	)

Value:

  if (MESSAGE_LIST){ \
    FilterMessage message(MESSAGE_TYPE, FILE, LINE, FUNCTION, ERROR_CODE, HANDLING); \
    messageList->push_back(message); \
  } \
  else{ \
    MESSAGE_PRINT_MACRO(FUNCTION, ERROR_CODE, HANDLING); \
  }

Helper macro to post a message to the available output channel, either into MESSAGE_LIST or with MESSAGE_PRINT_MACRO.

Parameters

MESSAGE_PRINT_MACRO	The ML_PRINT macro such as ML_PRINT_WARNING or ML_PRINT_ERROR.
MESSAGE_LIST	The list in which messages shall be stored if not nullptr.
MESSAGE_TYPE	The ML enumerator for the message type such as ML_WARNING or ML_ERROR.
FILE	The compiler macro for the current line number, normally LINE.
LINE	The compiler macro for the current line number, normally FILE.
FUNCTION	The string describing the function name.
ERROR_CODE	The ML error code describing the error, such as ML_BAD_PARAMETER.
HANDLING	The textual description of the error and its handling.

Definition at line 75 of file mlFilterMessage.h.