1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tclap: TCLAP::ArgParseException Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">tclap
 <span id="projectnumber">1.2.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceTCLAP.html">TCLAP</a></li><li class="navelem"><a class="el" href="classTCLAP_1_1ArgParseException.html">ArgParseException</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classTCLAP_1_1ArgParseException-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">TCLAP::ArgParseException Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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="classTCLAP_1_1ArgParseException.html#details">More...</a></p>
<p><code>#include <<a class="el" href="ArgException_8h_source.html">ArgException.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for TCLAP::ArgParseException:</div>
<div class="dyncontent">
<div class="center"><img src="classTCLAP_1_1ArgParseException__inherit__graph.png" border="0" usemap="#aTCLAP_1_1ArgParseException_inherit__map" alt="Inheritance graph"/></div>
<map name="aTCLAP_1_1ArgParseException_inherit__map" id="aTCLAP_1_1ArgParseException_inherit__map">
<area shape="rect" title="Thrown from within the child Arg classes when it fails to properly parse the argument it has been pas..." alt="" coords="5,155,191,181"/>
<area shape="rect" href="classTCLAP_1_1ArgException.html" title="A simple class that defines and argument exception." alt="" coords="23,80,173,107"/>
<area shape="rect" title=" " alt="" coords="46,5,150,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for TCLAP::ArgParseException:</div>
<div class="dyncontent">
<div class="center"><img src="classTCLAP_1_1ArgParseException__coll__graph.png" border="0" usemap="#aTCLAP_1_1ArgParseException_coll__map" alt="Collaboration graph"/></div>
<map name="aTCLAP_1_1ArgParseException_coll__map" id="aTCLAP_1_1ArgParseException_coll__map">
<area shape="rect" title="Thrown from within the child Arg classes when it fails to properly parse the argument it has been pas..." alt="" coords="5,155,191,181"/>
<area shape="rect" href="classTCLAP_1_1ArgException.html" title="A simple class that defines and argument exception." alt="" coords="23,80,173,107"/>
<area shape="rect" title=" " alt="" coords="46,5,150,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa9d9531405e505afd506491526733285"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgParseException.html#aa9d9531405e505afd506491526733285">ArgParseException</a> (const std::string &text="undefined exception", const std::string &id="undefined")</td></tr>
<tr class="memdesc:aa9d9531405e505afd506491526733285"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classTCLAP_1_1ArgParseException.html#aa9d9531405e505afd506491526733285">More...</a><br /></td></tr>
<tr class="separator:aa9d9531405e505afd506491526733285"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classTCLAP_1_1ArgException"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classTCLAP_1_1ArgException')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classTCLAP_1_1ArgException.html">TCLAP::ArgException</a></td></tr>
<tr class="memitem:a67389912b628e95d530f8bb8de97b309 inherit pub_methods_classTCLAP_1_1ArgException"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgException.html#a67389912b628e95d530f8bb8de97b309">ArgException</a> (const std::string &text="undefined exception", const std::string &id="undefined", const std::string &td="Generic <a class="el" href="classTCLAP_1_1ArgException.html">ArgException</a>")</td></tr>
<tr class="memdesc:a67389912b628e95d530f8bb8de97b309 inherit pub_methods_classTCLAP_1_1ArgException"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classTCLAP_1_1ArgException.html#a67389912b628e95d530f8bb8de97b309">More...</a><br /></td></tr>
<tr class="separator:a67389912b628e95d530f8bb8de97b309 inherit pub_methods_classTCLAP_1_1ArgException"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c5df6a814b05c623a01607fb82980f4 inherit pub_methods_classTCLAP_1_1ArgException"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgException.html#a5c5df6a814b05c623a01607fb82980f4">~ArgException</a> () throw ()</td></tr>
<tr class="memdesc:a5c5df6a814b05c623a01607fb82980f4 inherit pub_methods_classTCLAP_1_1ArgException"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classTCLAP_1_1ArgException.html#a5c5df6a814b05c623a01607fb82980f4">More...</a><br /></td></tr>
<tr class="separator:a5c5df6a814b05c623a01607fb82980f4 inherit pub_methods_classTCLAP_1_1ArgException"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada4c6840a3cd9ab6134cf7108fead7cb inherit pub_methods_classTCLAP_1_1ArgException"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgException.html#ada4c6840a3cd9ab6134cf7108fead7cb">error</a> () const</td></tr>
<tr class="memdesc:ada4c6840a3cd9ab6134cf7108fead7cb inherit pub_methods_classTCLAP_1_1ArgException"><td class="mdescLeft"> </td><td class="mdescRight">Returns the error text. <a href="classTCLAP_1_1ArgException.html#ada4c6840a3cd9ab6134cf7108fead7cb">More...</a><br /></td></tr>
<tr class="separator:ada4c6840a3cd9ab6134cf7108fead7cb inherit pub_methods_classTCLAP_1_1ArgException"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad68c9451dc93dbc1541bf5c6650aa33c inherit pub_methods_classTCLAP_1_1ArgException"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgException.html#ad68c9451dc93dbc1541bf5c6650aa33c">argId</a> () const</td></tr>
<tr class="memdesc:ad68c9451dc93dbc1541bf5c6650aa33c inherit pub_methods_classTCLAP_1_1ArgException"><td class="mdescLeft"> </td><td class="mdescRight">Returns the argument id. <a href="classTCLAP_1_1ArgException.html#ad68c9451dc93dbc1541bf5c6650aa33c">More...</a><br /></td></tr>
<tr class="separator:ad68c9451dc93dbc1541bf5c6650aa33c inherit pub_methods_classTCLAP_1_1ArgException"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9094aa058cf1dc246a9e657353433c3e inherit pub_methods_classTCLAP_1_1ArgException"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgException.html#a9094aa058cf1dc246a9e657353433c3e">what</a> () const throw ()</td></tr>
<tr class="memdesc:a9094aa058cf1dc246a9e657353433c3e inherit pub_methods_classTCLAP_1_1ArgException"><td class="mdescLeft"> </td><td class="mdescRight">Returns the arg id and error text. <a href="classTCLAP_1_1ArgException.html#a9094aa058cf1dc246a9e657353433c3e">More...</a><br /></td></tr>
<tr class="separator:a9094aa058cf1dc246a9e657353433c3e inherit pub_methods_classTCLAP_1_1ArgException"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d741e0af36d049cb4f1fae71600ef9f inherit pub_methods_classTCLAP_1_1ArgException"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgException.html#a9d741e0af36d049cb4f1fae71600ef9f">typeDescription</a> () const</td></tr>
<tr class="memdesc:a9d741e0af36d049cb4f1fae71600ef9f inherit pub_methods_classTCLAP_1_1ArgException"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of the exception. <a href="classTCLAP_1_1ArgException.html#a9d741e0af36d049cb4f1fae71600ef9f">More...</a><br /></td></tr>
<tr class="separator:a9d741e0af36d049cb4f1fae71600ef9f inherit pub_methods_classTCLAP_1_1ArgException"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><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 class="definition">Definition at line <a class="el" href="ArgException_8h_source.html#l00122">122</a> of file <a class="el" href="ArgException_8h_source.html">ArgException.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aa9d9531405e505afd506491526733285"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9d9531405e505afd506491526733285">◆ </a></span>ArgParseException()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TCLAP::ArgParseException::ArgParseException </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>text</em> = <code>"undefined exception"</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>id</em> = <code>"undefined"</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</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 class="definition">Definition at line <a class="el" href="ArgException_8h_source.html#l00131">131</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><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
