File: classTCLAP_1_1VersionVisitor.html

package info (click to toggle)
tclap 1.2.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, experimental, sid, trixie
  • size: 10,584 kB
  • sloc: cpp: 3,724; xml: 1,028; sh: 855; makefile: 308; javascript: 214; ansic: 43
file content (255 lines) | stat: -rw-r--r-- 16,672 bytes parent folder | download
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
<!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::VersionVisitor 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
   &#160;<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&amp;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_1VersionVisitor.html">VersionVisitor</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classTCLAP_1_1VersionVisitor-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">TCLAP::VersionVisitor Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A <a class="el" href="classTCLAP_1_1Visitor.html" title="A base class that defines the interface for visitors.">Visitor</a> that will call the version method of the given <a class="el" href="classTCLAP_1_1CmdLineOutput.html" title="The interface that any output object must implement.">CmdLineOutput</a> for the specified <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 and then exit.  
 <a href="classTCLAP_1_1VersionVisitor.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="VersionVisitor_8h_source.html">VersionVisitor.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for TCLAP::VersionVisitor:</div>
<div class="dyncontent">
<div class="center"><img src="classTCLAP_1_1VersionVisitor__inherit__graph.png" border="0" usemap="#aTCLAP_1_1VersionVisitor_inherit__map" alt="Inheritance graph"/></div>
<map name="aTCLAP_1_1VersionVisitor_inherit__map" id="aTCLAP_1_1VersionVisitor_inherit__map">
<area shape="rect" title="A Visitor that will call the version method of the given CmdLineOutput for the specified CmdLine obje..." alt="" coords="5,80,160,107"/>
<area shape="rect" href="classTCLAP_1_1Visitor.html" title="A base class that defines the interface for visitors." alt="" coords="27,5,138,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for TCLAP::VersionVisitor:</div>
<div class="dyncontent">
<div class="center"><img src="classTCLAP_1_1VersionVisitor__coll__graph.png" border="0" usemap="#aTCLAP_1_1VersionVisitor_coll__map" alt="Collaboration graph"/></div>
<map name="aTCLAP_1_1VersionVisitor_coll__map" id="aTCLAP_1_1VersionVisitor_coll__map">
<area shape="rect" title="A Visitor that will call the version method of the given CmdLineOutput for the specified CmdLine obje..." alt="" coords="145,95,299,121"/>
<area shape="rect" href="classTCLAP_1_1Visitor.html" title="A base class that defines the interface for visitors." alt="" coords="5,5,116,32"/>
<area shape="rect" href="classTCLAP_1_1CmdLineOutput.html" title="The interface that any output object must implement." alt="" coords="140,5,304,32"/>
<area shape="rect" href="classTCLAP_1_1CmdLineInterface.html" title="The base class that manages the command line definition and passes along the parsing to the appropria..." alt="" coords="329,5,505,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:a6e5c16f245e2333dcc568dc9c4e6d537"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1VersionVisitor.html#a6e5c16f245e2333dcc568dc9c4e6d537">VersionVisitor</a> (<a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> *cmd, <a class="el" href="classTCLAP_1_1CmdLineOutput.html">CmdLineOutput</a> **out)</td></tr>
<tr class="memdesc:a6e5c16f245e2333dcc568dc9c4e6d537"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="classTCLAP_1_1VersionVisitor.html#a6e5c16f245e2333dcc568dc9c4e6d537">More...</a><br /></td></tr>
<tr class="separator:a6e5c16f245e2333dcc568dc9c4e6d537"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30b0d5bd22ac41364d027b94bded4fc0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1VersionVisitor.html#a30b0d5bd22ac41364d027b94bded4fc0">visit</a> ()</td></tr>
<tr class="memdesc:a30b0d5bd22ac41364d027b94bded4fc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calls the version method of the output object using the specified <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>.  <a href="classTCLAP_1_1VersionVisitor.html#a30b0d5bd22ac41364d027b94bded4fc0">More...</a><br /></td></tr>
<tr class="separator:a30b0d5bd22ac41364d027b94bded4fc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classTCLAP_1_1Visitor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classTCLAP_1_1Visitor')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classTCLAP_1_1Visitor.html">TCLAP::Visitor</a></td></tr>
<tr class="memitem:a0d7198eaa0989abe3898ffd59dff7801 inherit pub_methods_classTCLAP_1_1Visitor"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1Visitor.html#a0d7198eaa0989abe3898ffd59dff7801">Visitor</a> ()</td></tr>
<tr class="memdesc:a0d7198eaa0989abe3898ffd59dff7801 inherit pub_methods_classTCLAP_1_1Visitor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="classTCLAP_1_1Visitor.html#a0d7198eaa0989abe3898ffd59dff7801">More...</a><br /></td></tr>
<tr class="separator:a0d7198eaa0989abe3898ffd59dff7801 inherit pub_methods_classTCLAP_1_1Visitor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace7cbebaab5dfc0ba1f17cd360dd6a55 inherit pub_methods_classTCLAP_1_1Visitor"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1Visitor.html#ace7cbebaab5dfc0ba1f17cd360dd6a55">~Visitor</a> ()</td></tr>
<tr class="memdesc:ace7cbebaab5dfc0ba1f17cd360dd6a55 inherit pub_methods_classTCLAP_1_1Visitor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="classTCLAP_1_1Visitor.html#ace7cbebaab5dfc0ba1f17cd360dd6a55">More...</a><br /></td></tr>
<tr class="separator:ace7cbebaab5dfc0ba1f17cd360dd6a55 inherit pub_methods_classTCLAP_1_1Visitor"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ac789d900e73daa8b4b53a1e9b80b756e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1VersionVisitor.html#ac789d900e73daa8b4b53a1e9b80b756e">_cmd</a></td></tr>
<tr class="memdesc:ac789d900e73daa8b4b53a1e9b80b756e"><td class="mdescLeft">&#160;</td><td class="mdescRight">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> of interest.  <a href="classTCLAP_1_1VersionVisitor.html#ac789d900e73daa8b4b53a1e9b80b756e">More...</a><br /></td></tr>
<tr class="separator:ac789d900e73daa8b4b53a1e9b80b756e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4c9f44a2bd62830e42f79b35ac4d300"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTCLAP_1_1CmdLineOutput.html">CmdLineOutput</a> **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1VersionVisitor.html#ab4c9f44a2bd62830e42f79b35ac4d300">_out</a></td></tr>
<tr class="memdesc:ab4c9f44a2bd62830e42f79b35ac4d300"><td class="mdescLeft">&#160;</td><td class="mdescRight">The output object.  <a href="classTCLAP_1_1VersionVisitor.html#ab4c9f44a2bd62830e42f79b35ac4d300">More...</a><br /></td></tr>
<tr class="separator:ab4c9f44a2bd62830e42f79b35ac4d300"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A <a class="el" href="classTCLAP_1_1Visitor.html" title="A base class that defines the interface for visitors.">Visitor</a> that will call the version method of the given <a class="el" href="classTCLAP_1_1CmdLineOutput.html" title="The interface that any output object must implement.">CmdLineOutput</a> for the specified <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 and then exit. </p>

