Event exception class. More...
#include <eventexceptions.h>
Public Member Functions | |
| CEventException (const std::string &where, const std::string &error_msg, const std::string &event_id) | |
| Constructor. More... | |
 Public Member Functions inherited from CException | |
| CException (const std::string &where, const std::string &error_msg) | |
| Class constructor. More... | |
| virtual const std::string & | what (void) |
| Function to get the error message. More... | |
| virtual | ~CException () throw () |
| Class destructor. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from CException | |
| std::string | error_msg |
| Exception error message. More... | |
Detailed Description
This class implements the exceptions for the CEvent class. In addition to the basic error message provided by the base class CException, this exception class provides also the unique identifier of the event that generated the exception.
Also, similarly to other exception classes, it appends a class identifer string ("[CEvent class] - ") to the error message in order to identify the class that generated the exception.
The base class can be used to catch any exception thrown by the application or also, this class can be used in order to catch only exceptions generated by CEvent objects.
Definition at line 40 of file eventexceptions.h.
Constructor & Destructor Documentation
| CEventException::CEventException | ( | const std::string & | where, |
| const std::string & | error_msg, | ||
| const std::string & | event_id | ||
| ) |
The constructor calls the base class constructor to add the general exception identifier and then adds the class identifier string "[CEvent class]" and the supplied error message.
It also appends the unique identifier of the event that generated the exception. So, the total exception message will look like this:
* [Exception caught] - <where> * [CEvent class] - <error message> - <event id> *
- Parameters
-
where a null terminated string with the information about the name of the function, the source code filename and the line where the exception was generated. This string must be generated by the HERE macro. error_msg a null terminated string that contains the error message. This string may have any valid character and there is no limit on its length. event_id a null terminated string that contains the event unique identifier. This string must be the one used to access the corresponding event.
Definition at line 27 of file eventexceptions.cpp.
References CException::error_msg.
The documentation for this class was generated from the following files:
- /builds/labrobotica/algorithms/iriutils/src/events/eventexceptions.h
- /builds/labrobotica/algorithms/iriutils/src/events/eventexceptions.cpp
