<!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::CmdLineOutput 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.2 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div 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 id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span 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>
</span><span class="right"></span>
</div>
</li>
</ul>
</div>
<div 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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespace_t_c_l_a_p.html">TCLAP</a> </li>
<li><a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html">CmdLineOutput</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>TCLAP::CmdLineOutput Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="TCLAP::CmdLineOutput" --><hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The interface that any output object must implement. </p>
<p>Definition at line <a class="el" href="_cmd_line_output_8h_source.html#l00041">41</a> of file <a class="el" href="_cmd_line_output_8h_source.html">CmdLineOutput.h</a>.</p>
<p><code>#include <<a class="el" href="_cmd_line_output_8h_source.html">mrpt/otherlibs/tclap/CmdLineOutput.h</a>></code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for TCLAP::CmdLineOutput:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="class_t_c_l_a_p_1_1_cmd_line_output__inherit__graph.png" border="0" usemap="#_t_c_l_a_p_1_1_cmd_line_output_inherit__map" alt="Inheritance graph"/></div>
<map name="_t_c_l_a_p_1_1_cmd_line_output_inherit__map" id="_t_c_l_a_p_1_1_cmd_line_output_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
<p><a href="class_t_c_l_a_p_1_1_cmd_line_output-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html#afdf4435a2619076d9798a0a950ed405b">~CmdLineOutput</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#afdf4435a2619076d9798a0a950ed405b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html#a685b13db5bf6bbe5159e49169cd96bbe">usage</a> (<a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html">CmdLineInterface</a> &c)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generates some sort of output for the USAGE. <a href="#a685b13db5bf6bbe5159e49169cd96bbe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html#ae052fea473132482296de55edb3dd480">version</a> (<a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html">CmdLineInterface</a> &c)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generates some sort of output for the version. <a href="#ae052fea473132482296de55edb3dd480"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html#ad23a57ac3d8d957a4328fc78aec94e16">failure</a> (<a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html">CmdLineInterface</a> &c, <a class="el" href="class_t_c_l_a_p_1_1_arg_exception.html">ArgException</a> &e)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generates some sort of output for a failure. <a href="#ad23a57ac3d8d957a4328fc78aec94e16"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="afdf4435a2619076d9798a0a950ed405b"></a><!-- doxytag: member="TCLAP::CmdLineOutput::~CmdLineOutput" ref="afdf4435a2619076d9798a0a950ed405b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual TCLAP::CmdLineOutput::~CmdLineOutput </td>
<td>(</td>
<td class="paramname"> )</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Virtual destructor. </p>
<p>Definition at line <a class="el" href="_cmd_line_output_8h_source.html#l00049">49</a> of file <a class="el" href="_cmd_line_output_8h_source.html">CmdLineOutput.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad23a57ac3d8d957a4328fc78aec94e16"></a><!-- doxytag: member="TCLAP::CmdLineOutput::failure" ref="ad23a57ac3d8d957a4328fc78aec94e16" args="(CmdLineInterface &c, ArgException &e)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void TCLAP::CmdLineOutput::failure </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>c</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_arg_exception.html">ArgException</a> & </td>
<td class="paramname"> <em>e</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Generates some sort of output for a failure. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c</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> object the output is generated for. </td></tr>
<tr><td class="paramname">e</td><td>- The <a class="el" href="class_t_c_l_a_p_1_1_arg_exception.html" title="A simple class that defines and argument exception.">ArgException</a> that caused the failure. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="class_t_c_l_a_p_1_1_doc_book_output.html#a5e97f659fa1ab3b060a31e8bd7a0a40e">TCLAP::DocBookOutput</a>, and <a class="el" href="class_t_c_l_a_p_1_1_std_output.html#a9afc267e012c3ac42c8b1afe01f98556">TCLAP::StdOutput</a>.</p>
</div>
</div>
<a class="anchor" id="a685b13db5bf6bbe5159e49169cd96bbe"></a><!-- doxytag: member="TCLAP::CmdLineOutput::usage" ref="a685b13db5bf6bbe5159e49169cd96bbe" args="(CmdLineInterface &c)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void TCLAP::CmdLineOutput::usage </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>c</em> )</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Generates some sort of output for the USAGE. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c</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> object the output is generated for. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="class_t_c_l_a_p_1_1_doc_book_output.html#adc1ec93f3f7e5e912690be01c5e7d6e2">TCLAP::DocBookOutput</a>, and <a class="el" href="class_t_c_l_a_p_1_1_std_output.html#aeb10eb400e0ee45f2cde689bef606b49">TCLAP::StdOutput</a>.</p>
</div>
</div>
<a class="anchor" id="ae052fea473132482296de55edb3dd480"></a><!-- doxytag: member="TCLAP::CmdLineOutput::version" ref="ae052fea473132482296de55edb3dd480" args="(CmdLineInterface &c)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void TCLAP::CmdLineOutput::version </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>c</em> )</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Generates some sort of output for the version. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c</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> object the output is generated for. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="class_t_c_l_a_p_1_1_doc_book_output.html#a3ccf7671dcae82aba5f0e91850ae25a4">TCLAP::DocBookOutput</a>, and <a class="el" href="class_t_c_l_a_p_1_1_std_output.html#a768111a59af4753ac6e5ace3ec99482e">TCLAP::StdOutput</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.2</a> for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
