TCLAP::ArgException Class Reference

#include <ArgException.h>

Inherits std::exception.

Inherited by TCLAP::ArgParseException, TCLAP::CmdLineParseException, and TCLAP::SpecificationException.

List of all members.

Public Member Functions
	ArgException (const std::string &text="undefined exception", const std::string &id="undefined", const std::string &td="Generic ArgException")
virtual	~ArgException () throw ()
std::string	error () const
std::string	argId () const
const char *	what () const throw ()
std::string	typeDescription () const

---

Detailed Description

A simple class that defines and argument exception. Should be caught whenever a CmdLine is created and parsed.

---

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.

virtual TCLAP::ArgException::~ArgException

(

)

throw () [inline, virtual]

Destructor.

---

Member Function Documentation

std::string TCLAP::ArgException::argId

(

)

const [inline]

Returns the argument id.

std::string TCLAP::ArgException::error

(

)

const [inline]

Returns the error text.

std::string TCLAP::ArgException::typeDescription

(

)

const [inline]

Returns the type of the exception. Used to explain and distinguish between different child exceptions.

const char* TCLAP::ArgException::what

(

)

const throw () [inline]

Returns the arg id and error text.