This class provides the error description functions for other classes.
#include <miperrorbase.h>
Inheritance diagram for MIPErrorBase:
Public Member Functions | |
| std::string | getErrorString () const |
| Returns the last known error description. | |
Protected Member Functions | |
| void | setErrorString (const std::string &str) const |
| Stores an error description. | |
Member Function Documentation
| std::string MIPErrorBase::getErrorString | ( | ) | const [inline] |
Typically, when some boolean function returned false, an error occured. A string describing this error can then be retrieved by this function if the derived class used the MIPErrorBase::setErrorString member function to set a description.
| void MIPErrorBase::setErrorString | ( | const std::string & | str | ) | const [inline, protected] |
If something goes wrong in a derived class it should store a description of what went wrong. This which can be done using this function.
The documentation for this class was generated from the following file:
- src/core/miperrorbase.h
