argos::CARGoSException Class Reference

The exception that wraps all errors in ARGoS. More...

#include <argos_exception.h>

Inheritance diagram for argos::CARGoSException:
Collaboration diagram for argos::CARGoSException:

Public Member Functions

 CARGoSException (const std::string &str_what, std::exception *pc_nested=NULL) throw ()
 Class constructor. More...
 
virtual ~CARGoSException () throw ()
 Class destructor. More...
 
virtual const char * what () const throw ()
 Returns the error message that explains what happened and why the exception was thrown The returned message also contains messages of nested exceptions, if any. More...
 

Detailed Description

The exception that wraps all errors in ARGoS.

This class is used to wrap all errors occurring in ARGoS. You should never explicitly throw this exception directly, but you should instead use the provided macros THROW_ARGOSEXCEPTION() and THROW_ARGOSEXCEPTION_NESTED().

Definition at line 61 of file argos_exception.h.

Constructor & Destructor Documentation

argos::CARGoSException::CARGoSException ( const std::string &  str_what,
std::exception *  pc_nested = NULL 
)
throw (
)
inline

Class constructor.

Parameters
str_whatthe error message that explains what happened and why the exception was thrown
pc_nesteda pointer to the nested exception

Definition at line 70 of file argos_exception.h.

virtual argos::CARGoSException::~CARGoSException ( )
throw (
)
inlinevirtual

Class destructor.

Definition at line 83 of file argos_exception.h.

Member Function Documentation

virtual const char* argos::CARGoSException::what ( ) const
throw (
)
inlinevirtual

Returns the error message that explains what happened and why the exception was thrown The returned message also contains messages of nested exceptions, if any.

Definition at line 90 of file argos_exception.h.