#include <ArgException.h>
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 |
Detailed Description
A simple class that defines and argument exception. Should be caught whenever a CmdLine is created and parsed.
Definition at line 36 of file ArgException.h.
Constructor & Destructor Documentation
| TCLAP::ArgException::ArgException | ( | const std::string & | text = "undefined exception", |
| const std::string & | id = "undefined", |
||
| const std::string & | td = "Generic ArgException" |
||
| ) | [inline] |
Constructor.
- Parameters:
-
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 47 of file ArgException.h.
| virtual TCLAP::ArgException::~ArgException | ( | ) | throw () [inline, virtual] |
Destructor.
Definition at line 59 of file ArgException.h.
Member Function Documentation
| std::string TCLAP::ArgException::argId | ( | ) | const [inline] |
Returns the argument id.
Definition at line 69 of file ArgException.h.
| std::string TCLAP::ArgException::error | ( | ) | const [inline] |
Returns the error text.
Definition at line 64 of file ArgException.h.
| std::string TCLAP::ArgException::typeDescription | ( | ) | const [inline] |
Returns the type of the exception. Used to explain and distinguish between different child exceptions.
Definition at line 91 of file ArgException.h.
| const char* TCLAP::ArgException::what | ( | ) | const throw () [inline] |
Returns the arg id and error text.
Definition at line 80 of file ArgException.h.
Member Data Documentation
std::string TCLAP::ArgException::_argId [private] |
The argument related to this exception.
Definition at line 107 of file ArgException.h.
std::string TCLAP::ArgException::_errorText [private] |
The text of the exception message.
Definition at line 102 of file ArgException.h.
std::string TCLAP::ArgException::_typeDescription [private] |
Describes the type of the exception. Used to distinguish between different child exceptions.
Definition at line 113 of file ArgException.h.
The documentation for this class was generated from the following file: