Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
MessageHandling Class Reference

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

#include <MessageHandling.hpp>

List of all members.

Classes

struct  ReturnValueList

Public Member Functions

int getErrorCount () const
int getErrorCount () const
int getErrorCount () const
VisibilityStatus getErrorVisibilityStatus () const
VisibilityStatus getErrorVisibilityStatus () const
VisibilityStatus getErrorVisibilityStatus () const
VisibilityStatus getInfoVisibilityStatus () const
VisibilityStatus getInfoVisibilityStatus () const
VisibilityStatus getInfoVisibilityStatus () const
myFILEgetOutputFile () const
myFILEgetOutputFile () const
FILE * getOutputFile () const
VisibilityStatus getWarningVisibilityStatus () const
VisibilityStatus getWarningVisibilityStatus () const
VisibilityStatus getWarningVisibilityStatus () const
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)
MessageHandlingoperator= (const MessageHandling &rhs)
MessageHandlingoperator= (const MessageHandling &rhs)
MessageHandlingoperator= (const MessageHandling &rhs)
returnValue reset ()
returnValue reset ()
returnValue reset ()
returnValue setErrorCount (int _errorCount)
returnValue setErrorCount (int _errorCount)
returnValue setErrorCount (int _errorCount)
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 setOutputFile (myFILE *_outputFile)
void setOutputFile (myFILE *_outputFile)
void setOutputFile (FILE *_outputFile)
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 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)
 ~MessageHandling ()
 ~MessageHandling ()
 ~MessageHandling ()

Static Public Member Functions

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)

Protected Attributes

int errorCount
VisibilityStatus errorVisibility
VisibilityStatus infoVisibility
myFILEoutputFile
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

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


Constructor & Destructor Documentation

Constructor which takes the desired output file.

Parameters:
_outputFileOutput 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:
_errorVisibilityVisibility status for error messages.
_warningVisibilityVisibility status for warning messages.
_infoVisibilityVisibility 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:
_outputFileOutput file.
_errorVisibilityVisibility status for error messages.
_warningVisibilityVisibility status for warning messages.
_infoVisibilityVisibility status for info messages.

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

Copy constructor (deep copy).

Parameters:
rhsRhs object.

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

Default constructor.

Constructor which takes the desired output file.

Parameters:
_outputFileOutput file.
MessageHandling::MessageHandling ( VisibilityStatus  _errorVisibility,
VisibilityStatus  _warningVisibility,
VisibilityStatus  _infoVisibility 
)

Constructor which takes the desired visibility states.

Parameters:
_errorVisibilityVisibility status for error messages.
_warningVisibilityVisibility status for warning messages.
_infoVisibilityVisibility 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:
_outputFileOutput file.
_errorVisibilityVisibility status for error messages.
_warningVisibilityVisibility status for warning messages.
_infoVisibilityVisibility status for info messages.

Copy constructor (deep copy).

Parameters:
rhsRhs object.

Destructor.

Default constructor.

MessageHandling::MessageHandling ( FILE *  _outputFile)

Constructor which takes the desired output file.

Parameters:
_outputFileOutput 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:
_errorVisibilityVisibility status for error messages.
_warningVisibilityVisibility status for warning messages.
_infoVisibilityVisibility 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:
_outputFileOutput file.
_errorVisibilityVisibility status for error messages.
_warningVisibilityVisibility status for warning messages.
_infoVisibilityVisibility status for info messages.

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

Copy constructor (deep copy).

Parameters:
rhsRhs object.

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.

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.
const char * MessageHandling::getErrorString ( int  error) [static]

Return the error code string.

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

Returns visibility status for error messages.

Returns:
Visibility status for error messages.

Returns visibility status for error messages.

Returns:
Visibility status for error messages.

Returns visibility status for error messages.

Returns:
Visibility status for error messages.

Returns visibility status for info messages.

Returns:
Visibility status for info messages.

Returns visibility status for info messages.

Returns:
Visibility status for info messages.

Returns visibility status for info messages.

Returns:
Visibility status for info messages.

Returns pointer to output file.

Returns:
Pointer to output file.

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.

Returns visibility status for warning messages.

Returns:
Visibility status for warning messages.

Returns visibility status for warning messages.

Returns:
Visibility status for warning messages.

Returns visibility status for warning messages.

Returns:
Visibility status for warning messages.

Prints a complete list of all messages to output file.

Returns:
SUCCESSFUL_RETURN

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.

Prints a complete list of all messages to output file.

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

Assignment operator (deep copy).

Parameters:
rhsRhs object.
MessageHandling & MessageHandling::operator= ( const MessageHandling rhs)

Assignment operator (deep copy).

Parameters:
rhsRhs 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:
rhsRhs object.

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.

Resets all preferences to default values.

Returns:
SUCCESSFUL_RETURN

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:
_errorCountNew error count value.
returnValue MessageHandling::setErrorCount ( int  _errorCount) [inline]

Changes error count.

Returns:
SUCCESSFUL_RETURN
RET_INVALID_ARGUMENT
Parameters:
_errorCountNew error count value.
returnValue MessageHandling::setErrorCount ( int  _errorCount) [inline]

Changes error count.

Returns:
SUCCESSFUL_RETURN
RET_INVALID_ARGUMENT
Parameters:
_errorCountNew error count value.
void MessageHandling::setErrorVisibilityStatus ( VisibilityStatus  _errorVisibility) [inline]

Changes visibility status for error messages.

