Handles all kind of error messages, warnings and other information. More...

#include <MessageHandling.hpp>

Classes
struct	ReturnValueList
	Data structure for entries in global message list. More...

Public Member Functions
int	getErrorCount () const

int	getErrorCount () const

int	getErrorCount () const

int_t	getErrorCount () const

VisibilityStatus	getErrorVisibilityStatus () const

VisibilityStatus	getErrorVisibilityStatus () const

VisibilityStatus	getErrorVisibilityStatus () const

VisibilityStatus	getErrorVisibilityStatus () const

VisibilityStatus	getInfoVisibilityStatus () const

VisibilityStatus	getInfoVisibilityStatus () const

VisibilityStatus	getInfoVisibilityStatus () const

VisibilityStatus	getInfoVisibilityStatus () const

myFILE *	getOutputFile () const

myFILE *	getOutputFile () const

FILE *	getOutputFile () const

FILE *	getOutputFile () const

VisibilityStatus	getWarningVisibilityStatus () const

VisibilityStatus	getWarningVisibilityStatus () const

VisibilityStatus	getWarningVisibilityStatus () const

VisibilityStatus	getWarningVisibilityStatus () const

returnValue	listAllMessages ()

returnValue	listAllMessages ()

returnValue	listAllMessages ()

returnValue	listAllMessages ()

	MessageHandling ()

	MessageHandling ()

	MessageHandling (myFILE *_outputFile)

	MessageHandling (myFILE *_outputFile)

	MessageHandling (VisibilityStatus _errorVisibility, VisibilityStatus _warningVisibility, VisibilityStatus _infoVisibility)

	MessageHandling (VisibilityStatus _errorVisibility, VisibilityStatus _warningVisibility, VisibilityStatus _infoVisibility)

	MessageHandling (myFILE *_outputFile, VisibilityStatus _errorVisibility, VisibilityStatus _warningVisibility, VisibilityStatus _infoVisibility)

	MessageHandling (myFILE *_outputFile, VisibilityStatus _errorVisibility, VisibilityStatus _warningVisibility, VisibilityStatus _infoVisibility)

	MessageHandling (const MessageHandling &rhs)

	MessageHandling (const MessageHandling &rhs)

	MessageHandling ()

	MessageHandling (FILE *_outputFile)

	MessageHandling (VisibilityStatus _errorVisibility, VisibilityStatus _warningVisibility, VisibilityStatus _infoVisibility)

	MessageHandling (FILE *_outputFile, VisibilityStatus _errorVisibility, VisibilityStatus _warningVisibility, VisibilityStatus _infoVisibility)

	MessageHandling (const MessageHandling &rhs)

	MessageHandling ()

	MessageHandling (FILE *_outputFile)

	MessageHandling (VisibilityStatus _errorVisibility, VisibilityStatus _warningVisibility, VisibilityStatus _infoVisibility)

	MessageHandling (FILE *_outputFile, VisibilityStatus _errorVisibility, VisibilityStatus _warningVisibility, VisibilityStatus _infoVisibility)

	MessageHandling (const MessageHandling &rhs)

MessageHandling &	operator= (const MessageHandling &rhs)

MessageHandling &	operator= (const MessageHandling &rhs)

MessageHandling &	operator= (const MessageHandling &rhs)

MessageHandling &	operator= (const MessageHandling &rhs)

returnValue	reset ()

returnValue	reset ()

returnValue	reset ()

returnValue	reset ()

returnValue	setErrorCount (int _errorCount)

returnValue	setErrorCount (int _errorCount)

returnValue	setErrorCount (int _errorCount)

returnValue	setErrorCount (int_t _errorCount)

void	setErrorVisibilityStatus (VisibilityStatus _errorVisibility)

void	setErrorVisibilityStatus (VisibilityStatus _errorVisibility)

void	setErrorVisibilityStatus (VisibilityStatus _errorVisibility)

void	setErrorVisibilityStatus (VisibilityStatus _errorVisibility)

void	setInfoVisibilityStatus (VisibilityStatus _infoVisibility)

