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

#include <mlFilterMessage.h>

Public Member Functions
	FilterMessage (MLMessageType messageTypeP=ML_INFORMATION, std::string fileP="", int lineNumberP=0, std::string functionP="", MLErrorCode errorCodeP=ML_RESULT_OK, std::string handlingP="")
	Convenience initialization of the FilterMessage. More...

std::string	dumpToString () const
	Converts the error information to a human readable string. More...

Public Attributes
MLErrorCode	errorCode
	The ML error code of the message. More...

std::string	file
	The file in which the message occurred. More...

int	lineNumber
	The line in file where the message occurred. More...

MLMessageType	messageType
	The ML error type of the message. More...

std::string	function
	The function or place where the message was generated. More...

std::string	handling
	Description and/or what will be done to handle it. More...

Detailed Description

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

Definition at line 24 of file mlFilterMessage.h.

Constructor & Destructor Documentation

◆ FilterMessage()

ml::FilterMessage::FilterMessage	(	MLMessageType	messageTypeP = `ML_INFORMATION`,
		std::string	fileP = `""`,
		int	lineNumberP = `0`,
		std::string	functionP = `""`,
		MLErrorCode	errorCodeP = `ML_RESULT_OK`,
		std::string	handlingP = `""`
	)

Convenience initialization of the FilterMessage.

Member Function Documentation

◆ dumpToString()

std::string ml::FilterMessage::dumpToString ( ) const

Converts the error information to a human readable string.

Member Data Documentation

◆ errorCode

MLErrorCode ml::FilterMessage::errorCode

The ML error code of the message.

Definition at line 39 of file mlFilterMessage.h.

◆ file

std::string ml::FilterMessage::file

The file in which the message occurred.

Definition at line 42 of file mlFilterMessage.h.

◆ function

std::string ml::FilterMessage::function

The function or place where the message was generated.

Definition at line 51 of file mlFilterMessage.h.

◆ handling

std::string ml::FilterMessage::handling

Description and/or what will be done to handle it.

Definition at line 54 of file mlFilterMessage.h.

◆ lineNumber

int ml::FilterMessage::lineNumber

The line in file where the message occurred.

Definition at line 45 of file mlFilterMessage.h.

◆ messageType

MLMessageType ml::FilterMessage::messageType

The ML error type of the message.

Definition at line 48 of file mlFilterMessage.h.

The documentation for this class was generated from the following file:

FMEstable/ReleaseMeVis/Projects/DICOM/MLFileListTools/Sources/mlFilterMessage.h

Public Member Functions

Public Attributes