TCLAP::ArgException Class Reference

Detailed Description

A simple class that defines and argument exception.

Should be caught whenever a CmdLine is created and parsed.

Definition at line 44 of file ArgException.h.

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

Inheritance diagram for TCLAP::ArgException:

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

Private Attributes
std::string	_errorText
	The text of the exception message. More...
std::string	_argId
	The argument related to this exception. More...
std::string	_typeDescription
	Describes the type of the exception. More...

Constructor & Destructor Documentation

ArgException()

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.

Definition at line 55 of file ArgException.h.

~ArgException()

virtual TCLAP::ArgException::~ArgException ( ) throw ( )

inlinevirtual

Destructor.

Definition at line 67 of file ArgException.h.

Member Function Documentation

argId()

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

inline

Returns the argument id.

Definition at line 77 of file ArgException.h.

References _argId.

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

error()

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

inline

Returns the error text.

Definition at line 72 of file ArgException.h.

References _errorText.

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

typeDescription()

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

inline

Returns the type of the exception.

Used to explain and distinguish between different child exceptions.

Definition at line 99 of file ArgException.h.

References _typeDescription.

what()

const char* TCLAP::ArgException::what ( ) const throw ( )

inline

Returns the arg id and error text.

Definition at line 88 of file ArgException.h.

References _argId, and _errorText.

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

Member Data Documentation

_argId

std::string TCLAP::ArgException::_argId

private

The argument related to this exception.

Definition at line 115 of file ArgException.h.

Referenced by argId(), and what().

_errorText

std::string TCLAP::ArgException::_errorText

private

The text of the exception message.

Definition at line 110 of file ArgException.h.

Referenced by error(), and what().

_typeDescription

std::string TCLAP::ArgException::_typeDescription

private

Describes the type of the exception.

Used to distinguish between different child exceptions.

Definition at line 121 of file ArgException.h.

Referenced by typeDescription().