void	setInfoVisibilityStatus (VisibilityStatus _infoVisibility)

void	setInfoVisibilityStatus (VisibilityStatus _infoVisibility)

void	setInfoVisibilityStatus (VisibilityStatus _infoVisibility)

void	setOutputFile (myFILE *_outputFile)

void	setOutputFile (myFILE *_outputFile)

void	setOutputFile (FILE *_outputFile)

void	setOutputFile (FILE *_outputFile)

void	setWarningVisibilityStatus (VisibilityStatus _warningVisibility)

void	setWarningVisibilityStatus (VisibilityStatus _warningVisibility)

void	setWarningVisibilityStatus (VisibilityStatus _warningVisibility)

void	setWarningVisibilityStatus (VisibilityStatus _warningVisibility)

returnValue	throwError (returnValue Enumber, const char additionaltext, const char functionname, const char *filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

returnValue	throwError (returnValue Enumber, const char additionaltext, const char functionname, const char *filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

returnValue	throwError (returnValue Enumber, const char additionaltext, const char functionname, const char *filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

returnValue	throwError (returnValue Enumber, const char additionaltext, const char functionname, const char *filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

returnValue	throwInfo (returnValue Inumber, const char additionaltext, const char functionname, const char *filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

returnValue	throwInfo (returnValue Inumber, const char additionaltext, const char functionname, const char *filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

returnValue	throwInfo (returnValue Inumber, const char additionaltext, const char functionname, const char *filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

returnValue	throwInfo (returnValue Inumber, const char additionaltext, const char functionname, const char *filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

returnValue	throwWarning (returnValue Wnumber, const char additionaltext, const char functionname, const char *filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

returnValue	throwWarning (returnValue Wnumber, const char additionaltext, const char functionname, const char *filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

returnValue	throwWarning (returnValue Wnumber, const char additionaltext, const char functionname, const char *filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

returnValue	throwWarning (returnValue Wnumber, const char additionaltext, const char functionname, const char *filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

	~MessageHandling ()

	~MessageHandling ()

	~MessageHandling ()

	~MessageHandling ()

Static Public Member Functions
static const char *	getErrorCodeMessage (const returnValue _returnValue)

static const char *	getErrorCodeMessage (const returnValue _returnValue)

static const char *	getErrorString (int error)

Protected Member Functions
returnValue	throwMessage (returnValue RETnumber, const char additionaltext, const char functionname, const char filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus, const char RETstring)

returnValue	throwMessage (returnValue RETnumber, const char additionaltext, const char functionname, const char filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus, const char RETstring)

returnValue	throwMessage (returnValue RETnumber, const char additionaltext, const char functionname, const char filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus, const char RETstring)

returnValue	throwMessage (returnValue RETnumber, const char additionaltext, const char functionname, const char filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus, const char RETstring)

Protected Attributes
int	errorCount

int_t	errorCount

VisibilityStatus	errorVisibility

VisibilityStatus	infoVisibility

myFILE *	outputFile

FILE *	outputFile

VisibilityStatus	warningVisibility

Detailed Description

Handles all kind of error messages, warnings and other information.

This class handles all kinds of messages (errors, warnings, infos) initiated by qpOASES modules and stores the correspoding global preferences.

\author Hans Joachim Ferreau (special thanks to Leonard Wirsching)
\version 1.3embedded
\date 2007-2008

This class handles all kinds of messages (errors, warnings, infos) initiated by qpOASES modules and stores the correspoding global preferences.

\author Hans Joachim Ferreau (special thanks to Leonard Wirsching)
\version 3.0beta
\date 2007-2011

This class handles all kinds of messages (errors, warnings, infos) initiated by qpOASES modules and stores the corresponding global preferences.

\author Hans Joachim Ferreau (thanks to Leonard Wirsching)
\version 3.2
\date 2007-2015

This class handles all kinds of messages (errors, warnings, infos) initiated by qpOASES modules and stores the corresponding global preferences.

\author Hans Joachim Ferreau (thanks to Leonard Wirsching)
\version 3.1embedded
\date 2007-2015

Definition at line 188 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/MessageHandling.hpp.

Constructor & Destructor Documentation

MessageHandling::MessageHandling ( )

Default constructor.

Definition at line 168 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/MessageHandling.cpp.

MessageHandling::MessageHandling ( myFILE * _outputFile )

Constructor which takes the desired output file.

Parameters

_outputFile Output file.

Definition at line 179 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/MessageHandling.cpp.

MessageHandling::MessageHandling	(	VisibilityStatus	_errorVisibility,
		VisibilityStatus	_warningVisibility,
		VisibilityStatus	_infoVisibility
	)

Constructor which takes the desired visibility states.

Parameters

_errorVisibility	Visibility status for error messages.
_warningVisibility	Visibility status for warning messages.
_infoVisibility	Visibility status for info messages.

Definition at line 191 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/MessageHandling.cpp.

MessageHandling::MessageHandling	(	myFILE *	_outputFile,
		VisibilityStatus	_errorVisibility,
		VisibilityStatus	_warningVisibility,
		VisibilityStatus	_infoVisibility
	)

Constructor which takes the desired output file and desired visibility states.

Parameters

_outputFile	Output file.
_errorVisibility	Visibility status for error messages.
_warningVisibility	Visibility status for warning messages.
_infoVisibility	Visibility status for info messages.

Definition at line 206 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/MessageHandling.cpp.

MessageHandling::MessageHandling ( const MessageHandling & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

Definition at line 224 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/MessageHandling.cpp.

MessageHandling::~MessageHandling ( )

Destructor.

Definition at line 237 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/MessageHandling.cpp.

MessageHandling::MessageHandling ( )

Default constructor.

MessageHandling::MessageHandling ( myFILE * _outputFile )

Constructor which takes the desired output file.

Parameters

_outputFile Output file.

MessageHandling::MessageHandling	(	VisibilityStatus	_errorVisibility,
		VisibilityStatus	_warningVisibility,
		VisibilityStatus	_infoVisibility
	)

Constructor which takes the desired visibility states.

Parameters

_errorVisibility	Visibility status for error messages.
_warningVisibility	Visibility status for warning messages.
_infoVisibility	Visibility status for info messages.

MessageHandling::MessageHandling	(	myFILE *	_outputFile,
		VisibilityStatus	_errorVisibility,
		VisibilityStatus	_warningVisibility,
		VisibilityStatus	_infoVisibility
	)

Constructor which takes the desired output file and desired visibility states.

Parameters

_outputFile	Output file.
_errorVisibility	Visibility status for error messages.
_warningVisibility	Visibility status for warning messages.
_infoVisibility	Visibility status for info messages.

MessageHandling::MessageHandling ( const MessageHandling & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

MessageHandling::~MessageHandling ( )

Destructor.

MessageHandling::MessageHandling ( )

Default constructor.

MessageHandling::MessageHandling ( FILE * _outputFile )

Constructor which takes the desired output file.

Parameters

_outputFile Output file.

Definition at line 219 of file external_packages/qpOASES-3.0beta/src/MessageHandling.cpp.

MessageHandling::MessageHandling	(	VisibilityStatus	_errorVisibility,
		VisibilityStatus	_warningVisibility,
		VisibilityStatus	_infoVisibility
	)

Constructor which takes the desired visibility states.

Parameters

_errorVisibility	Visibility status for error messages.
_warningVisibility	Visibility status for warning messages.
_infoVisibility	Visibility status for info messages.

MessageHandling::MessageHandling	(	FILE *	_outputFile,
		VisibilityStatus	_errorVisibility,
		VisibilityStatus	_warningVisibility,
		VisibilityStatus	_infoVisibility
	)

Constructor which takes the desired output file and desired visibility states.

Parameters

_outputFile	Output file.
_errorVisibility	Visibility status for error messages.
_warningVisibility	Visibility status for warning messages.
_infoVisibility	Visibility status for info messages.

Definition at line 248 of file external_packages/qpOASES-3.0beta/src/MessageHandling.cpp.

MessageHandling::MessageHandling ( const MessageHandling & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

MessageHandling::~MessageHandling ( )

Destructor.

MessageHandling::MessageHandling ( )

Default constructor.

MessageHandling::MessageHandling ( FILE * _outputFile )

Constructor which takes the desired output file.

Parameters

_outputFile Output file.

MessageHandling::MessageHandling	(	VisibilityStatus	_errorVisibility,
		VisibilityStatus	_warningVisibility,
		VisibilityStatus	_infoVisibility
	)

Constructor which takes the desired visibility states.

Parameters

_errorVisibility	Visibility status for error messages.
_warningVisibility	Visibility status for warning messages.
_infoVisibility	Visibility status for info messages.

MessageHandling::MessageHandling	(	FILE *	_outputFile,
		VisibilityStatus	_errorVisibility,
		VisibilityStatus	_warningVisibility,
		VisibilityStatus	_infoVisibility
	)

Constructor which takes the desired output file and desired visibility states.

Parameters

_outputFile	Output file.
_errorVisibility	Visibility status for error messages.
_warningVisibility	Visibility status for warning messages.
_infoVisibility	Visibility status for info messages.

MessageHandling::MessageHandling ( const MessageHandling & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

MessageHandling::~MessageHandling ( )

Destructor.

Member Function Documentation

const char * MessageHandling::getErrorCodeMessage ( const returnValue _returnValue )

static

Provides message text corresponding to given returnValue.

Returns: String containing message text.

Definition at line 529 of file external_packages/qpOASES-3.0beta/src/MessageHandling.cpp.

static const char* MessageHandling::getErrorCodeMessage ( const returnValue _returnValue )

static

Provides message text corresponding to given returnValue.

Returns: String containing message text.

int MessageHandling::getErrorCount ( ) const

inline

Returns error count value.

Returns: Error count value.

int MessageHandling::getErrorCount ( ) const

inline

Returns error count value.

Returns: Error count value.

int MessageHandling::getErrorCount ( ) const

inline

Returns error count value.

Returns: Error count value.

int_t MessageHandling::getErrorCount ( ) const

inline

Returns error count value.

Returns: Error count value.

const char * MessageHandling::getErrorString ( int error )

static

Return the error code string.

Definition at line 520 of file external_packages/qpoases/SRC/MessageHandling.cpp.

VisibilityStatus MessageHandling::getErrorVisibilityStatus ( ) const

inline

Returns visibility status for error messages.

Returns: Visibility status for error messages.

VisibilityStatus MessageHandling::getErrorVisibilityStatus ( ) const

inline

Returns visibility status for error messages.

Returns: Visibility status for error messages.

VisibilityStatus MessageHandling::getErrorVisibilityStatus ( ) const

inline

Returns visibility status for error messages.

Returns: Visibility status for error messages.

VisibilityStatus MessageHandling::getErrorVisibilityStatus ( ) const

inline

Returns visibility status for error messages.

Returns: Visibility status for error messages.

VisibilityStatus MessageHandling::getInfoVisibilityStatus ( ) const

inline

Returns visibility status for info messages.

Returns: Visibility status for info messages.

VisibilityStatus MessageHandling::getInfoVisibilityStatus ( ) const

inline

Returns visibility status for info messages.

Returns: Visibility status for info messages.

VisibilityStatus MessageHandling::getInfoVisibilityStatus ( ) const

inline

Returns visibility status for info messages.

Returns: Visibility status for info messages.

VisibilityStatus MessageHandling::getInfoVisibilityStatus ( ) const

inline

Returns visibility status for info messages.

Returns: Visibility status for info messages.

myFILE* MessageHandling::getOutputFile ( ) const

inline

Returns pointer to output file.

Returns: Pointer to output file.

myFILE* MessageHandling::getOutputFile ( ) const

inline

Returns pointer to output file.

Returns: Pointer to output file.

FILE* MessageHandling::getOutputFile ( ) const

inline

Returns pointer to output file.

Returns: Pointer to output file.

FILE* MessageHandling::getOutputFile ( ) const

inline

Returns pointer to output file.

Returns: Pointer to output file.

VisibilityStatus MessageHandling::getWarningVisibilityStatus ( ) const

inline

Returns visibility status for warning messages.

Returns: Visibility status for warning messages.

VisibilityStatus MessageHandling::getWarningVisibilityStatus ( ) const

inline

Returns visibility status for warning messages.

Returns: Visibility status for warning messages.

VisibilityStatus MessageHandling::getWarningVisibilityStatus ( ) const

inline

Returns visibility status for warning messages.

Returns: Visibility status for warning messages.

VisibilityStatus MessageHandling::getWarningVisibilityStatus ( ) const

inline

Returns visibility status for warning messages.

Returns: Visibility status for warning messages.

returnValue MessageHandling::listAllMessages ( )

Prints a complete list of all messages to output file.

Returns: SUCCESSFUL_RETURN

returnValue MessageHandling::listAllMessages ( )

Prints a complete list of all messages to output file.

Returns: SUCCESSFUL_RETURN

Definition at line 355 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/MessageHandling.cpp.

returnValue MessageHandling::listAllMessages ( )

Prints a complete list of all messages to output file.

Returns: SUCCESSFUL_RETURN

returnValue MessageHandling::listAllMessages ( )

Prints a complete list of all messages to output file.

Returns: SUCCESSFUL_RETURN

MessageHandling& MessageHandling::operator= ( const MessageHandling & rhs )

Assignment operator (deep copy).

Parameters

rhs	Rhs object.

MessageHandling & MessageHandling::operator= ( const MessageHandling & rhs )

Assignment operator (deep copy).

Parameters

rhs	Rhs object.

Definition at line 249 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/MessageHandling.cpp.

MessageHandling& MessageHandling::operator= ( const MessageHandling & rhs )

Assignment operator (deep copy).

Parameters

rhs	Rhs object.

MessageHandling& MessageHandling::operator= ( const MessageHandling & rhs )

Assignment operator (deep copy).

Parameters

rhs	Rhs object.

returnValue MessageHandling::reset ( )

Resets all preferences to default values.

Returns: SUCCESSFUL_RETURN

Definition at line 339 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/MessageHandling.cpp.

returnValue MessageHandling::reset ( )

Resets all preferences to default values.

Returns: SUCCESSFUL_RETURN

returnValue MessageHandling::reset ( )

Resets all preferences to default values.

Returns: SUCCESSFUL_RETURN

returnValue MessageHandling::reset ( )

Resets all preferences to default values.

Returns: SUCCESSFUL_RETURN

returnValue MessageHandling::setErrorCount ( int _errorCount )

inline

Changes error count.

Returns: SUCCESSFUL_RETURN
RET_INVALID_ARGUMENT

Parameters

_errorCount New error count value.

returnValue MessageHandling::setErrorCount ( int _errorCount )

inline

Changes error count.

Returns: SUCCESSFUL_RETURN
RET_INVALID_ARGUMENT

Parameters

_errorCount New error count value.

returnValue MessageHandling::setErrorCount ( int _errorCount )

inline

Changes error count.

Returns: SUCCESSFUL_RETURN
RET_INVALID_ARGUMENT

Parameters

_errorCount New error count value.

returnValue MessageHandling::setErrorCount ( int_t _errorCount )

inline

Changes error count.

Returns: SUCCESSFUL_RETURN
RET_INVALID_ARGUMENT

Parameters

_errorCount New error count value.

void MessageHandling::setErrorVisibilityStatus ( VisibilityStatus _errorVisibility )

inline

Changes visibility status for error messages.

Parameters

_errorVisibility New visibility status for error messages.

void MessageHandling::setErrorVisibilityStatus ( VisibilityStatus _errorVisibility )

inline

Changes visibility status for error messages.

Parameters

_errorVisibility New visibility status for error messages.

void MessageHandling::setErrorVisibilityStatus ( VisibilityStatus _errorVisibility )

inline

Changes visibility status for error messages.

Parameters

_errorVisibility New visibility status for error messages.

void MessageHandling::setErrorVisibilityStatus ( VisibilityStatus _errorVisibility )

inline

Changes visibility status for error messages.

Parameters

_errorVisibility New visibility status for error messages.

void MessageHandling::setInfoVisibilityStatus ( VisibilityStatus _infoVisibility )

inline

Changes visibility status for info messages.

Parameters

_infoVisibility New visibility status for info messages.

void MessageHandling::setInfoVisibilityStatus ( VisibilityStatus _infoVisibility )

inline

Changes visibility status for info messages.

Parameters

_infoVisibility New visibility status for info messages.

void MessageHandling::setInfoVisibilityStatus ( VisibilityStatus _infoVisibility )

inline

Changes visibility status for info messages.

Parameters

_infoVisibility New visibility status for info messages.

void MessageHandling::setInfoVisibilityStatus ( VisibilityStatus _infoVisibility )

inline

Changes visibility status for info messages.

Parameters

_infoVisibility New visibility status for info messages.

void MessageHandling::setOutputFile ( myFILE * _outputFile )

inline

Changes output file for messages.

Parameters

_outputFile New output file for messages.

void MessageHandling::setOutputFile ( myFILE * _outputFile )

inline

Changes output file for messages.

Parameters

_outputFile New output file for messages.

void MessageHandling::setOutputFile ( FILE * _outputFile )

inline

Changes output file for messages.

Parameters

_outputFile New output file for messages.

void MessageHandling::setOutputFile ( FILE * _outputFile )

inline

Changes output file for messages.

Parameters

_outputFile New output file for messages.

void MessageHandling::setWarningVisibilityStatus ( VisibilityStatus _warningVisibility )

inline

Changes visibility status for warning messages.

Parameters

_warningVisibility New visibility status for warning messages.

void MessageHandling::setWarningVisibilityStatus ( VisibilityStatus _warningVisibility )

inline

Changes visibility status for warning messages.

Parameters

_warningVisibility New visibility status for warning messages.

void MessageHandling::setWarningVisibilityStatus ( VisibilityStatus _warningVisibility )

inline

Changes visibility status for warning messages.

Parameters

_warningVisibility New visibility status for warning messages.

void MessageHandling::setWarningVisibilityStatus ( VisibilityStatus _warningVisibility )

inline

Changes visibility status for warning messages.

Parameters

_warningVisibility New visibility status for warning messages.

returnValue MessageHandling::throwError	(	returnValue	Enumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus
	)

Prints an error message(a simplified macro THROWERROR is also provided).
Errors are definied as abnormal events which cause an immediate termination of the current (sub) function. Errors of a sub function should be commented by the calling function by means of a warning message (if this error does not cause an error of the calling function, either)!

Returns: Error number returned by sub function call

Parameters

Enumber	Error number returned by sub function call.
additionaltext	Additional error text (0, if none).
functionname	Name of function which caused the error.
filename	Name of file which caused the error.
linenumber	Number of line which caused the error.incompatible binary file
localVisibilityStatus	Determines (locally) if error message can be printed to myStderr. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!

returnValue MessageHandling::throwError	(	returnValue	Enumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus
	)

Prints an error message(a simplified macro THROWERROR is also provided).
Errors are definied as abnormal events which cause an immediate termination of the current (sub) function. Errors of a sub function should be commented by the calling function by means of a warning message (if this error does not cause an error of the calling function, either)!

Returns: Error number returned by sub function call

Parameters

Enumber	Error number returned by sub function call.
additionaltext	Additional error text (0, if none).
functionname	Name of function which caused the error.
filename	Name of file which caused the error.
linenumber	Number of line which caused the error.incompatible binary file
localVisibilityStatus	Determines (locally) if error message can be printed to myStderr. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!

Definition at line 267 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/MessageHandling.cpp.

returnValue MessageHandling::throwError	(	returnValue	Enumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus
	)

Prints an error message(a simplified macro THROWERROR is also provided).
Errors are definied as abnormal events which cause an immediate termination of the current (sub) function. Errors of a sub function should be commented by the calling function by means of a warning message (if this error does not cause an error of the calling function, either)!

Returns: Error number returned by sub function call

Parameters

Enumber	Error number returned by sub function call.
additionaltext	Additional error text (0, if none).
functionname	Name of function which caused the error.
filename	Name of file which caused the error.
linenumber	Number of line which caused the error.incompatible binary file
localVisibilityStatus	Determines (locally) if error message can be printed to stderr. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!

returnValue MessageHandling::throwError	(	returnValue	Enumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus
	)

Prints an error message(a simplified macro THROWERROR is also provided).
Errors are defined as abnormal events which cause an immediate termination of the current (sub) function. Errors of a sub function should be commented by the calling function by means of a warning message (if this error does not cause an error of the calling function, either)!

Returns: Error number returned by sub function call

Parameters

Enumber	Error number returned by sub function call.
additionaltext	Additional error text (0, if none).
functionname	Name of function which caused the error.
filename	Name of file which caused the error.
linenumber	Number of line which caused the error.incompatible binary file
localVisibilityStatus	Determines (locally) if error message can be printed to stdFile. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!

returnValue MessageHandling::throwInfo	(	returnValue	Inumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus
	)

Prints a info message (a simplified macro THROWINFO is also provided).

Returns: Info number returned by sub function call

Parameters

Inumber	Info number returned by sub function call.
additionaltext	Additional warning text (0, if none).
functionname	Name of function which submitted the info.
filename	Name of file which submitted the info.
linenumber	Number of line which submitted the info.
localVisibilityStatus	Determines (locally) if info message can be printed to myStderr. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!

returnValue MessageHandling::throwInfo	(	returnValue	Inumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus
	)

Prints a info message (a simplified macro THROWINFO is also provided).

Returns: Info number returned by sub function call

Parameters

Inumber	Info number returned by sub function call.
additionaltext	Additional warning text (0, if none).
functionname	Name of function which submitted the info.
filename	Name of file which submitted the info.
linenumber	Number of line which submitted the info.
localVisibilityStatus	Determines (locally) if info message can be printed to myStderr. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!

Definition at line 315 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/MessageHandling.cpp.

returnValue MessageHandling::throwInfo	(	returnValue	Inumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus
	)

Prints a info message (a simplified macro THROWINFO is also provided).

Returns: Info number returned by sub function call

Parameters

Inumber	Info number returned by sub function call.
additionaltext	Additional warning text (0, if none).
functionname	Name of function which submitted the info.
filename	Name of file which submitted the info.
linenumber	Number of line which submitted the info.
localVisibilityStatus	Determines (locally) if info message can be printed to stderr. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!

returnValue MessageHandling::throwInfo	(	returnValue	Inumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus
	)

Prints a info message (a simplified macro THROWINFO is also provided).

Returns: Info number returned by sub function call

Parameters

Inumber	Info number returned by sub function call.
additionaltext	Additional warning text (0, if none).
functionname	Name of function which submitted the info.
filename	Name of file which submitted the info.
linenumber	Number of line which submitted the info.
localVisibilityStatus	Determines (locally) if info message can be printed to stdFile. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!

returnValue MessageHandling::throwMessage	(	returnValue	RETnumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus,
		const char *	RETstring
	)

protected

Prints a info message to myStderr (auxiliary function).

Returns: Error/warning/info number returned by sub function call

Parameters

RETnumber	Error/warning/info number returned by sub function call.
additionaltext	Additional warning text (0, if none).
functionname	Name of function which caused the error/warning/info.
filename	Name of file which caused the error/warning/info.
linenumber	Number of line which caused the error/warning/info.
localVisibilityStatus	Determines (locally) if info message can be printed to myStderr. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!
RETstring	Leading string of error/warning/info message.

Definition at line 475 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/MessageHandling.cpp.

returnValue MessageHandling::throwMessage	(	returnValue	RETnumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus,
		const char *	RETstring
	)

protected

Prints a info message to myStderr (auxiliary function).

Returns: Error/warning/info number returned by sub function call

Parameters

RETnumber	Error/warning/info number returned by sub function call.
additionaltext	Additional warning text (0, if none).
functionname	Name of function which caused the error/warning/info.
filename	Name of file which caused the error/warning/info.
linenumber	Number of line which caused the error/warning/info.
localVisibilityStatus	Determines (locally) if info message can be printed to myStderr. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!
RETstring	Leading string of error/warning/info message.

returnValue MessageHandling::throwMessage	(	returnValue	RETnumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus,
		const char *	RETstring
	)

protected

Prints a info message to stderr (auxiliary function).

Returns: Error/warning/info number returned by sub function call

Parameters

RETnumber	Error/warning/info number returned by sub function call.
additionaltext	Additional warning text (0, if none).
functionname	Name of function which caused the error/warning/info.
filename	Name of file which caused the error/warning/info.
linenumber	Number of line which caused the error/warning/info.
localVisibilityStatus	Determines (locally) if info message can be printed to stderr. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!
RETstring	Leading string of error/warning/info message.

returnValue MessageHandling::throwMessage	(	returnValue	RETnumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus,
		const char *	RETstring
	)

protected

Prints a info message to stdFile (auxiliary function).

Returns: Error/warning/info number returned by sub function call

Parameters

RETnumber	Error/warning/info number returned by sub function call.
additionaltext	Additional warning text (0, if none).
functionname	Name of function which caused the error/warning/info.
filename	Name of file which caused the error/warning/info.
linenumber	Number of line which caused the error/warning/info.
localVisibilityStatus	Determines (locally) if info message can be printed to stdFile. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!
RETstring	Leading string of error/warning/info message.

returnValue MessageHandling::throwWarning	(	returnValue	Wnumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus
	)

Prints a warning message (a simplified macro THROWWARNING is also provided). Warnings are definied as abnormal events which does NOT cause an immediate termination of the current (sub) function.

Returns: Warning number returned by sub function call

Parameters

Wnumber	Warning number returned by sub function call.
additionaltext	Additional warning text (0, if none).
functionname	Name of function which caused the warning.
filename	Name of file which caused the warning.
linenumber	Number of line which caused the warning.
localVisibilityStatus	Determines (locally) if warning message can be printed to myStderr. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!

returnValue MessageHandling::throwWarning	(	returnValue	Wnumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus
	)

Prints a warning message (a simplified macro THROWWARNING is also provided). Warnings are definied as abnormal events which does NOT cause an immediate termination of the current (sub) function.

Returns: Warning number returned by sub function call

Parameters

Wnumber	Warning number returned by sub function call.
additionaltext	Additional warning text (0, if none).
functionname	Name of function which caused the warning.
filename	Name of file which caused the warning.
linenumber	Number of line which caused the warning.
localVisibilityStatus	Determines (locally) if warning message can be printed to myStderr. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!

Definition at line 291 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/MessageHandling.cpp.

returnValue MessageHandling::throwWarning	(	returnValue	Wnumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus
	)

Prints a warning message (a simplified macro THROWWARNING is also provided). Warnings are definied as abnormal events which does NOT cause an immediate termination of the current (sub) function.

Returns: Warning number returned by sub function call

Parameters

Wnumber	Warning number returned by sub function call.
additionaltext	Additional warning text (0, if none).
functionname	Name of function which caused the warning.
filename	Name of file which caused the warning.
linenumber	Number of line which caused the warning.
localVisibilityStatus	Determines (locally) if warning message can be printed to stderr. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!

returnValue MessageHandling::throwWarning	(	returnValue	Wnumber,
		const char *	additionaltext,
		const char *	functionname,
		const char *	filename,
		const unsigned long	linenumber,
		VisibilityStatus	localVisibilityStatus
	)

Prints a warning message (a simplified macro THROWWARNING is also provided). Warnings are definied as abnormal events which does NOT cause an immediate termination of the current (sub) function.

Returns: Warning number returned by sub function call

Parameters

Wnumber	Warning number returned by sub function call.
additionaltext	Additional warning text (0, if none).
functionname	Name of function which caused the warning.
filename	Name of file which caused the warning.
linenumber	Number of line which caused the warning.
localVisibilityStatus	Determines (locally) if warning message can be printed to stdFile. If GLOBAL visibility status of the message is set to VS_HIDDEN, no message is printed, anyway!