Allows to pass back messages to the calling function. More...
#include <acado_types.hpp>
Classes | |
| class | returnValueData |
Public Member Functions | |
| returnValue & | addMessage (const char *msg) |
| returnValue & | changeLevel (returnValueLevel level) |
| returnValue & | changeType (returnValueType type) |
| returnValueLevel | getLevel () const |
| operator int () | |
| bool | operator! () const |
| bool | operator!= (returnValueType cmp_type) const |
| returnValue & | operator= (const returnValue &old) |
| bool | operator== (returnValueType cmp_type) const |
| void | print () |
| void | printBasic () |
| returnValue () | |
| returnValue (returnValueType _type) | |
| returnValue (int _type) | |
| returnValue (const returnValue &old) | |
| returnValue (const char *msg, returnValueLevel level=LVL_ERROR, returnValueType type=RET_UNKNOWN_BUG) | |
| returnValue (const char *msg, returnValueLevel level, const returnValue &old) | |
| ~returnValue () | |
Private Attributes | |
| returnValueData * | data |
| returnValueLevel | level |
| int | status |
| returnValueType | type |
Allows to pass back messages to the calling function.
An instance of the class returnValue is returned by all ACADO functions for passing back messages to the calling function.
Definition at line 1119 of file acado_types.hpp.
Construct default returnValue.
Definition at line 422 of file acado_message_handling.cpp.
| returnValue::returnValue | ( | returnValueType | _type | ) |
Construct returnValue only from typedef.
Definition at line 427 of file acado_message_handling.cpp.
| returnValue::returnValue | ( | int | _type | ) |
Construct returnValue from int, for compatibility
Definition at line 432 of file acado_message_handling.cpp.
| returnValue::returnValue | ( | const returnValue & | old | ) |
Copy constructor with minimum performance cost. Newly constructed instance takes ownership of data.
Definition at line 439 of file acado_message_handling.cpp.
| returnValue::returnValue | ( | const char * | msg, |
| returnValueLevel | level = LVL_ERROR, |
||
| returnValueType | type = RET_UNKNOWN_BUG |
||
| ) |
Constructor used by the ACADOERROR and similar macros.
Definition at line 410 of file acado_message_handling.cpp.
| returnValue::returnValue | ( | const char * | msg, |
| returnValueLevel | level, | ||
| const returnValue & | old | ||
| ) |
Constructor used by the ACADOERROR and similar macros. Special case. Constructs returnValue from old one, changing level and adding message
Definition at line 541 of file acado_message_handling.cpp.
Destroys data instance only if it owns it
Definition at line 510 of file acado_message_handling.cpp.
| returnValue & returnValue::addMessage | ( | const char * | msg | ) |
Adds another message to the end of messages list.
Definition at line 555 of file acado_message_handling.cpp.
| returnValue & returnValue::changeLevel | ( | returnValueLevel | level | ) |
Change the importance level of the returned value
Definition at line 567 of file acado_message_handling.cpp.
Change the type of the returned message
Definition at line 575 of file acado_message_handling.cpp.
| returnValueLevel returnValue::getLevel | ( | ) | const |
Definition at line 453 of file acado_message_handling.cpp.
| returnValue::operator int | ( | ) |
Compatibility function, allows returnValue to be used as a number, similar to a enum.
Definition at line 503 of file acado_message_handling.cpp.
| bool returnValue::operator! | ( | ) | const |
Returns true if return value type is not SUCCESSFUL_RETURN
Definition at line 474 of file acado_message_handling.cpp.
| bool returnValue::operator!= | ( | returnValueType | cmp_type | ) | const |
Compares the returnValue type to its enum
Definition at line 460 of file acado_message_handling.cpp.
| returnValue & returnValue::operator= | ( | const returnValue & | old | ) |
Assignment operator. Left hand side instance takes ownership of data.
Definition at line 481 of file acado_message_handling.cpp.
| bool returnValue::operator== | ( | returnValueType | cmp_type | ) | const |
Compares the returnValue type to its enum
Definition at line 467 of file acado_message_handling.cpp.
| void returnValue::print | ( | ) |
Prints all messages to the standard output.
Definition at line 584 of file acado_message_handling.cpp.
| void returnValue::printBasic | ( | ) |
Prints only the most basic information, no messages, to the standard output.
Definition at line 600 of file acado_message_handling.cpp.
returnValueData* returnValue::data [private] |
Definition at line 1215 of file acado_types.hpp.
returnValueLevel returnValue::level [private] |
Definition at line 1212 of file acado_types.hpp.
int returnValue::status [private] |
Definition at line 1213 of file acado_types.hpp.
returnValueType returnValue::type [private] |
Definition at line 1211 of file acado_types.hpp.