<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>TCLAP::ArgParseException Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div> <div align="right"> <a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a> </div> <!-- Generated by Doxygen 1.7.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <div class="left"> <form id="FSearchBox" action="search.php" method="get"> <img id="MSearchSelect" src="search/mag.png" alt=""/> <input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)"/> </form> </div><div class="right"></div> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespace_t_c_l_a_p.html">TCLAP</a> </li> <li class="navelem"><a class="el" href="class_t_c_l_a_p_1_1_arg_parse_exception.html">ArgParseException</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">TCLAP::ArgParseException Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="TCLAP::ArgParseException" --><!-- doxytag: inherits="TCLAP::ArgException" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Thrown from within the child <a class="el" href="class_t_c_l_a_p_1_1_arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a> classes when it fails to properly parse the argument it has been passed. </p> </div> <p><code>#include <<a class="el" href="_arg_exception_8h_source.html">mrpt/otherlibs/tclap/ArgException.h</a>></code></p> <div class="dynheader"> Inheritance diagram for TCLAP::ArgParseException:</div> <div class="dyncontent"> <div class="center"><img src="class_t_c_l_a_p_1_1_arg_parse_exception__inherit__graph.png" border="0" usemap="#_t_c_l_a_p_1_1_arg_parse_exception_inherit__map" alt="Inheritance graph"/></div> <map name="_t_c_l_a_p_1_1_arg_parse_exception_inherit__map" id="_t_c_l_a_p_1_1_arg_parse_exception_inherit__map"> <area shape="rect" id="node2" href="class_t_c_l_a_p_1_1_arg_exception.html" title="A simple class that defines and argument exception." alt="" coords="22,80,172,107"/><area shape="rect" id="node4" href="classstd_1_1exception.html" title="STL class." alt="" coords="45,5,149,32"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="class_t_c_l_a_p_1_1_arg_parse_exception-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg_parse_exception.html#aa9d9531405e505afd506491526733285">ArgParseException</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &text="undefined exception", const <a class="el" href="classstd_1_1string.html">std::string</a> &id="undefined")</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#aa9d9531405e505afd506491526733285"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg_exception.html#a0656dab88a7129bc288821bacd653d08">error</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the error text. <a href="#a0656dab88a7129bc288821bacd653d08"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg_exception.html#a18ffd1ad34c1799865f8e03df4ebdff1">argId</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the argument id. <a href="#a18ffd1ad34c1799865f8e03df4ebdff1"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg_exception.html#af51c89da2e4ae54fc9d05038ea484c83">what</a> () const throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the arg id and error text. <a href="#af51c89da2e4ae54fc9d05038ea484c83"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg_exception.html#abd271955e1b808bb92f8db7a16ea7c95">typeDescription</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of the exception. <a href="#abd271955e1b808bb92f8db7a16ea7c95"></a><br/></td></tr> </table> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aa9d9531405e505afd506491526733285"></a><!-- doxytag: member="TCLAP::ArgParseException::ArgParseException" ref="aa9d9531405e505afd506491526733285" args="(const std::string &text="undefined exception", const std::string &id="undefined")" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">TCLAP::ArgParseException::ArgParseException </td> <td>(</td> <td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td> <td class="paramname"><em>text</em> = <code>"undefined exception"</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td> <td class="paramname"><em>id</em> = <code>"undefined"</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">text</td><td>- The text of the exception. </td></tr> <tr><td class="paramname">id</td><td>- The text identifying the argument source of the exception. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="_arg_exception_8h_source.html#l00129">129</a> of file <a class="el" href="_arg_exception_8h_source.html">ArgException.h</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a18ffd1ad34c1799865f8e03df4ebdff1"></a><!-- doxytag: member="TCLAP::ArgParseException::argId" ref="a18ffd1ad34c1799865f8e03df4ebdff1" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> TCLAP::ArgException::argId </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the argument id. </p> <p>Definition at line <a class="el" href="_arg_exception_8h_source.html#l00068">68</a> of file <a class="el" href="_arg_exception_8h_source.html">ArgException.h</a>.</p> <p>References <a class="el" href="_arg_exception_8h_source.html#l00106">TCLAP::ArgException::_argId</a>.</p> <p>Referenced by <a class="el" href="_std_output_8h_source.html#l00141">TCLAP::StdOutput::failure()</a>.</p> </div> </div> <a class="anchor" id="a0656dab88a7129bc288821bacd653d08"></a><!-- doxytag: member="TCLAP::ArgParseException::error" ref="a0656dab88a7129bc288821bacd653d08" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> TCLAP::ArgException::error </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the error text. </p> <p>Definition at line <a class="el" href="_arg_exception_8h_source.html#l00063">63</a> of file <a class="el" href="_arg_exception_8h_source.html">ArgException.h</a>.</p> <p>References <a class="el" href="_arg_exception_8h_source.html#l00101">TCLAP::ArgException::_errorText</a>.</p> <p>Referenced by <a class="el" href="_std_output_8h_source.html#l00141">TCLAP::StdOutput::failure()</a>.</p> </div> </div> <a class="anchor" id="abd271955e1b808bb92f8db7a16ea7c95"></a><!-- doxytag: member="TCLAP::ArgParseException::typeDescription" ref="abd271955e1b808bb92f8db7a16ea7c95" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> TCLAP::ArgException::typeDescription </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the type of the exception. </p> <p>Used to explain and distinguish between different child exceptions. </p> <p>Definition at line <a class="el" href="_arg_exception_8h_source.html#l00090">90</a> of file <a class="el" href="_arg_exception_8h_source.html">ArgException.h</a>.</p> <p>References <a class="el" href="_arg_exception_8h_source.html#l00112">TCLAP::ArgException::_typeDescription</a>.</p> </div> </div> <a class="anchor" id="af51c89da2e4ae54fc9d05038ea484c83"></a><!-- doxytag: member="TCLAP::ArgParseException::what" ref="af51c89da2e4ae54fc9d05038ea484c83" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* TCLAP::ArgException::what </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const throw ()<code> [inline, inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the arg id and error text. </p> <p>Definition at line <a class="el" href="_arg_exception_8h_source.html#l00079">79</a> of file <a class="el" href="_arg_exception_8h_source.html">ArgException.h</a>.</p> <p>References <a class="el" href="_arg_exception_8h_source.html#l00106">TCLAP::ArgException::_argId</a>, and <a class="el" href="_arg_exception_8h_source.html#l00101">TCLAP::ArgException::_errorText</a>.</p> <p>Referenced by <a class="el" href="_doc_book_output_8h_source.html#l00191">TCLAP::DocBookOutput::failure()</a>.</p> </div> </div> </div> <br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>