86 lines
8.5 KiB
HTML
86 lines
8.5 KiB
HTML
<!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: HelpVisitor.h Source File</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 Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<h1>HelpVisitor.h</h1><a href="HelpVisitor_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
|
|
<a name="l00002"></a>00002 <span class="comment">/****************************************************************************** </span>
|
|
<a name="l00003"></a>00003 <span class="comment"> * </span>
|
|
<a name="l00004"></a>00004 <span class="comment"> * file: HelpVisitor.h</span>
|
|
<a name="l00005"></a>00005 <span class="comment"> * </span>
|
|
<a name="l00006"></a>00006 <span class="comment"> * Copyright (c) 2003, Michael E. Smoot .</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> * All rights reverved.</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> * </span>
|
|
<a name="l00009"></a>00009 <span class="comment"> * See the file COPYING in the top directory of this distribution for</span>
|
|
<a name="l00010"></a>00010 <span class="comment"> * more information.</span>
|
|
<a name="l00011"></a>00011 <span class="comment"> * </span>
|
|
<a name="l00012"></a>00012 <span class="comment"> * THE SOFTWARE IS PROVIDED _AS IS_, WITHOUT WARRANTY OF ANY KIND, EXPRESS </span>
|
|
<a name="l00013"></a>00013 <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, </span>
|
|
<a name="l00014"></a>00014 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL </span>
|
|
<a name="l00015"></a>00015 <span class="comment"> * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER </span>
|
|
<a name="l00016"></a>00016 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING </span>
|
|
<a name="l00017"></a>00017 <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER </span>
|
|
<a name="l00018"></a>00018 <span class="comment"> * DEALINGS IN THE SOFTWARE. </span>
|
|
<a name="l00019"></a>00019 <span class="comment"> * </span>
|
|
<a name="l00020"></a>00020 <span class="comment"> *****************************************************************************/</span>
|
|
<a name="l00021"></a>00021
|
|
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef TCLAP_HELP_VISITOR_H</span>
|
|
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define TCLAP_HELP_VISITOR_H</span>
|
|
<a name="l00024"></a>00024 <span class="preprocessor"></span>
|
|
<a name="l00025"></a>00025 <span class="preprocessor">#include <<a class="code" href="CmdLineInterface_8h.html">tclap/CmdLineInterface.h</a>></span>
|
|
<a name="l00026"></a>00026 <span class="preprocessor">#include <<a class="code" href="CmdLineOutput_8h.html">tclap/CmdLineOutput.h</a>></span>
|
|
<a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="Visitor_8h.html">tclap/Visitor.h</a>></span>
|
|
<a name="l00028"></a>00028
|
|
<a name="l00029"></a>00029 <span class="keyword">namespace </span>TCLAP {
|
|
<a name="l00030"></a>00030
|
|
<a name="l00035"></a><a class="code" href="classTCLAP_1_1HelpVisitor.html">00035</a> <span class="keyword">class </span><a class="code" href="classTCLAP_1_1HelpVisitor.html" title="A Visitor object that calls the usage method of the given CmdLineOutput object for...">HelpVisitor</a>: <span class="keyword">public</span> <a class="code" href="classTCLAP_1_1Visitor.html" title="A base class that defines the interface for visitors.">Visitor</a>
|
|
<a name="l00036"></a>00036 {
|
|
<a name="l00037"></a>00037 <span class="keyword">private</span>:
|
|
<a name="l00041"></a>00041 <a class="code" href="classTCLAP_1_1HelpVisitor.html" title="A Visitor object that calls the usage method of the given CmdLineOutput object for...">HelpVisitor</a>(<span class="keyword">const</span> <a class="code" href="classTCLAP_1_1HelpVisitor.html" title="A Visitor object that calls the usage method of the given CmdLineOutput object for...">HelpVisitor</a>& rhs);
|
|
<a name="l00042"></a>00042 <a class="code" href="classTCLAP_1_1HelpVisitor.html" title="A Visitor object that calls the usage method of the given CmdLineOutput object for...">HelpVisitor</a>& operator=(<span class="keyword">const</span> <a class="code" href="classTCLAP_1_1HelpVisitor.html" title="A Visitor object that calls the usage method of the given CmdLineOutput object for...">HelpVisitor</a>& rhs);
|
|
<a name="l00043"></a>00043
|
|
<a name="l00044"></a>00044 <span class="keyword">protected</span>:
|
|
<a name="l00045"></a>00045
|
|
<a name="l00049"></a><a class="code" href="classTCLAP_1_1HelpVisitor.html#afc7e0402f4e09ab6eff91680ea87ea57">00049</a> <a class="code" href="classTCLAP_1_1CmdLineInterface.html" title="The base class that manages the command line definition and passes along the parsing...">CmdLineInterface</a>* <a class="code" href="classTCLAP_1_1HelpVisitor.html#afc7e0402f4e09ab6eff91680ea87ea57" title="The CmdLine the output will be generated for.">_cmd</a>;
|
|
<a name="l00050"></a>00050
|
|
<a name="l00054"></a><a class="code" href="classTCLAP_1_1HelpVisitor.html#ae12c2d2208b64377a6360fb335454877">00054</a> <a class="code" href="classTCLAP_1_1CmdLineOutput.html" title="The interface that any output object must implement.">CmdLineOutput</a>** <a class="code" href="classTCLAP_1_1HelpVisitor.html#ae12c2d2208b64377a6360fb335454877" title="The output object.">_out</a>;
|
|
<a name="l00055"></a>00055
|
|
<a name="l00056"></a>00056 <span class="keyword">public</span>:
|
|
<a name="l00057"></a>00057
|
|
<a name="l00063"></a><a class="code" href="classTCLAP_1_1HelpVisitor.html#a425e96efa6950b1949f1f81d4ff133f1">00063</a> <a class="code" href="classTCLAP_1_1HelpVisitor.html" title="A Visitor object that calls the usage method of the given CmdLineOutput object for...">HelpVisitor</a>(<a class="code" href="classTCLAP_1_1CmdLineInterface.html" title="The base class that manages the command line definition and passes along the parsing...">CmdLineInterface</a>* cmd, <a class="code" href="classTCLAP_1_1CmdLineOutput.html" title="The interface that any output object must implement.">CmdLineOutput</a>** out)
|
|
<a name="l00064"></a>00064 : <a class="code" href="classTCLAP_1_1Visitor.html" title="A base class that defines the interface for visitors.">Visitor</a>(), <a class="code" href="classTCLAP_1_1HelpVisitor.html#afc7e0402f4e09ab6eff91680ea87ea57" title="The CmdLine the output will be generated for.">_cmd</a>( cmd ), <a class="code" href="classTCLAP_1_1HelpVisitor.html#ae12c2d2208b64377a6360fb335454877" title="The output object.">_out</a>( out ) { }
|
|
<a name="l00065"></a>00065
|
|
<a name="l00070"></a><a class="code" href="classTCLAP_1_1HelpVisitor.html#a157294efe254edb2b713b7c458aad3f2">00070</a> <span class="keywordtype">void</span> <a class="code" href="classTCLAP_1_1HelpVisitor.html#a157294efe254edb2b713b7c458aad3f2" title="Calls the usage method of the CmdLineOutput for the specified CmdLine.">visit</a>() { (*_out)->usage(*<a class="code" href="classTCLAP_1_1HelpVisitor.html#afc7e0402f4e09ab6eff91680ea87ea57" title="The CmdLine the output will be generated for.">_cmd</a>); <span class="keywordflow">throw</span> <a class="code" href="classTCLAP_1_1ExitException.html">ExitException</a>(0); }
|
|
<a name="l00071"></a>00071
|
|
<a name="l00072"></a>00072 };
|
|
<a name="l00073"></a>00073
|
|
<a name="l00074"></a>00074 }
|
|
<a name="l00075"></a>00075
|
|
<a name="l00076"></a>00076 <span class="preprocessor">#endif</span>
|
|
</pre></div></div>
|
|
<hr size="1"/><address style="text-align: right;"><small>Generated on Sat Apr 16 15:34:24 2011 for tclap by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.0 </small></address>
|
|
</body>
|
|
</html>
|