threed-beam-fea/ext/tclap-1.2.1/docs/html/classTCLAP_1_1ArgParseExcep...

154 lines
7.0 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
<title>tclap: TCLAP::ArgParseException Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.0 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceTCLAP.html">TCLAP</a>::<a class="el"
href="classTCLAP_1_1ArgParseException.html">ArgParseException</a>
</div>
</div>
<div class="contents">
<h1>TCLAP::ArgParseException Class Reference</h1><!-- doxytag: class="TCLAP::ArgParseException" -->
<!-- doxytag: inherits="TCLAP::ArgException" -->
<p>Thrown from within the child <a class="el" href="classTCLAP_1_1Arg.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.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ArgException_8h_source.html">ArgException.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for TCLAP::ArgParseException:
</div>
<div class="dynsection">
<div class="center">
<img src="classTCLAP_1_1ArgParseException.gif" usemap="#TCLAP::ArgParseException_map" alt=""/>
<map id="TCLAP::ArgParseException_map" name="TCLAP::ArgParseException_map">
<area href="classTCLAP_1_1ArgException.html" alt="TCLAP::ArgException" shape="rect"
coords="0,0,167,24"/>
</map>
</div>
</div>
<p><a href="classTCLAP_1_1ArgParseException-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td colspan="2"><h2>Public Member Functions</h2></td>
</tr>
<tr>
<td class="memItemLeft" align="right" valign="top">&nbsp;</td>
<td class="memItemRight" valign="bottom"><a class="el"
href="classTCLAP_1_1ArgParseException.html#aa9d9531405e505afd506491526733285">ArgParseException</a>
(const std::string &amp;text=&quot;undefined exception&quot;, const std::string &amp;id=&quot;undefined&quot;)
</td>
</tr>
<tr>
<td class="mdescLeft">&nbsp;</td>
<td class="mdescRight">Constructor. <a href="#aa9d9531405e505afd506491526733285"></a><br/></td>
</tr>
</table>
<hr/>
<a name="_details"></a>
<h2>Detailed Description</h2>
<p>Thrown from within the child <a class="el" href="classTCLAP_1_1Arg.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>
<p>Definition at line <a class="el" href="ArgException_8h_source.html#l00121">121</a> of file <a class="el"
href="ArgException_8h_source.html">ArgException.h</a>.
</p>
<hr/>
<h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa9d9531405e505afd506491526733285"></a><!-- doxytag: member="TCLAP::ArgParseException::ArgParseException" ref="aa9d9531405e505afd506491526733285" args="(const std::string &amp;text=&quot;undefined exception&quot;, const std::string &amp;id=&quot;undefined&quot;)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TCLAP::ArgParseException::ArgParseException</td>
<td>(</td>
<td class="paramtype">const std::string &amp;&nbsp;</td>
<td class="paramname"><em>text</em> = <code>&quot;undefined&nbsp;exception&quot;</code>,</td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&nbsp;</td>
<td class="paramname"><em>id</em> = <code>&quot;undefined&quot;</code></td>
<td>&nbsp;</td>
</tr>
<tr>
<td></td>
<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 border="0" cellspacing="2" cellpadding="0">
<tr>
<td valign="top"></td>
<td valign="top"><em>text</em>&nbsp;</td>
<td>- The text of the exception.</td>
</tr>
<tr>
<td valign="top"></td>
<td valign="top"><em>id</em>&nbsp;</td>
<td>- The text identifying the argument source of the exception.</td>
</tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ArgException_8h_source.html#l00130">130</a> of file <a class="el"
href="ArgException_8h_source.html">ArgException.h</a>.
</p>
</div>
</div>
<hr/>
The documentation for this class was generated from the following file:
<ul>
<li><a class="el" href="ArgException_8h_source.html">ArgException.h</a></li>
</ul>
</div>
<hr size="1"/>
<address style="text-align: right;">
<small>Generated on Sat Apr 16 15:34:25 2011 for tclap by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.0
</small>
</address>
</body>
</html>