TCLAP::CmdLineParseException Class Reference

Detailed Description

Thrown from CmdLine when the arguments on the command line are not properly specified, e.g.

too many arguments, required argument missing, etc.

Definition at line 142 of file ArgException.h.

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

Inheritance diagram for TCLAP::CmdLineParseException:

Public Member Functions
	CmdLineParseException (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::CmdLineParseException::CmdLineParseException ( 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 151 of file ArgException.h.

Member Function Documentation

std::string TCLAP::ArgException::argId ( ) const

inlineinherited

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

inlineinherited

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

inlineinherited

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 ()

inlineinherited

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().