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


Public Member Functions | |
| ArgException (std::string text="undefined exception", std::string id="undefined", std::string td="Generic ArgException") | |
| Constructor. | |
| ~ArgException () noexcept override=default | |
| Destructor. | |
| std::string | error () const |
| Returns the error text. | |
| std::string | argId () const |
| Returns the argument id. | |
| const char * | what () const noexcept override |
| Returns the arg id and error text. | |
| std::string | typeDescription () const |
| Returns the type of the exception. | |
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 46 of file ArgException.h.
|
overridedefaultnoexcept |
Destructor.
|
inline |
Returns the argument id.
Definition at line 68 of file ArgException.h.
Referenced by TCLAP::StdOutput::failure().
|
inline |
Returns the error text.
Definition at line 63 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 86 of file ArgException.h.
|
inlineoverridenoexcept |
Returns the arg id and error text.
Definition at line 78 of file ArgException.h.
Referenced by TCLAP::DocBookOutput::failure().