<p class="definition">Definition at line <a class="el" href="VersionVisitor_8h_source.html#l00037">37</a> of file <a class="el" href="VersionVisitor_8h_source.html">VersionVisitor.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6e5c16f245e2333dcc568dc9c4e6d537"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e5c16f245e2333dcc568dc9c4e6d537">&#9670;&nbsp;</a></span>VersionVisitor()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">TCLAP::VersionVisitor::VersionVisitor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> *&#160;</td>
          <td class="paramname"><em>cmd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classTCLAP_1_1CmdLineOutput.html">CmdLineOutput</a> **&#160;</td>
          <td class="paramname"><em>out</em>&#160;</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">cmd</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> the output is generated for. </td></tr>
    <tr><td class="paramname">out</td><td>- The type of output. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="VersionVisitor_8h_source.html#l00065">65</a> of file <a class="el" href="VersionVisitor_8h_source.html">VersionVisitor.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a30b0d5bd22ac41364d027b94bded4fc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30b0d5bd22ac41364d027b94bded4fc0">&#9670;&nbsp;</a></span>visit()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void TCLAP::VersionVisitor::visit </td>
          <td>(</td>
          <td class="paramname"></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>Calls the version method of the output object using the specified <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>. </p>

<p>Implements <a class="el" href="classTCLAP_1_1Visitor.html#a175c37e1cdaf8da483b90480995c4158">TCLAP::Visitor</a>.</p>

<p class="definition">Definition at line <a class="el" href="VersionVisitor_8h_source.html#l00072">72</a> of file <a class="el" href="VersionVisitor_8h_source.html">VersionVisitor.h</a>.</p>

<p class="reference">References <a class="el" href="VersionVisitor_8h_source.html#l00051">_cmd</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac789d900e73daa8b4b53a1e9b80b756e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac789d900e73daa8b4b53a1e9b80b756e">&#9670;&nbsp;</a></span>_cmd</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a>* TCLAP::VersionVisitor::_cmd</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>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> of interest. </p>

<p class="definition">Definition at line <a class="el" href="VersionVisitor_8h_source.html#l00051">51</a> of file <a class="el" href="VersionVisitor_8h_source.html">VersionVisitor.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="VersionVisitor_8h_source.html#l00072">visit()</a>.</p>

</div>
</div>
<a id="ab4c9f44a2bd62830e42f79b35ac4d300"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4c9f44a2bd62830e42f79b35ac4d300">&#9670;&nbsp;</a></span>_out</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTCLAP_1_1CmdLineOutput.html">CmdLineOutput</a>** TCLAP::VersionVisitor::_out</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The output object. </p>

<p class="definition">Definition at line <a class="el" href="VersionVisitor_8h_source.html#l00056">56</a> of file <a class="el" href="VersionVisitor_8h_source.html">VersionVisitor.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="VersionVisitor_8h_source.html">VersionVisitor.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>