Classes | Public Member Functions | Private Attributes | List of all members

Allows to pass back messages to the calling function. More...

#include <acado_types.hpp>

Classes

class  returnValueData
 

Public Member Functions

returnValueaddMessage (const char *msg)
 
returnValuechangeLevel (returnValueLevel level)
 
returnValuechangeType (returnValueType type)
 
returnValueLevel getLevel () const
 
 operator int ()
 
bool operator! () const
 
bool operator!= (returnValueType cmp_type) const
 
returnValueoperator= (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

returnValueDatadata
 
returnValueLevel level
 
int status
 
returnValueType type
 

Detailed Description

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.

Author
Martin Lauko, Hans Joachim Ferreau, Boris Houska

Definition at line 1139 of file acado_types.hpp.

Constructor & Destructor Documentation

returnValue::returnValue ( )

Construct default returnValue.

Definition at line 419 of file acado_message_handling.cpp.

returnValue::returnValue ( returnValueType  _type)

Construct returnValue only from typedef.

Definition at line 424 of file acado_message_handling.cpp.

returnValue::returnValue ( int  _type)

Construct returnValue from int, for compatibility

Definition at line 429 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 436 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 407 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 538 of file acado_message_handling.cpp.

returnValue::~returnValue ( )

Destroys data instance only if it owns it

Definition at line 507 of file acado_message_handling.cpp.

Member Function Documentation

returnValue & returnValue::addMessage ( const char *  msg)

Adds another message to the end of messages list.

Definition at line 552 of file acado_message_handling.cpp.

returnValue & returnValue::changeLevel ( returnValueLevel  level)

Change the importance level of the returned value

Definition at line 564 of file acado_message_handling.cpp.

returnValue & returnValue::changeType ( returnValueType  type)

Change the type of the returned message

Definition at line 572 of file acado_message_handling.cpp.

returnValueLevel returnValue::getLevel ( ) const

Definition at line 450 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 500 of file acado_message_handling.cpp.

bool returnValue::operator! ( ) const

Returns true if return value type is not SUCCESSFUL_RETURN

Definition at line 471 of file acado_message_handling.cpp.

bool returnValue::operator!= ( returnValueType  cmp_type) const

Compares the returnValue type to its enum

Definition at line 457 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 478 of file acado_message_handling.cpp.

bool returnValue::operator== ( returnValueType  cmp_type) const

Compares the returnValue type to its enum

Definition at line 464 of file acado_message_handling.cpp.

void returnValue::print ( )

Prints all messages to the standard output.

Definition at line 581 of file acado_message_handling.cpp.

void returnValue::printBasic ( )

Prints only the most basic information, no messages, to the standard output.

Definition at line 597 of file acado_message_handling.cpp.

Member Data Documentation

returnValueData* returnValue::data
private

Definition at line 1235 of file acado_types.hpp.

returnValueLevel returnValue::level
private

Definition at line 1232 of file acado_types.hpp.

int returnValue::status
private

Definition at line 1233 of file acado_types.hpp.

returnValueType returnValue::type
private

Definition at line 1231 of file acado_types.hpp.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:26