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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
|
<!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::StdOutput 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_1StdOutput.html">StdOutput</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classTCLAP_1_1StdOutput-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">TCLAP::StdOutput Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class that isolates any output from the <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a> object so that it may be easily modified.
<a href="classTCLAP_1_1StdOutput.html#details">More...</a></p>
<p><code>#include <<a class="el" href="StdOutput_8h_source.html">StdOutput.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for TCLAP::StdOutput:</div>
<div class="dyncontent">
<div class="center"><img src="classTCLAP_1_1StdOutput__inherit__graph.png" border="0" usemap="#aTCLAP_1_1StdOutput_inherit__map" alt="Inheritance graph"/></div>
<map name="aTCLAP_1_1StdOutput_inherit__map" id="aTCLAP_1_1StdOutput_inherit__map">
<area shape="rect" title="A class that isolates any output from the CmdLine object so that it may be easily modified." alt="" coords="21,80,153,107"/>
<area shape="rect" href="classTCLAP_1_1CmdLineOutput.html" title="The interface that any output object must implement." alt="" coords="5,5,169,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for TCLAP::StdOutput:</div>
<div class="dyncontent">
<div class="center"><img src="classTCLAP_1_1StdOutput__coll__graph.png" border="0" usemap="#aTCLAP_1_1StdOutput_coll__map" alt="Collaboration graph"/></div>
<map name="aTCLAP_1_1StdOutput_coll__map" id="aTCLAP_1_1StdOutput_coll__map">
<area shape="rect" title="A class that isolates any output from the CmdLine object so that it may be easily modified." alt="" coords="21,80,153,107"/>
<area shape="rect" href="classTCLAP_1_1CmdLineOutput.html" title="The interface that any output object must implement." alt="" coords="5,5,169,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:aeb10eb400e0ee45f2cde689bef606b49"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1StdOutput.html#aeb10eb400e0ee45f2cde689bef606b49">usage</a> (<a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> &c)</td></tr>
<tr class="memdesc:aeb10eb400e0ee45f2cde689bef606b49"><td class="mdescLeft"> </td><td class="mdescRight">Prints the usage to stdout. <a href="classTCLAP_1_1StdOutput.html#aeb10eb400e0ee45f2cde689bef606b49">More...</a><br /></td></tr>
<tr class="separator:aeb10eb400e0ee45f2cde689bef606b49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a768111a59af4753ac6e5ace3ec99482e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1StdOutput.html#a768111a59af4753ac6e5ace3ec99482e">version</a> (<a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> &c)</td></tr>
<tr class="memdesc:a768111a59af4753ac6e5ace3ec99482e"><td class="mdescLeft"> </td><td class="mdescRight">Prints the version to stdout. <a href="classTCLAP_1_1StdOutput.html#a768111a59af4753ac6e5ace3ec99482e">More...</a><br /></td></tr>
<tr class="separator:a768111a59af4753ac6e5ace3ec99482e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9afc267e012c3ac42c8b1afe01f98556"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1StdOutput.html#a9afc267e012c3ac42c8b1afe01f98556">failure</a> (<a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> &c, <a class="el" href="classTCLAP_1_1ArgException.html">ArgException</a> &e)</td></tr>
<tr class="memdesc:a9afc267e012c3ac42c8b1afe01f98556"><td class="mdescLeft"> </td><td class="mdescRight">Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior. <a href="classTCLAP_1_1StdOutput.html#a9afc267e012c3ac42c8b1afe01f98556">More...</a><br /></td></tr>
<tr class="separator:a9afc267e012c3ac42c8b1afe01f98556"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classTCLAP_1_1CmdLineOutput"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classTCLAP_1_1CmdLineOutput')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classTCLAP_1_1CmdLineOutput.html">TCLAP::CmdLineOutput</a></td></tr>
<tr class="memitem:afdf4435a2619076d9798a0a950ed405b inherit pub_methods_classTCLAP_1_1CmdLineOutput"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1CmdLineOutput.html#afdf4435a2619076d9798a0a950ed405b">~CmdLineOutput</a> ()</td></tr>
<tr class="memdesc:afdf4435a2619076d9798a0a950ed405b inherit pub_methods_classTCLAP_1_1CmdLineOutput"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="classTCLAP_1_1CmdLineOutput.html#afdf4435a2619076d9798a0a950ed405b">More...</a><br /></td></tr>
<tr class="separator:afdf4435a2619076d9798a0a950ed405b inherit pub_methods_classTCLAP_1_1CmdLineOutput"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aabbb4a2c1fbd700a7d65d64c40db9d01"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1StdOutput.html#aabbb4a2c1fbd700a7d65d64c40db9d01">_shortUsage</a> (<a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> &c, std::ostream &os) const</td></tr>
<tr class="memdesc:aabbb4a2c1fbd700a7d65d64c40db9d01"><td class="mdescLeft"> </td><td class="mdescRight">Writes a brief usage message with short args. <a href="classTCLAP_1_1StdOutput.html#aabbb4a2c1fbd700a7d65d64c40db9d01">More...</a><br /></td></tr>
<tr class="separator:aabbb4a2c1fbd700a7d65d64c40db9d01"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe16284c27561d8bbb77c2665b5909fc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1StdOutput.html#abe16284c27561d8bbb77c2665b5909fc">_longUsage</a> (<a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> &c, std::ostream &os) const</td></tr>
<tr class="memdesc:abe16284c27561d8bbb77c2665b5909fc"><td class="mdescLeft"> </td><td class="mdescRight">Writes a longer usage message with long and short args, provides descriptions and prints message. <a href="classTCLAP_1_1StdOutput.html#abe16284c27561d8bbb77c2665b5909fc">More...</a><br /></td></tr>
<tr class="separator:abe16284c27561d8bbb77c2665b5909fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a197b3dfda80fa823e21d7c90186e0318"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1StdOutput.html#a197b3dfda80fa823e21d7c90186e0318">spacePrint</a> (std::ostream &os, const std::string &s, int maxWidth, int indentSpaces, int secondLineOffset) const</td></tr>
<tr class="memdesc:a197b3dfda80fa823e21d7c90186e0318"><td class="mdescLeft"> </td><td class="mdescRight">This function inserts line breaks and indents long strings according the params input. <a href="classTCLAP_1_1StdOutput.html#a197b3dfda80fa823e21d7c90186e0318">More...</a><br /></td></tr>
<tr class="separator:a197b3dfda80fa823e21d7c90186e0318"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class that isolates any output from the <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a> object so that it may be easily modified. </p>
<p class="definition">Definition at line <a class="el" href="StdOutput_8h_source.html#l00044">44</a> of file <a class="el" href="StdOutput_8h_source.html">StdOutput.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="abe16284c27561d8bbb77c2665b5909fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe16284c27561d8bbb77c2665b5909fc">◆ </a></span>_longUsage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void TCLAP::StdOutput::_longUsage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> & </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>os</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a longer usage message with long and short args, provides descriptions and prints message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>- The <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a> object the output is generated for. </td></tr>
<tr><td class="paramname">os</td><td>- The stream to write the message to. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="StdOutput_8h_source.html#l00193">193</a> of file <a class="el" href="StdOutput_8h_source.html">StdOutput.h</a>.</p>
<p class="reference">References <a class="el" href="XorHandler_8h_source.html#l00143">TCLAP::XorHandler::contains()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a4de8d988f5a6f3007c4dfb0fc9dad476">TCLAP::CmdLineInterface::getArgList()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a30175a2567f7ab78a2c6bbea9269a2fa">TCLAP::CmdLineInterface::getMessage()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a11ce9c77a1111960741f05e343849e4e">TCLAP::CmdLineInterface::getXorHandler()</a>, <a class="el" href="XorHandler_8h_source.html#l00155">TCLAP::XorHandler::getXorList()</a>, and <a class="el" href="StdOutput_8h_source.html#l00231">spacePrint()</a>.</p>
<p class="reference">Referenced by <a class="el" href="StdOutput_8h_source.html#l00118">usage()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classTCLAP_1_1StdOutput_abe16284c27561d8bbb77c2665b5909fc_cgraph.png" border="0" usemap="#aclassTCLAP_1_1StdOutput_abe16284c27561d8bbb77c2665b5909fc_cgraph" alt=""/></div>
<map name="aclassTCLAP_1_1StdOutput_abe16284c27561d8bbb77c2665b5909fc_cgraph" id="aclassTCLAP_1_1StdOutput_abe16284c27561d8bbb77c2665b5909fc_cgraph">
<area shape="rect" title="Writes a longer usage message with long and short args, provides descriptions and prints message." alt="" coords="5,169,145,211"/>
<area shape="rect" href="classTCLAP_1_1XorHandler.html#a1a74fab4667cc591a1e3094c91bc942d" title="Simply checks whether the Arg is contained in one of the arg lists." alt="" coords="221,5,368,47"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a4de8d988f5a6f3007c4dfb0fc9dad476" title="Returns the argList." alt="" coords="207,71,383,112"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a30175a2567f7ab78a2c6bbea9269a2fa" title="Returns the message string." alt="" coords="207,136,383,177"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a11ce9c77a1111960741f05e343849e4e" title="Returns the XorHandler." alt="" coords="207,201,383,243"/>
<area shape="rect" href="classTCLAP_1_1XorHandler.html#a6b25b05b817a5c8cea137eb032cba7de" title=" " alt="" coords="221,267,368,308"/>
<area shape="rect" href="classTCLAP_1_1StdOutput.html#a197b3dfda80fa823e21d7c90186e0318" title="This function inserts line breaks and indents long strings according the params input." alt="" coords="193,333,396,359"/>
</map>
</div>
</div>
</div>
<a id="aabbb4a2c1fbd700a7d65d64c40db9d01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabbb4a2c1fbd700a7d65d64c40db9d01">◆ </a></span>_shortUsage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void TCLAP::StdOutput::_shortUsage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> & </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>os</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a brief usage message with short args. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>- The <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a> object the output is generated for. </td></tr>
<tr><td class="paramname">os</td><td>- The stream to write the message to. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="StdOutput_8h_source.html#l00158">158</a> of file <a class="el" href="StdOutput_8h_source.html">StdOutput.h</a>.</p>
<p class="reference">References <a class="el" href="XorHandler_8h_source.html#l00143">TCLAP::XorHandler::contains()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a4de8d988f5a6f3007c4dfb0fc9dad476">TCLAP::CmdLineInterface::getArgList()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a1a5672df72a6b5021cd70b37c4dbd0a7">TCLAP::CmdLineInterface::getProgramName()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a11ce9c77a1111960741f05e343849e4e">TCLAP::CmdLineInterface::getXorHandler()</a>, <a class="el" href="XorHandler_8h_source.html#l00155">TCLAP::XorHandler::getXorList()</a>, and <a class="el" href="StdOutput_8h_source.html#l00231">spacePrint()</a>.</p>
<p class="reference">Referenced by <a class="el" href="StdOutput_8h_source.html#l00132">failure()</a>, and <a class="el" href="StdOutput_8h_source.html#l00118">usage()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classTCLAP_1_1StdOutput_aabbb4a2c1fbd700a7d65d64c40db9d01_cgraph.png" border="0" usemap="#aclassTCLAP_1_1StdOutput_aabbb4a2c1fbd700a7d65d64c40db9d01_cgraph" alt=""/></div>
<map name="aclassTCLAP_1_1StdOutput_aabbb4a2c1fbd700a7d65d64c40db9d01_cgraph" id="aclassTCLAP_1_1StdOutput_aabbb4a2c1fbd700a7d65d64c40db9d01_cgraph">
<area shape="rect" title="Writes a brief usage message with short args." alt="" coords="5,169,145,211"/>
<area shape="rect" href="classTCLAP_1_1XorHandler.html#a1a74fab4667cc591a1e3094c91bc942d" title="Simply checks whether the Arg is contained in one of the arg lists." alt="" coords="221,5,368,47"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a4de8d988f5a6f3007c4dfb0fc9dad476" title="Returns the argList." alt="" coords="207,71,383,112"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a1a5672df72a6b5021cd70b37c4dbd0a7" title="Returns the program name string." alt="" coords="207,136,383,177"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a11ce9c77a1111960741f05e343849e4e" title="Returns the XorHandler." alt="" coords="207,201,383,243"/>
<area shape="rect" href="classTCLAP_1_1XorHandler.html#a6b25b05b817a5c8cea137eb032cba7de" title=" " alt="" coords="221,267,368,308"/>
<area shape="rect" href="classTCLAP_1_1StdOutput.html#a197b3dfda80fa823e21d7c90186e0318" title="This function inserts line breaks and indents long strings according the params input." alt="" coords="193,333,396,359"/>
</map>
</div>
</div>
</div>
<a id="a9afc267e012c3ac42c8b1afe01f98556"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9afc267e012c3ac42c8b1afe01f98556">◆ </a></span>failure()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void TCLAP::StdOutput::failure </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> & </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTCLAP_1_1ArgException.html">ArgException</a> & </td>
<td class="paramname"><em>e</em> </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 class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>- The <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a> object the output is generated for. </td></tr>
<tr><td class="paramname">e</td><td>- The <a class="el" href="classTCLAP_1_1ArgException.html" title="A simple class that defines and argument exception.">ArgException</a> that caused the failure. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classTCLAP_1_1CmdLineOutput.html#ad23a57ac3d8d957a4328fc78aec94e16">TCLAP::CmdLineOutput</a>.</p>
<p class="definition">Definition at line <a class="el" href="StdOutput_8h_source.html#l00132">132</a> of file <a class="el" href="StdOutput_8h_source.html">StdOutput.h</a>.</p>
<p class="reference">References <a class="el" href="StdOutput_8h_source.html#l00158">_shortUsage()</a>, <a class="el" href="ArgException_8h_source.html#l00070">TCLAP::ArgException::argId()</a>, <a class="el" href="ArgException_8h_source.html#l00065">TCLAP::ArgException::error()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a1a5672df72a6b5021cd70b37c4dbd0a7">TCLAP::CmdLineInterface::getProgramName()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a441b06b764836a62083b163508210905">TCLAP::CmdLineInterface::hasHelpAndVersion()</a>, <a class="el" href="Arg_8h_source.html#l00236">TCLAP::Arg::nameStartString()</a>, and <a class="el" href="StdOutput_8h_source.html#l00118">usage()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classTCLAP_1_1StdOutput_a9afc267e012c3ac42c8b1afe01f98556_cgraph.png" border="0" usemap="#aclassTCLAP_1_1StdOutput_a9afc267e012c3ac42c8b1afe01f98556_cgraph" alt=""/></div>
<map name="aclassTCLAP_1_1StdOutput_a9afc267e012c3ac42c8b1afe01f98556_cgraph" id="aclassTCLAP_1_1StdOutput_a9afc267e012c3ac42c8b1afe01f98556_cgraph">
<area shape="rect" title="Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior." alt="" coords="5,399,180,426"/>
<area shape="rect" href="classTCLAP_1_1StdOutput.html#aabbb4a2c1fbd700a7d65d64c40db9d01" title="Writes a brief usage message with short args." alt="" coords="471,253,611,295"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a1a5672df72a6b5021cd70b37c4dbd0a7" title="Returns the program name string." alt="" coords="672,384,848,425"/>
<area shape="rect" href="classTCLAP_1_1ArgException.html#ad68c9451dc93dbc1541bf5c6650aa33c" title="Returns the argument id." alt="" coords="250,392,401,433"/>
<area shape="rect" href="classTCLAP_1_1ArgException.html#ada4c6840a3cd9ab6134cf7108fead7cb" title="Returns the error text." alt="" coords="250,457,401,499"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a441b06b764836a62083b163508210905" title="Indicates whether or not the help and version switches were created automatically." alt="" coords="237,523,413,564"/>
<area shape="rect" href="classTCLAP_1_1Arg.html#a1df2134870528b80f9f35347fef6fd14" title=" " alt="" coords="228,589,423,615"/>
<area shape="rect" href="classTCLAP_1_1StdOutput.html#aeb10eb400e0ee45f2cde689bef606b49" title="Prints the usage to stdout." alt="" coords="238,239,413,266"/>
<area shape="rect" href="classTCLAP_1_1XorHandler.html#a1a74fab4667cc591a1e3094c91bc942d" title="Simply checks whether the Arg is contained in one of the arg lists." alt="" coords="687,188,833,229"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a4de8d988f5a6f3007c4dfb0fc9dad476" title="Returns the argList." alt="" coords="672,253,848,295"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a11ce9c77a1111960741f05e343849e4e" title="Returns the XorHandler." alt="" coords="672,319,848,360"/>
<area shape="rect" href="classTCLAP_1_1XorHandler.html#a6b25b05b817a5c8cea137eb032cba7de" title=" " alt="" coords="687,71,833,112"/>
<area shape="rect" href="classTCLAP_1_1StdOutput.html#a197b3dfda80fa823e21d7c90186e0318" title="This function inserts line breaks and indents long strings according the params input." alt="" coords="659,137,861,163"/>
<area shape="rect" href="classTCLAP_1_1StdOutput.html#abe16284c27561d8bbb77c2665b5909fc" title="Writes a longer usage message with long and short args, provides descriptions and prints message." alt="" coords="471,188,611,229"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a30175a2567f7ab78a2c6bbea9269a2fa" title="Returns the message string." alt="" coords="672,5,848,47"/>
</map>
</div>
</div>
</div>
<a id="a197b3dfda80fa823e21d7c90186e0318"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a197b3dfda80fa823e21d7c90186e0318">◆ </a></span>spacePrint()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void TCLAP::StdOutput::spacePrint </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>maxWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>indentSpaces</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>secondLineOffset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This function inserts line breaks and indents long strings according the params input. </p>
<p>It will only break lines at spaces, commas and pipes. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">os</td><td>- The stream to be printed to. </td></tr>
<tr><td class="paramname">s</td><td>- The string to be printed. </td></tr>
<tr><td class="paramname">maxWidth</td><td>- The maxWidth allowed for the output line. </td></tr>
<tr><td class="paramname">indentSpaces</td><td>- The number of spaces to indent the first line. </td></tr>
<tr><td class="paramname">secondLineOffset</td><td>- The number of spaces to indent the second and all subsequent lines in addition to indentSpaces. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="StdOutput_8h_source.html#l00231">231</a> of file <a class="el" href="StdOutput_8h_source.html">StdOutput.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="StdOutput_8h_source.html#l00193">_longUsage()</a>, and <a class="el" href="StdOutput_8h_source.html#l00158">_shortUsage()</a>.</p>
</div>
</div>
<a id="aeb10eb400e0ee45f2cde689bef606b49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb10eb400e0ee45f2cde689bef606b49">◆ </a></span>usage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void TCLAP::StdOutput::usage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> & </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints the usage to stdout. </p>
<p>Can be overridden to produce alternative behavior. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>- The <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a> object the output is generated for. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classTCLAP_1_1CmdLineOutput.html#a685b13db5bf6bbe5159e49169cd96bbe">TCLAP::CmdLineOutput</a>.</p>
<p class="definition">Definition at line <a class="el" href="StdOutput_8h_source.html#l00118">118</a> of file <a class="el" href="StdOutput_8h_source.html">StdOutput.h</a>.</p>
<p class="reference">References <a class="el" href="StdOutput_8h_source.html#l00193">_longUsage()</a>, and <a class="el" href="StdOutput_8h_source.html#l00158">_shortUsage()</a>.</p>
<p class="reference">Referenced by <a class="el" href="StdOutput_8h_source.html#l00132">failure()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classTCLAP_1_1StdOutput_aeb10eb400e0ee45f2cde689bef606b49_cgraph.png" border="0" usemap="#aclassTCLAP_1_1StdOutput_aeb10eb400e0ee45f2cde689bef606b49_cgraph" alt=""/></div>
<map name="aclassTCLAP_1_1StdOutput_aeb10eb400e0ee45f2cde689bef606b49_cgraph" id="aclassTCLAP_1_1StdOutput_aeb10eb400e0ee45f2cde689bef606b49_cgraph">
<area shape="rect" title="Prints the usage to stdout." alt="" coords="5,199,180,226"/>
<area shape="rect" href="classTCLAP_1_1StdOutput.html#abe16284c27561d8bbb77c2665b5909fc" title="Writes a longer usage message with long and short args, provides descriptions and prints message." alt="" coords="228,224,368,265"/>
<area shape="rect" href="classTCLAP_1_1StdOutput.html#aabbb4a2c1fbd700a7d65d64c40db9d01" title="Writes a brief usage message with short args." alt="" coords="228,159,368,200"/>
<area shape="rect" href="classTCLAP_1_1XorHandler.html#a1a74fab4667cc591a1e3094c91bc942d" title="Simply checks whether the Arg is contained in one of the arg lists." alt="" coords="444,188,591,229"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a4de8d988f5a6f3007c4dfb0fc9dad476" title="Returns the argList." alt="" coords="429,253,605,295"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a30175a2567f7ab78a2c6bbea9269a2fa" title="Returns the message string." alt="" coords="429,384,605,425"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a11ce9c77a1111960741f05e343849e4e" title="Returns the XorHandler." alt="" coords="429,319,605,360"/>
<area shape="rect" href="classTCLAP_1_1XorHandler.html#a6b25b05b817a5c8cea137eb032cba7de" title=" " alt="" coords="444,71,591,112"/>
<area shape="rect" href="classTCLAP_1_1StdOutput.html#a197b3dfda80fa823e21d7c90186e0318" title="This function inserts line breaks and indents long strings according the params input." alt="" coords="416,137,619,163"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a1a5672df72a6b5021cd70b37c4dbd0a7" title="Returns the program name string." alt="" coords="429,5,605,47"/>
</map>
</div>
</div>
</div>
<a id="a768111a59af4753ac6e5ace3ec99482e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a768111a59af4753ac6e5ace3ec99482e">◆ </a></span>version()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void TCLAP::StdOutput::version </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> & </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints the version to stdout. </p>
<p>Can be overridden to produce alternative behavior. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>- The <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a> object the output is generated for. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classTCLAP_1_1CmdLineOutput.html#ae052fea473132482296de55edb3dd480">TCLAP::CmdLineOutput</a>.</p>
<p class="definition">Definition at line <a class="el" href="StdOutput_8h_source.html#l00109">109</a> of file <a class="el" href="StdOutput_8h_source.html">StdOutput.h</a>.</p>
<p class="reference">References <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a1a5672df72a6b5021cd70b37c4dbd0a7">TCLAP::CmdLineInterface::getProgramName()</a>, and <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a0a552fa57212800dfb8aec84fb07b8bb">TCLAP::CmdLineInterface::getVersion()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classTCLAP_1_1StdOutput_a768111a59af4753ac6e5ace3ec99482e_cgraph.png" border="0" usemap="#aclassTCLAP_1_1StdOutput_a768111a59af4753ac6e5ace3ec99482e_cgraph" alt=""/></div>
<map name="aclassTCLAP_1_1StdOutput_a768111a59af4753ac6e5ace3ec99482e_cgraph" id="aclassTCLAP_1_1StdOutput_a768111a59af4753ac6e5ace3ec99482e_cgraph">
<area shape="rect" title="Prints the version to stdout." alt="" coords="5,46,188,73"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a1a5672df72a6b5021cd70b37c4dbd0a7" title="Returns the program name string." alt="" coords="236,5,412,47"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html#a0a552fa57212800dfb8aec84fb07b8bb" title="Returns the version string." alt="" coords="236,71,412,112"/>
</map>
</div>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="StdOutput_8h_source.html">StdOutput.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>
|
