summaryrefslogtreecommitdiff
path: root/tclap-1.2.1/docs/html/classTCLAP_1_1VersionVisitor.html
blob: fa4464e933c08bcbf9d67748556f346a841b1222 (plain)
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
<!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::VersionVisitor 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_1VersionVisitor.html">VersionVisitor</a>
  </div>
</div>
<div class="contents">
<h1>TCLAP::VersionVisitor Class Reference</h1><!-- doxytag: class="TCLAP::VersionVisitor" --><!-- doxytag: inherits="TCLAP::Visitor" -->
<p>A Vistor 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...">CmdLine</a> object and then exit.  
<a href="#_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="dynsection">
 <div class="center">
  <img src="classTCLAP_1_1VersionVisitor.gif" usemap="#TCLAP::VersionVisitor_map" alt=""/>
  <map id="TCLAP::VersionVisitor_map" name="TCLAP::VersionVisitor_map">
<area href="classTCLAP_1_1Visitor.html" alt="TCLAP::Visitor" shape="rect" coords="0,0,138,24"/>
</map>
 </div>
</div>

<p><a href="classTCLAP_1_1VersionVisitor-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_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><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#a6e5c16f245e2333dcc568dc9c4e6d537"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1VersionVisitor.html#a30b0d5bd22ac41364d027b94bded4fc0">visit</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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...">CmdLine</a>.  <a href="#a30b0d5bd22ac41364d027b94bded4fc0"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1VersionVisitor.html#ac789d900e73daa8b4b53a1e9b80b756e">_cmd</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</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...">CmdLine</a> of interest.  <a href="#ac789d900e73daa8b4b53a1e9b80b756e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTCLAP_1_1CmdLineOutput.html">CmdLineOutput</a> **&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1VersionVisitor.html#ab4c9f44a2bd62830e42f79b35ac4d300">_out</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The output object.  <a href="#ab4c9f44a2bd62830e42f79b35ac4d300"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A Vistor 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...">CmdLine</a> object and then exit. </p>

<p>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>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a6e5c16f245e2333dcc568dc9c4e6d537"></a><!-- doxytag: member="TCLAP::VersionVisitor::VersionVisitor" ref="a6e5c16f245e2333dcc568dc9c4e6d537" args="(CmdLineInterface *cmd, CmdLineOutput **out)" -->
<div class="memitem">
<div class="memproto">
      <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> *&nbsp;</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> **&nbsp;</td>
          <td class="paramname"> <em>out</em></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>cmd</em>&nbsp;</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...">CmdLine</a> the output is generated for. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>out</em>&nbsp;</td><td>- The type of output. </td></tr>
  </table>
  </dd>
</dl>

<p>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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a30b0d5bd22ac41364d027b94bded4fc0"></a><!-- doxytag: member="TCLAP::VersionVisitor::visit" ref="a30b0d5bd22ac41364d027b94bded4fc0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void TCLAP::VersionVisitor::visit </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></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...">CmdLine</a>. </p>

<p>Reimplemented from <a class="el" href="classTCLAP_1_1Visitor.html#a08625664637579a24ba2f0ab3e713670">TCLAP::Visitor</a>.</p>

<p>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>References <a class="el" href="VersionVisitor_8h_source.html#l00051">_cmd</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ac789d900e73daa8b4b53a1e9b80b756e"></a><!-- doxytag: member="TCLAP::VersionVisitor::_cmd" ref="ac789d900e73daa8b4b53a1e9b80b756e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a>* <a class="el" href="classTCLAP_1_1VersionVisitor.html#ac789d900e73daa8b4b53a1e9b80b756e">TCLAP::VersionVisitor::_cmd</a><code> [protected]</code></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...">CmdLine</a> of interest. </p>

<p>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>Referenced by <a class="el" href="VersionVisitor_8h_source.html#l00072">visit()</a>.</p>

</div>
</div>
<a class="anchor" id="ab4c9f44a2bd62830e42f79b35ac4d300"></a><!-- doxytag: member="TCLAP::VersionVisitor::_out" ref="ab4c9f44a2bd62830e42f79b35ac4d300" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTCLAP_1_1CmdLineOutput.html">CmdLineOutput</a>** <a class="el" href="classTCLAP_1_1VersionVisitor.html#ab4c9f44a2bd62830e42f79b35ac4d300">TCLAP::VersionVisitor::_out</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The output object. </p>

<p>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>
<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>