<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>HelpVisitor.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">HelpVisitor.h</div> </div>
</div>
<div class="contents">
<a href="_help_visitor_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="_cmd_line_interface_8h.html">mrpt/otherlibs/tclap/CmdLineInterface.h</a>></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <<a class="code" href="_cmd_line_output_8h.html">mrpt/otherlibs/tclap/CmdLineOutput.h</a>></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="_visitor_8h.html">mrpt/otherlibs/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 <span class="comment"></span>
<a name="l00031"></a>00031 <span class="comment">/**</span>
<a name="l00032"></a>00032 <span class="comment"> * A Visitor object that calls the usage method of the given CmdLineOutput</span>
<a name="l00033"></a>00033 <span class="comment"> * object for the specified CmdLine object.</span>
<a name="l00034"></a>00034 <span class="comment"> */</span>
<a name="l00035"></a>00035 <span class="keyword">class </span>HelpVisitor: <span class="keyword">public</span> Visitor
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="keyword">protected</span>:
<a name="l00038"></a>00038 <span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment"> /**</span>
<a name="l00040"></a>00040 <span class="comment"> * The CmdLine the output will be generated for. </span>
<a name="l00041"></a>00041 <span class="comment"> */</span>
<a name="l00042"></a><a class="code" href="class_t_c_l_a_p_1_1_help_visitor.html#afc7e0402f4e09ab6eff91680ea87ea57">00042</a> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line_interface.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLineInterface</a>* <a class="code" href="class_t_c_l_a_p_1_1_help_visitor.html#afc7e0402f4e09ab6eff91680ea87ea57" title="The CmdLine the output will be generated for.">_cmd</a>;
<a name="l00043"></a>00043 <span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment"> /**</span>
<a name="l00045"></a>00045 <span class="comment"> * The output object. </span>
<a name="l00046"></a>00046 <span class="comment"> */</span>
<a name="l00047"></a><a class="code" href="class_t_c_l_a_p_1_1_help_visitor.html#ae12c2d2208b64377a6360fb335454877">00047</a> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line_output.html" title="The interface that any output object must implement.">CmdLineOutput</a>** <a class="code" href="class_t_c_l_a_p_1_1_help_visitor.html#ae12c2d2208b64377a6360fb335454877" title="The output object.">_out</a>;
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /**</span>
<a name="l00052"></a>00052 <span class="comment"> * Constructor.</span>
<a name="l00053"></a>00053 <span class="comment"> * \param cmd - The CmdLine the output will be generated for.</span>
<a name="l00054"></a>00054 <span class="comment"> * \param out - The type of output. </span>
<a name="l00055"></a>00055 <span class="comment"> */</span>
<a name="l00056"></a><a class="code" href="class_t_c_l_a_p_1_1_help_visitor.html#a425e96efa6950b1949f1f81d4ff133f1">00056</a> <a class="code" href="class_t_c_l_a_p_1_1_help_visitor.html#a425e96efa6950b1949f1f81d4ff133f1" title="Constructor.">HelpVisitor</a>(<a class="code" href="class_t_c_l_a_p_1_1_cmd_line_interface.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLineInterface</a>* cmd, <a class="code" href="class_t_c_l_a_p_1_1_cmd_line_output.html" title="The interface that any output object must implement.">CmdLineOutput</a>** out)
<a name="l00057"></a>00057 : <a class="code" href="class_t_c_l_a_p_1_1_visitor.html" title="A base class that defines the interface for visitors.">Visitor</a>(), <a class="code" href="class_t_c_l_a_p_1_1_help_visitor.html#afc7e0402f4e09ab6eff91680ea87ea57" title="The CmdLine the output will be generated for.">_cmd</a>( cmd ), <a class="code" href="class_t_c_l_a_p_1_1_help_visitor.html#ae12c2d2208b64377a6360fb335454877" title="The output object.">_out</a>( out ) { }
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> /**</span>
<a name="l00060"></a>00060 <span class="comment"> * Calls the usage method of the CmdLineOutput for the </span>
<a name="l00061"></a>00061 <span class="comment"> * specified CmdLine.</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a><a class="code" href="class_t_c_l_a_p_1_1_help_visitor.html#a157294efe254edb2b713b7c458aad3f2">00063</a> <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_help_visitor.html#a157294efe254edb2b713b7c458aad3f2" title="Calls the usage method of the CmdLineOutput for the specified CmdLine.">visit</a>() { (*_out)->usage(*<a class="code" href="class_t_c_l_a_p_1_1_help_visitor.html#afc7e0402f4e09ab6eff91680ea87ea57" title="The CmdLine the output will be generated for.">_cmd</a>); <span class="keywordflow">throw</span> <a class="code" href="class_t_c_l_a_p_1_1_action_done_exception.html" title="(Added by JLBC for MRPT): An exception that indicates to CmdLine::parse that help,version,...">ActionDoneException</a>(); }
<a name="l00064"></a>00064
<a name="l00065"></a>00065 };
<a name="l00066"></a>00066
<a name="l00067"></a>00067 }
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
