#include <stdio.h>
#include <qpOASES_e/MessageHandling.h>
#include <qpOASES_e/Utils.h>

Include dependency graph for MessageHandling.c:

Functions
const char *	MessageHandling_getErrorCodeMessage (MessageHandling *_THIS, const returnValue _returnValue)

returnValue	MessageHandling_listAllMessages (MessageHandling *_THIS)

returnValue	MessageHandling_reset (MessageHandling *_THIS)

returnValue	MessageHandling_throwError (MessageHandling _THIS, returnValue Enumber, const char additionaltext, const char functionname, const char filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

returnValue	MessageHandling_throwInfo (MessageHandling _THIS, returnValue Inumber, const char additionaltext, const char functionname, const char filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

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

returnValue	MessageHandling_throwWarning (MessageHandling _THIS, returnValue Wnumber, const char additionaltext, const char functionname, const char filename, const unsigned long linenumber, VisibilityStatus localVisibilityStatus)

void	MessageHandlingCON (MessageHandling _THIS, FILE _outputFile, VisibilityStatus _errorVisibility, VisibilityStatus _warningVisibility, VisibilityStatus _infoVisibility)

void	MessageHandlingCPY (MessageHandling FROM, MessageHandling TO)

MessageHandling *	qpOASES_getGlobalMessageHandler ()

Variables
BEGIN_NAMESPACE_QPOASES ReturnValueList	returnValueList []

Detailed Description

Author: Hans Joachim Ferreau, Andreas Potschka, Christian Kirches

Version: 3.1embedded

Date: 2007-2015

Implementation of the MessageHandling class including global return values.

Definition in file MessageHandling.c.

Function Documentation

◆ MessageHandling_getErrorCodeMessage()

const char* MessageHandling_getErrorCodeMessage	(	MessageHandling *	_THIS,
		const returnValue	_returnValue
	)

Provides message text corresponding to given returnValue.

Returns: String containing message text.

Definition at line 497 of file MessageHandling.c.

◆ MessageHandling_listAllMessages()

returnValue MessageHandling_listAllMessages ( MessageHandling * _THIS )

Prints a complete list of all messages to output file.

Returns: SUCCESSFUL_RETURN

Definition at line 357 of file MessageHandling.c.

◆ MessageHandling_reset()

returnValue MessageHandling_reset ( MessageHandling * _THIS )

Resets all preferences to default values.

Returns: SUCCESSFUL_RETURN

Definition at line 341 of file MessageHandling.c.

◆ MessageHandling_throwError()

returnValue MessageHandling_throwError	(	MessageHandling *	_THIS,
		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!

Definition at line 269 of file MessageHandling.c.

◆ MessageHandling_throwInfo()

returnValue MessageHandling_throwInfo	(	MessageHandling *	_THIS,
		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!

Definition at line 317 of file MessageHandling.c.

◆ MessageHandling_throwMessage()

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

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.

Definition at line 386 of file MessageHandling.c.

◆ MessageHandling_throwWarning()

returnValue MessageHandling_throwWarning	(	MessageHandling *	_THIS,
		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!

Definition at line 293 of file MessageHandling.c.

◆ MessageHandlingCON()

void MessageHandlingCON	(	MessageHandling *	_THIS,
		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 232 of file MessageHandling.c.

◆ MessageHandlingCPY()

void MessageHandlingCPY	(	MessageHandling *	FROM,
		MessageHandling *	TO
	)

Definition at line 252 of file MessageHandling.c.

◆ qpOASES_getGlobalMessageHandler()

MessageHandling* qpOASES_getGlobalMessageHandler ( )

Global message handler for all qpOASES modules.

Definition at line 545 of file MessageHandling.c.

Variable Documentation

◆ returnValueList

BEGIN_NAMESPACE_QPOASES ReturnValueList returnValueList[]

Defines pairs of global return values and messages.

Definition at line 52 of file MessageHandling.c.

Functions

Variables

Detailed Description

Function Documentation

◆ MessageHandling_getErrorCodeMessage()

◆ MessageHandling_listAllMessages()

◆ MessageHandling_reset()

◆ MessageHandling_throwError()

◆ MessageHandling_throwInfo()

◆ MessageHandling_throwMessage()

◆ MessageHandling_throwWarning()

◆ MessageHandlingCON()

◆ MessageHandlingCPY()

◆ qpOASES_getGlobalMessageHandler()

Variable Documentation

◆ returnValueList