Parameters:
_errorVisibilityNew visibility status for error messages.
void MessageHandling::setErrorVisibilityStatus ( VisibilityStatus  _errorVisibility) [inline]

Changes visibility status for error messages.

Parameters:
_errorVisibilityNew visibility status for error messages.
void MessageHandling::setErrorVisibilityStatus ( VisibilityStatus  _errorVisibility) [inline]

Changes visibility status for error messages.

Parameters:
_errorVisibilityNew visibility status for error messages.
void MessageHandling::setInfoVisibilityStatus ( VisibilityStatus  _infoVisibility) [inline]

Changes visibility status for info messages.

Parameters:
_infoVisibilityNew visibility status for info messages.
void MessageHandling::setInfoVisibilityStatus ( VisibilityStatus  _infoVisibility) [inline]

Changes visibility status for info messages.

Parameters:
_infoVisibilityNew visibility status for info messages.
void MessageHandling::setInfoVisibilityStatus ( VisibilityStatus  _infoVisibility) [inline]

Changes visibility status for info messages.

Parameters:
_infoVisibilityNew visibility status for info messages.
void MessageHandling::setOutputFile ( myFILE _outputFile) [inline]

Changes output file for messages.

Parameters:
_outputFileNew output file for messages.
void MessageHandling::setOutputFile ( myFILE _outputFile) [inline]

Changes output file for messages.

Parameters:
_outputFileNew output file for messages.
void MessageHandling::setOutputFile ( FILE *  _outputFile) [inline]

Changes output file for messages.

Parameters:
_outputFileNew output file for messages.
void MessageHandling::setWarningVisibilityStatus ( VisibilityStatus  _warningVisibility) [inline]

Changes visibility status for warning messages.

Parameters:
_warningVisibilityNew visibility status for warning messages.
void MessageHandling::setWarningVisibilityStatus ( VisibilityStatus  _warningVisibility) [inline]

Changes visibility status for warning messages.

Parameters:
_warningVisibilityNew visibility status for warning messages.
void MessageHandling::setWarningVisibilityStatus ( VisibilityStatus  _warningVisibility) [inline]

Changes visibility status for warning messages.

Parameters:
_warningVisibilityNew 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:
EnumberError number returned by sub function call.
additionaltextAdditional error text (0, if none).
functionnameName of function which caused the error.
filenameName of file which caused the error.
linenumberNumber of line which caused the error.incompatible binary file
localVisibilityStatusDetermines (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:
EnumberError number returned by sub function call.
additionaltextAdditional error text (0, if none).
functionnameName of function which caused the error.
filenameName of file which caused the error.
linenumberNumber of line which caused the error.incompatible binary file
localVisibilityStatusDetermines (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:
EnumberError number returned by sub function call.
additionaltextAdditional error text (0, if none).
functionnameName of function which caused the error.
filenameName of file which caused the error.
linenumberNumber of line which caused the error.incompatible binary file
localVisibilityStatusDetermines (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::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:
InumberInfo number returned by sub function call.
additionaltextAdditional warning text (0, if none).
functionnameName of function which submitted the info.
filenameName of file which submitted the info.
linenumberNumber of line which submitted the info.
localVisibilityStatusDetermines (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:
InumberInfo number returned by sub function call.
additionaltextAdditional warning text (0, if none).
functionnameName of function which submitted the info.
filenameName of file which submitted the info.
linenumberNumber of line which submitted the info.
localVisibilityStatusDetermines (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:
InumberInfo number returned by sub function call.
additionaltextAdditional warning text (0, if none).
functionnameName of function which submitted the info.
filenameName of file which submitted the info.
linenumberNumber of line which submitted the info.
localVisibilityStatusDetermines (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::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:
RETnumberError/warning/info number returned by sub function call.
additionaltextAdditional warning text (0, if none).
functionnameName of function which caused the error/warning/info.
filenameName of file which caused the error/warning/info.
linenumberNumber of line which caused the error/warning/info.
localVisibilityStatusDetermines (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!
RETstringLeading 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:
RETnumberError/warning/info number returned by sub function call.
additionaltextAdditional warning text (0, if none).
functionnameName of function which caused the error/warning/info.
filenameName of file which caused the error/warning/info.
linenumberNumber of line which caused the error/warning/info.
localVisibilityStatusDetermines (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!
RETstringLeading 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:
RETnumberError/warning/info number returned by sub function call.
additionaltextAdditional warning text (0, if none).
functionnameName of function which caused the error/warning/info.
filenameName of file which caused the error/warning/info.
linenumberNumber of line which caused the error/warning/info.
localVisibilityStatusDetermines (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!
RETstringLeading 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:
WnumberWarning number returned by sub function call.
additionaltextAdditional warning text (0, if none).
functionnameName of function which caused the warning.
filenameName of file which caused the warning.
linenumberNumber of line which caused the warning.
localVisibilityStatusDetermines (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:
WnumberWarning number returned by sub function call.
additionaltextAdditional warning text (0, if none).
functionnameName of function which caused the warning.
filenameName of file which caused the warning.
linenumberNumber of line which caused the warning.
localVisibilityStatusDetermines (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:
WnumberWarning number returned by sub function call.
additionaltextAdditional warning text (0, if none).
functionnameName of function which caused the warning.
filenameName of file which caused the warning.
linenumberNumber of line which caused the warning.
localVisibilityStatusDetermines (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!

Member Data Documentation

int MessageHandling::errorCount [protected]

Counts number of errors (for nicer output only).

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

FILE* MessageHandling::outputFile [protected]

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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:40:25