Log exception class. More...
#include <logexceptions.h>
Public Member Functions | |
| CLogException (const std::string &where, const std::string &error_msg, const std::string &filename) | |
| Class 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 CLog class. In addition to the basic error message provided by the base class CException, this exception class provides also the filename of the associated file to identify which log generated the error.
Also, similarly to other exception classes, it appends a class identifer string ("[CLog 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 logexceptions.h.
Constructor & Destructor Documentation
| CLogException::CLogException | ( | const std::string & | where, |
| const std::string & | error_msg, | ||
| const std::string & | filename | ||
| ) |
The constructor calls the base class constructor to add the general exception identifier and then adds the class identifier string "[Log class]" and the supplied error message.
It also appends the filename of the log file that generated the exception. So, the total exception message will look like this:
* [Exception caught] - <where> * Error: [CLog class] - <error message> - <filename> *
- 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. filename a null terminated string that contains the name of the log file that generated the exception. This string may have any valid character and there is no limit on its length.
Definition at line 23 of file logexceptions.cpp.
References CException::error_msg.
The documentation for this class was generated from the following files:
- /builds/labrobotica/algorithms/iriutils/src/logs/logexceptions.h
- /builds/labrobotica/algorithms/iriutils/src/logs/logexceptions.cpp
