<!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>TCLAP::HelpVisitor Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_t_c_l_a_p.html">TCLAP</a> </li>
<li class="navelem"><a class="el" href="class_t_c_l_a_p_1_1_help_visitor.html">HelpVisitor</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">TCLAP::HelpVisitor Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="TCLAP::HelpVisitor" --><!-- doxytag: inherits="TCLAP::Visitor" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A <a class="el" href="class_t_c_l_a_p_1_1_visitor.html" title="A base class that defines the interface for visitors.">Visitor</a> object that calls the usage method of the given <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html" title="The interface that any output object must implement.">CmdLineOutput</a> object for the specified <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a> object. </p>
</div>
<p><code>#include <<a class="el" href="_help_visitor_8h_source.html">mrpt/otherlibs/tclap/HelpVisitor.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for TCLAP::HelpVisitor:</div>
<div class="dyncontent">
<div class="center"><img src="class_t_c_l_a_p_1_1_help_visitor__inherit__graph.png" border="0" usemap="#_t_c_l_a_p_1_1_help_visitor_inherit__map" alt="Inheritance graph"/></div>
<map name="_t_c_l_a_p_1_1_help_visitor_inherit__map" id="_t_c_l_a_p_1_1_help_visitor_inherit__map">
<area shape="rect" id="node2" href="class_t_c_l_a_p_1_1_visitor.html" title="A base class that defines the interface for visitors." alt="" coords="18,5,128,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_t_c_l_a_p_1_1_help_visitor-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_help_visitor.html#a425e96efa6950b1949f1f81d4ff133f1">HelpVisitor</a> (<a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html">CmdLineInterface</a> *cmd, <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html">CmdLineOutput</a> **out)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a425e96efa6950b1949f1f81d4ff133f1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_help_visitor.html#a157294efe254edb2b713b7c458aad3f2">visit</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calls the usage method of the <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html" title="The interface that any output object must implement.">CmdLineOutput</a> for the specified <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a>. <a href="#a157294efe254edb2b713b7c458aad3f2"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html">CmdLineInterface</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_help_visitor.html#afc7e0402f4e09ab6eff91680ea87ea57">_cmd</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a> the output will be generated for. <a href="#afc7e0402f4e09ab6eff91680ea87ea57"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html">CmdLineOutput</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_help_visitor.html#ae12c2d2208b64377a6360fb335454877">_out</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The output object. <a href="#ae12c2d2208b64377a6360fb335454877"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a425e96efa6950b1949f1f81d4ff133f1"></a><!-- doxytag: member="TCLAP::HelpVisitor::HelpVisitor" ref="a425e96efa6950b1949f1f81d4ff133f1" args="(CmdLineInterface *cmd, CmdLineOutput **out)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TCLAP::HelpVisitor::HelpVisitor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html">CmdLineInterface</a> * </td>
<td class="paramname"><em>cmd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html">CmdLineOutput</a> ** </td>
<td class="paramname"><em>out</em> </td>
</tr>
<tr>
<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 class="params">
<tr><td class="paramname">cmd</td><td>- The <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a> the output will be generated for. </td></tr>
<tr><td class="paramname">out</td><td>- The type of output. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_help_visitor_8h_source.html#l00056">56</a> of file <a class="el" href="_help_visitor_8h_source.html">HelpVisitor.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a157294efe254edb2b713b7c458aad3f2"></a><!-- doxytag: member="TCLAP::HelpVisitor::visit" ref="a157294efe254edb2b713b7c458aad3f2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::HelpVisitor::visit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Calls the usage method of the <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html" title="The interface that any output object must implement.">CmdLineOutput</a> for the specified <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a>. </p>
<p>Reimplemented from <a class="el" href="class_t_c_l_a_p_1_1_visitor.html#a08625664637579a24ba2f0ab3e713670">TCLAP::Visitor</a>.</p>
<p>Definition at line <a class="el" href="_help_visitor_8h_source.html#l00063">63</a> of file <a class="el" href="_help_visitor_8h_source.html">HelpVisitor.h</a>.</p>
<p>References <a class="el" href="_help_visitor_8h_source.html#l00042">_cmd</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="afc7e0402f4e09ab6eff91680ea87ea57"></a><!-- doxytag: member="TCLAP::HelpVisitor::_cmd" ref="afc7e0402f4e09ab6eff91680ea87ea57" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html">CmdLineInterface</a>* <a class="el" href="class_t_c_l_a_p_1_1_help_visitor.html#afc7e0402f4e09ab6eff91680ea87ea57">TCLAP::HelpVisitor::_cmd</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html" title="The base class that manages the command line definition and passes along the parsing to the appropria...">CmdLine</a> the output will be generated for. </p>
<p>Definition at line <a class="el" href="_help_visitor_8h_source.html#l00042">42</a> of file <a class="el" href="_help_visitor_8h_source.html">HelpVisitor.h</a>.</p>
<p>Referenced by <a class="el" href="_help_visitor_8h_source.html#l00063">visit()</a>.</p>
</div>
</div>
<a class="anchor" id="ae12c2d2208b64377a6360fb335454877"></a><!-- doxytag: member="TCLAP::HelpVisitor::_out" ref="ae12c2d2208b64377a6360fb335454877" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html">CmdLineOutput</a>** <a class="el" href="class_t_c_l_a_p_1_1_help_visitor.html#ae12c2d2208b64377a6360fb335454877">TCLAP::HelpVisitor::_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="_help_visitor_8h_source.html#l00047">47</a> of file <a class="el" href="_help_visitor_8h_source.html">HelpVisitor.h</a>.</p>
</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>
