Defines the exception that is thrown whenever a command line is created and parsed. More...
#include <arg_exception.hpp>
Public Member Functions | |
ArgException (const std::string &text="undefined exception", const std::string &id="undefined", const std::string &td="Generic ArgException") | |
std::string | argId () const |
std::string | error () const |
std::string | typeDescription () const |
const char * | what () const throw () |
virtual | ~ArgException () throw () |
Private Attributes | |
std::string | _argId |
std::string | _errorText |
std::string | _typeDescription |
Defines the exception that is thrown whenever a command line is created and parsed.
A simple class that defines an argument exception. Should be caught whenever a CmdLine is created and parsed.
Definition at line 30 of file arg_exception.hpp.
|
inline |
Constructor.
text | - The text of the exception. |
id | - The text identifying the argument source. |
td | - Text describing the type of ArgException it is. of the exception. |
Definition at line 41 of file arg_exception.hpp.
|
inlinevirtual |
Destructor.
Definition at line 53 of file arg_exception.hpp.
|
inline |
Returns the argument id.
Definition at line 63 of file arg_exception.hpp.
|
inline |
Returns the error text.
Definition at line 58 of file arg_exception.hpp.
|
inline |
Returns the type of the exception. Used to explain and distinguish between different child exceptions.
Definition at line 85 of file arg_exception.hpp.
|
inline |
Returns the arg id and error text.
Definition at line 74 of file arg_exception.hpp.
|
private |
The argument related to this exception.
Definition at line 101 of file arg_exception.hpp.
|
private |
The text of the exception message.
Definition at line 96 of file arg_exception.hpp.
|
private |
Describes the type of the exception. Used to distinguish between different child exceptions.
Definition at line 107 of file arg_exception.hpp.