Main MRPT website > C++ reference
MRPT logo
Public Member Functions | Private Attributes

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 35 of file ArgException.h.

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

Inheritance diagram for TCLAP::ArgException:
Inheritance graph
[legend]

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")
 Constructor.
virtual ~ArgException () throw ()
 Destructor.
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.

Private Attributes

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

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.

Definition at line 46 of file ArgException.h.

virtual TCLAP::ArgException::~ArgException ( ) throw () [inline, virtual]

Destructor.

Definition at line 58 of file ArgException.h.


Member Function Documentation

std::string TCLAP::ArgException::argId ( ) const [inline]

Returns the argument id.

Definition at line 68 of file ArgException.h.

References _argId.

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

std::string TCLAP::ArgException::error ( ) const [inline]

Returns the error text.

Definition at line 63 of file ArgException.h.

References _errorText.

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

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 90 of file ArgException.h.

References _typeDescription.

const char* TCLAP::ArgException::what ( ) const throw () [inline]

Returns the arg id and error text.

Definition at line 79 of file ArgException.h.

References _argId, and _errorText.

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


Member Data Documentation

std::string TCLAP::ArgException::_argId [private]

The argument related to this exception.

Definition at line 106 of file ArgException.h.

Referenced by argId(), and what().

std::string TCLAP::ArgException::_errorText [private]

The text of the exception message.

Definition at line 101 of file ArgException.h.

Referenced by error(), and what().

Describes the type of the exception.

Used to distinguish between different child exceptions.

Definition at line 112 of file ArgException.h.

Referenced by typeDescription().




Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN:exported at Tue Jan 25 21:56:31 UTC 2011