<!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>The MRPT project: 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.6.2-20100208 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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="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">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespace_t_c_l_a_p.html">TCLAP</a>::<a class="el" href="class_t_c_l_a_p_1_1_help_visitor.html">HelpVisitor</a>
</div>
</div>
<div class="contents">
<h1>TCLAP::HelpVisitor Class Reference</h1><!-- doxytag: class="TCLAP::HelpVisitor" --><!-- doxytag: inherits="TCLAP::Visitor" -->
<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...">CmdLine</a> object.
<a href="#_details">More...</a></p>
<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="dynsection">
<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="19,5,128,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for TCLAP::HelpVisitor:</div>
<div class="dynsection">
<div class="center"><img src="class_t_c_l_a_p_1_1_help_visitor__coll__graph.png" border="0" usemap="#_t_c_l_a_p_1_1_help_visitor_coll__map" alt="Collaboration graph"/></div>
<map name="_t_c_l_a_p_1_1_help_visitor_coll__map" id="_t_c_l_a_p_1_1_help_visitor_coll__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="5,5,115,35"/><area shape="rect" id="node4" href="class_t_c_l_a_p_1_1_cmd_line_output.html" title="The interface that any output object must implement." alt="" coords="139,5,301,35"/><area shape="rect" id="node6" 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..." alt="" coords="325,5,501,35"/></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 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"> </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...">CmdLine</a>. <a href="#a157294efe254edb2b713b7c458aad3f2"></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="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...">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/><a name="_details"></a><h2>Detailed Description</h2>
<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...">CmdLine</a> object. </p>
<p>Definition at line <a class="el" href="_help_visitor_8h_source.html#l00035">35</a> of file <a class="el" href="_help_visitor_8h_source.html">HelpVisitor.h</a>.</p>
<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><td> </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> </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...">CmdLine</a> the output will be generated for. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out</em> </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...">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...">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>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.6.2-20100208</a> for MRPT 0.9.0 SVN: at Wed Jul 14 12:48:09 UTC 2010</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
