TCLAP::ArgParseException Class Reference

---

Detailed Description

Thrown from within the child Arg classes when it fails to properly parse the argument it has been passed.

#include <mrpt/otherlibs/tclap/ArgException.h>

Inheritance diagram for TCLAP::ArgParseException:

List of all members.

Public Member Functions
	ArgParseException (const std::string &text="undefined exception", const std::string &id="undefined")
	Constructor.
std::string	error () const
	Returns the error text.
std::string	argId () const
	Returns the argument id.
const char *	what () const throw ()
	Returns the arg id and error text.
std::string	typeDescription () const
	Returns the type of the exception.

---

Constructor & Destructor Documentation

TCLAP::ArgParseException::ArgParseException	(	const std::string &	text = "undefined exception",
		const std::string &	id = "undefined"
	)		[inline]

Constructor.

Parameters:

text	- The text of the exception.
id	- The text identifying the argument source of the exception.

Definition at line 129 of file ArgException.h.

---

Member Function Documentation

std::string TCLAP::ArgException::argId

(

)

const [inline, inherited]

Returns the argument id.

Definition at line 68 of file ArgException.h.

References TCLAP::ArgException::_argId.

Referenced by TCLAP::StdOutput::failure().

std::string TCLAP::ArgException::error

(

)

const [inline, inherited]

Returns the error text.

Definition at line 63 of file ArgException.h.

References TCLAP::ArgException::_errorText.

Referenced by TCLAP::StdOutput::failure().

std::string TCLAP::ArgException::typeDescription

(

)

const [inline, inherited]

Returns the type of the exception.

Used to explain and distinguish between different child exceptions.

Definition at line 90 of file ArgException.h.

References TCLAP::ArgException::_typeDescription.

const char* TCLAP::ArgException::what

(

)

const throw () [inline, inherited]

Returns the arg id and error text.

Definition at line 79 of file ArgException.h.

References TCLAP::ArgException::_argId, and TCLAP::ArgException::_errorText.

Referenced by TCLAP::DocBookOutput::failure().