<!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::DocBookOutput 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_doc_book_output.html">DocBookOutput</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">TCLAP::DocBookOutput Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="TCLAP::DocBookOutput" --><!-- doxytag: inherits="TCLAP::CmdLineOutput" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A class that generates DocBook output for <a class="el" href="class_t_c_l_a_p_1_1_doc_book_output.html#adc1ec93f3f7e5e912690be01c5e7d6e2" title="Prints the usage to stdout.">usage()</a> method for the given <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> and its Args. </p>
</div>
<p><code>#include <<a class="el" href="_doc_book_output_8h_source.html">mrpt/otherlibs/tclap/DocBookOutput.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for TCLAP::DocBookOutput:</div>
<div class="dyncontent">
<div class="center"><img src="class_t_c_l_a_p_1_1_doc_book_output__inherit__graph.png" border="0" usemap="#_t_c_l_a_p_1_1_doc_book_output_inherit__map" alt="Inheritance graph"/></div>
<map name="_t_c_l_a_p_1_1_doc_book_output_inherit__map" id="_t_c_l_a_p_1_1_doc_book_output_inherit__map">
<area shape="rect" id="node2" href="class_t_c_l_a_p_1_1_cmd_line_output.html" title="The interface that any output object must implement." alt="" coords="6,5,169,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_doc_book_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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_doc_book_output.html#adc1ec93f3f7e5e912690be01c5e7d6e2">usage</a> (<a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html">CmdLineInterface</a> &c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints the usage to stdout. <a href="#adc1ec93f3f7e5e912690be01c5e7d6e2"></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_doc_book_output.html#a3ccf7671dcae82aba5f0e91850ae25a4">version</a> (<a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html">CmdLineInterface</a> &c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints the version to stdout. <a href="#a3ccf7671dcae82aba5f0e91850ae25a4"></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_doc_book_output.html#a5e97f659fa1ab3b060a31e8bd7a0a40e">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)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior. <a href="#a5e97f659fa1ab3b060a31e8bd7a0a40e"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></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_doc_book_output.html#a7546eaf3a0effeea1030afb27b4c698f">substituteSpecialChars</a> (<a class="el" href="classstd_1_1string.html">std::string</a> &s, char r, <a class="el" href="classstd_1_1string.html">std::string</a> &x)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Substitutes the char r for string x in string s. <a href="#a7546eaf3a0effeea1030afb27b4c698f"></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_doc_book_output.html#abc059536cb97c49da4e6c5b4a22c6cef">removeChar</a> (<a class="el" href="classstd_1_1string.html">std::string</a> &s, char r)</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_doc_book_output.html#a980ecacfcda0186a76bb6c37a9c33726">printShortArg</a> (<a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> *it)</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_doc_book_output.html#a891cf5ef71592b5261691575c2adad1d">printLongArg</a> (<a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> *it)</td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5e97f659fa1ab3b060a31e8bd7a0a40e"></a><!-- doxytag: member="TCLAP::DocBookOutput::failure" ref="a5e97f659fa1ab3b060a31e8bd7a0a40e" args="(CmdLineInterface &c, ArgException &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::DocBookOutput::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> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior. </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>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html#ad23a57ac3d8d957a4328fc78aec94e16">TCLAP::CmdLineOutput</a>.</p>
<p>Definition at line <a class="el" href="_doc_book_output_8h_source.html#l00191">191</a> of file <a class="el" href="_doc_book_output_8h_source.html">DocBookOutput.h</a>.</p>
<p>References <a class="el" href="_arg_exception_8h_source.html#l00079">TCLAP::ArgException::what()</a>.</p>
</div>
</div>
<a class="anchor" id="a891cf5ef71592b5261691575c2adad1d"></a><!-- doxytag: member="TCLAP::DocBookOutput::printLongArg" ref="a891cf5ef71592b5261691575c2adad1d" args="(Arg *it)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::DocBookOutput::printLongArg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_doc_book_output_8h_source.html#l00245">245</a> of file <a class="el" href="_doc_book_output_8h_source.html">DocBookOutput.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00423">TCLAP::Arg::longID()</a>, <a class="el" href="_doc_book_output_8h_source.html#l00197">substituteSpecialChars()</a>, <a class="el" href="_doc_book_output_8h_source.html#l00209">removeChar()</a>, and <a class="el" href="_arg_8h_source.html#l00454">TCLAP::Arg::getDescription()</a>.</p>
<p>Referenced by <a class="el" href="_doc_book_output_8h_source.html#l00091">usage()</a>.</p>
</div>
</div>
<a class="anchor" id="a980ecacfcda0186a76bb6c37a9c33726"></a><!-- doxytag: member="TCLAP::DocBookOutput::printShortArg" ref="a980ecacfcda0186a76bb6c37a9c33726" args="(Arg *it)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::DocBookOutput::printShortArg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_doc_book_output_8h_source.html#l00218">218</a> of file <a class="el" href="_doc_book_output_8h_source.html">DocBookOutput.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00402">TCLAP::Arg::shortID()</a>, <a class="el" href="_doc_book_output_8h_source.html#l00197">substituteSpecialChars()</a>, <a class="el" href="_doc_book_output_8h_source.html#l00209">removeChar()</a>, <a class="el" href="_arg_8h_source.html#l00471">TCLAP::Arg::isRequired()</a>, and <a class="el" href="_arg_8h_source.html#l00574">TCLAP::Arg::acceptsMultipleValues()</a>.</p>
<p>Referenced by <a class="el" href="_doc_book_output_8h_source.html#l00091">usage()</a>.</p>
</div>
</div>
<a class="anchor" id="abc059536cb97c49da4e6c5b4a22c6cef"></a><!-- doxytag: member="TCLAP::DocBookOutput::removeChar" ref="abc059536cb97c49da4e6c5b4a22c6cef" args="(std::string &s, char r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::DocBookOutput::removeChar </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>r</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_doc_book_output_8h_source.html#l00209">209</a> of file <a class="el" href="_doc_book_output_8h_source.html">DocBookOutput.h</a>.</p>
<p>Referenced by <a class="el" href="_doc_book_output_8h_source.html#l00218">printShortArg()</a>, and <a class="el" href="_doc_book_output_8h_source.html#l00245">printLongArg()</a>.</p>
</div>
</div>
<a class="anchor" id="a7546eaf3a0effeea1030afb27b4c698f"></a><!-- doxytag: member="TCLAP::DocBookOutput::substituteSpecialChars" ref="a7546eaf3a0effeea1030afb27b4c698f" args="(std::string &s, char r, std::string &x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::DocBookOutput::substituteSpecialChars </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>x</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Substitutes the char r for string x in string s. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>- The string to operate on. </td></tr>
<tr><td class="paramname">r</td><td>- The char to replace. </td></tr>
<tr><td class="paramname">x</td><td>- What to replace r with. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_doc_book_output_8h_source.html#l00197">197</a> of file <a class="el" href="_doc_book_output_8h_source.html">DocBookOutput.h</a>.</p>
<p>Referenced by <a class="el" href="_doc_book_output_8h_source.html#l00218">printShortArg()</a>, and <a class="el" href="_doc_book_output_8h_source.html#l00245">printLongArg()</a>.</p>
</div>
</div>
<a class="anchor" id="adc1ec93f3f7e5e912690be01c5e7d6e2"></a><!-- doxytag: member="TCLAP::DocBookOutput::usage" ref="adc1ec93f3f7e5e912690be01c5e7d6e2" args="(CmdLineInterface &c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::DocBookOutput::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>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prints the usage to stdout. </p>
<p>Can be overridden to produce alternative behavior. </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>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html#a685b13db5bf6bbe5159e49169cd96bbe">TCLAP::CmdLineOutput</a>.</p>
<p>Definition at line <a class="el" href="_doc_book_output_8h_source.html#l00091">91</a> of file <a class="el" href="_doc_book_output_8h_source.html">DocBookOutput.h</a>.</p>
<p>References <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a4de8d988f5a6f3007c4dfb0fc9dad476">TCLAP::CmdLineInterface::getArgList()</a>, <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a1a5672df72a6b5021cd70b37c4dbd0a7">TCLAP::CmdLineInterface::getProgramName()</a>, <a class="el" href="_doc_book_output_8h_source.html#l00086">version()</a>, <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a0a552fa57212800dfb8aec84fb07b8bb">TCLAP::CmdLineInterface::getVersion()</a>, <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a11ce9c77a1111960741f05e343849e4e">TCLAP::CmdLineInterface::getXorHandler()</a>, <a class="el" href="_xor_handler_8h_source.html#l00143">TCLAP::XorHandler::getXorList()</a>, <a class="el" href="eigen__plugins_8h_source.html#l00046">begin()</a>, <a class="el" href="_doc_book_output_8h_source.html#l00218">printShortArg()</a>, <a class="el" href="_xor_handler_8h_source.html#l00131">TCLAP::XorHandler::contains()</a>, <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a30175a2567f7ab78a2c6bbea9269a2fa">TCLAP::CmdLineInterface::getMessage()</a>, and <a class="el" href="_doc_book_output_8h_source.html#l00245">printLongArg()</a>.</p>
</div>
</div>
<a class="anchor" id="a3ccf7671dcae82aba5f0e91850ae25a4"></a><!-- doxytag: member="TCLAP::DocBookOutput::version" ref="a3ccf7671dcae82aba5f0e91850ae25a4" args="(CmdLineInterface &c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::DocBookOutput::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>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prints the version to stdout. </p>
<p>Can be overridden to produce alternative behavior. </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>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html#ae052fea473132482296de55edb3dd480">TCLAP::CmdLineOutput</a>.</p>
<p>Definition at line <a class="el" href="_doc_book_output_8h_source.html#l00086">86</a> of file <a class="el" href="_doc_book_output_8h_source.html">DocBookOutput.h</a>.</p>
<p>References <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a0a552fa57212800dfb8aec84fb07b8bb">TCLAP::CmdLineInterface::getVersion()</a>.</p>
<p>Referenced by <a class="el" href="_doc_book_output_8h_source.html#l00091">usage()</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>
