| tclap
    1.2.5
    | 
A simple class that defines and argument exception. More...
#include <ArgException.h>


| Public Member Functions | |
| ArgException (const std::string &text="undefined exception", const std::string &id="undefined", const std::string &td="Generic ArgException") | |
| Constructor.  More... | |
| virtual | ~ArgException () throw () | 
| Destructor.  More... | |
| std::string | error () const | 
| Returns the error text.  More... | |
| std::string | argId () const | 
| Returns the argument id.  More... | |
| const char * | what () const throw () | 
| Returns the arg id and error text.  More... | |
| std::string | typeDescription () const | 
| Returns the type of the exception.  More... | |
A simple class that defines and argument exception.
Should be caught whenever a CmdLine is created and parsed.
Definition at line 37 of file ArgException.h.
| 
 | 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 48 of file ArgException.h.
| 
 | inlinevirtual | |||||||||||||
Destructor.
Definition at line 60 of file ArgException.h.
| 
 | inline | 
Returns the argument id.
Definition at line 70 of file ArgException.h.
Referenced by TCLAP::StdOutput::failure().
| 
 | inline | 
Returns the error text.
Definition at line 65 of file ArgException.h.
Referenced by TCLAP::MultiArg< T >::_extractValue(), TCLAP::ValueArg< T >::_extractValue(), and TCLAP::StdOutput::failure().
| 
 | inline | 
Returns the type of the exception.
Used to explain and distinguish between different child exceptions.
Definition at line 92 of file ArgException.h.
| 
 | inline | |||||||||||||
Returns the arg id and error text.
Definition at line 81 of file ArgException.h.
Referenced by TCLAP::DocBookOutput::failure(), and TCLAP::ZshCompletionOutput::failure().