File: classTCLAP_1_1Visitor.html

package info (click to toggle)
tclap 1.2.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 10,584 kB
  • sloc: cpp: 3,724; xml: 1,028; sh: 855; makefile: 308; javascript: 214; ansic: 43
file content (188 lines) | stat: -rw-r--r-- 9,534 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
 
<!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::Visitor 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_1Visitor.html">Visitor</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classTCLAP_1_1Visitor-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">TCLAP::Visitor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>A base class that defines the interface for visitors.  
 <a href="classTCLAP_1_1Visitor.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="Visitor_8h_source.html">Visitor.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for TCLAP::Visitor:</div>
<div class="dyncontent">
<div class="center"><img src="classTCLAP_1_1Visitor__inherit__graph.png" border="0" usemap="#aTCLAP_1_1Visitor_inherit__map" alt="Inheritance graph"/></div>
<map name="aTCLAP_1_1Visitor_inherit__map" id="aTCLAP_1_1Visitor_inherit__map">
<area shape="rect" title="A base class that defines the interface for visitors." alt="" coords="199,5,309,32"/>
<area shape="rect" href="classTCLAP_1_1HelpVisitor.html" title="A Visitor object that calls the usage method of the given CmdLineOutput object for the specified CmdL..." alt="" coords="5,80,143,107"/>
<area shape="rect" href="classTCLAP_1_1IgnoreRestVisitor.html" title="A Visitor that tells the CmdLine to begin ignoring arguments after this one is parsed." alt="" coords="167,80,341,107"/>
<area shape="rect" href="classTCLAP_1_1VersionVisitor.html" title="A Visitor that will call the version method of the given CmdLineOutput for the specified CmdLine obje..." alt="" coords="366,80,521,107"/>
</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:a0d7198eaa0989abe3898ffd59dff7801"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace7cbebaab5dfc0ba1f17cd360dd6a55"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a175c37e1cdaf8da483b90480995c4158"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1Visitor.html#a175c37e1cdaf8da483b90480995c4158">visit</a> ()=0</td></tr>
<tr class="memdesc:a175c37e1cdaf8da483b90480995c4158"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method (to implemented by children) will be called when the visitor is visited.  <a href="classTCLAP_1_1Visitor.html#a175c37e1cdaf8da483b90480995c4158">More...</a><br /></td></tr>
<tr class="separator:a175c37e1cdaf8da483b90480995c4158"><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 base class that defines the interface for visitors. </p>

<p class="definition">Definition at line <a class="el" href="Visitor_8h_source.html#l00034">34</a> of file <a class="el" href="Visitor_8h_source.html">Visitor.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0d7198eaa0989abe3898ffd59dff7801"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d7198eaa0989abe3898ffd59dff7801">&#9670;&nbsp;</a></span>Visitor()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">TCLAP::Visitor::Visitor </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>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor. </p>
<p>Does nothing. </p>

<p class="definition">Definition at line <a class="el" href="Visitor_8h_source.html#l00041">41</a> of file <a class="el" href="Visitor_8h_source.html">Visitor.h</a>.</p>

</div>
</div>
<a id="ace7cbebaab5dfc0ba1f17cd360dd6a55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace7cbebaab5dfc0ba1f17cd360dd6a55">&#9670;&nbsp;</a></span>~Visitor()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual TCLAP::Visitor::~Visitor </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>Destructor. </p>
<p>Does nothing. </p>

<p class="definition">Definition at line <a class="el" href="Visitor_8h_source.html#l00046">46</a> of file <a class="el" href="Visitor_8h_source.html">Visitor.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a175c37e1cdaf8da483b90480995c4158"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a175c37e1cdaf8da483b90480995c4158">&#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">virtual void TCLAP::Visitor::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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This method (to implemented by children) will be called when the visitor is visited. </p>

<p>Implemented in <a class="el" href="classTCLAP_1_1VersionVisitor.html#a30b0d5bd22ac41364d027b94bded4fc0">TCLAP::VersionVisitor</a>, <a class="el" href="classTCLAP_1_1IgnoreRestVisitor.html#ac2a054ed72b16608a32021c65a600722">TCLAP::IgnoreRestVisitor</a>, and <a class="el" href="classTCLAP_1_1HelpVisitor.html#a157294efe254edb2b713b7c458aad3f2">TCLAP::HelpVisitor</a>.</p>

<p class="reference">Referenced by <a class="el" href="Arg_8h_source.html#l00602">TCLAP::Arg::_checkWithVisitor()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Visitor_8h_source.html">Visitor.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>