Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Member Functions | Private Attributes
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 151 of file ArgException.h.

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

Inheritance diagram for TCLAP::CmdLineParseException:
Inheritance graph

Public Member Functions

 CmdLineParseException (const std::string &text="undefined exception", const std::string &id="undefined")
 Constructor. 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

◆ CmdLineParseException()

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

Member Function Documentation

◆ argId()

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

Returns the argument id.

Definition at line 77 of file ArgException.h.

References TCLAP::ArgException::_argId.

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

◆ error()

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

Returns the error text.

Definition at line 72 of file ArgException.h.

References TCLAP::ArgException::_errorText.

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

◆ typeDescription()

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

References TCLAP::ArgException::_typeDescription.

◆ what()

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

Returns the arg id and error text.

Definition at line 88 of file ArgException.h.

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

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

Member Data Documentation

◆ _argId

std::string TCLAP::ArgException::_argId
privateinherited

The argument related to this exception.

Definition at line 115 of file ArgException.h.

Referenced by TCLAP::ArgException::argId(), and TCLAP::ArgException::what().

◆ _errorText

std::string TCLAP::ArgException::_errorText
privateinherited

The text of the exception message.

Definition at line 110 of file ArgException.h.

Referenced by TCLAP::ArgException::error(), and TCLAP::ArgException::what().

◆ _typeDescription

std::string TCLAP::ArgException::_typeDescription
privateinherited

Describes the type of the exception.

Used to distinguish between different child exceptions.

Definition at line 121 of file ArgException.h.

Referenced by TCLAP::ArgException::typeDescription().




Page generated by Doxygen 1.9.4 for MRPT 1.4.0 SVN: at Thu Aug 4 01:35:14 UTC 2022