<!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::CmdLine 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_cmd_line.html">CmdLine</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> | <a href="#pro-attribs">Protected Attributes</a> | <a href="#pri-methods">Private Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> </div> <div class="headertitle"> <div class="title">TCLAP::CmdLine Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="TCLAP::CmdLine" --><!-- doxytag: inherits="TCLAP::CmdLineInterface" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>The base class that manages the command line definition and passes along the parsing to the appropriate <a class="el" href="class_t_c_l_a_p_1_1_arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a> classes. </p> </div> <p><code>#include <<a class="el" href="_cmd_line_8h_source.html">mrpt/otherlibs/tclap/CmdLine.h</a>></code></p> <div class="dynheader"> Inheritance diagram for TCLAP::CmdLine:</div> <div class="dyncontent"> <div class="center"><img src="class_t_c_l_a_p_1_1_cmd_line__inherit__graph.png" border="0" usemap="#_t_c_l_a_p_1_1_cmd_line_inherit__map" alt="Inheritance graph"/></div> <map name="_t_c_l_a_p_1_1_cmd_line_inherit__map" id="_t_c_l_a_p_1_1_cmd_line_inherit__map"> <area shape="rect" id="node2" 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..." alt="" coords="5,5,181,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_cmd_line-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_cmd_line.html#a2e62a3493f8700afb49a7deb872a5b96">CmdLine</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &message, const char delimiter= ' ', const <a class="el" href="classstd_1_1string.html">std::string</a> &version="none", bool helpAndVersion=true)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command line constructor. <a href="#a2e62a3493f8700afb49a7deb872a5b96"></a><br/></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.html#a8a7bddba32c3d96e2a01e4c8e160e6fa">~CmdLine</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Deletes any resources allocated by a <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. <a href="#a8a7bddba32c3d96e2a01e4c8e160e6fa"></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_cmd_line.html#a94c511d4735ad9b8c97edaa3827f8bbf">add</a> (<a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> &a)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an argument to the list of arguments to be parsed. <a href="#a94c511d4735ad9b8c97edaa3827f8bbf"></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_cmd_line.html#ab8a08e8f4d3ca7709c85416f76e805a3">add</a> (<a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> *a)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">An alternative add. <a href="#ab8a08e8f4d3ca7709c85416f76e805a3"></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_cmd_line.html#afbaa2071d0c3276b383089acabdc0dd2">xorAdd</a> (<a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> &a, <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> &b)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add two Args that will be xor'd. <a href="#afbaa2071d0c3276b383089acabdc0dd2"></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_cmd_line.html#ac7f2d7ee32a5157f625ad9833ab148cf">xorAdd</a> (<a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * > &xors)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add a list of Args that will be xor'd. <a href="#ac7f2d7ee32a5157f625ad9833ab148cf"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#af84dff8ae4966e799ec033129e5a058b">parse</a> (int argc, char **argv)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Parses the command line. <a href="#af84dff8ae4966e799ec033129e5a058b"></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_cmd_line.html#ad8aea2617edf53bbc20c8964ee5476e6">getOutput</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns 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> object. <a href="#ad8aea2617edf53bbc20c8964ee5476e6"></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_cmd_line.html#a4506e305cd10437c7ce5a5ba34cfed0f">setOutput</a> (<a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html">CmdLineOutput</a> *co)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a85b5653d1a5b48fe6accead64615cf33">getVersion</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the version string. <a href="#a85b5653d1a5b48fe6accead64615cf33"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a47a6d496980ee11ffc42e27144a61797">getProgramName</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the program name string. <a href="#a47a6d496980ee11ffc42e27144a61797"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1list.html">std::list</a>< <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a3c281da929a281fb883ea47632b7ad38">getArgList</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the argList. <a href="#a3c281da929a281fb883ea47632b7ad38"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_t_c_l_a_p_1_1_xor_handler.html">XorHandler</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a805433b7718d1bc5bc9317bbd061449b">getXorHandler</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="class_t_c_l_a_p_1_1_xor_handler.html" title="This class handles lists of Arg's that are to be XOR'd on the command line.">XorHandler</a>. <a href="#a805433b7718d1bc5bc9317bbd061449b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a3e9f0ac2c1e97d1f8527da713ddd5a8f">getDelimiter</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the delimiter string. <a href="#a3e9f0ac2c1e97d1f8527da713ddd5a8f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a8f61a8c201e31ada985fa998180fd40f">getMessage</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the message string. <a href="#a8f61a8c201e31ada985fa998180fd40f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a5b23895feae4f4110b77dae372226475">hasHelpAndVersion</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether or not the help and version switches were created automatically. <a href="#a5b23895feae4f4110b77dae372226475"></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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a170a4e711c2a6d58a05e9ad3bc03c08a">_emptyCombined</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &s)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether a name/flag string matches entirely matches the <a class="el" href="class_t_c_l_a_p_1_1_arg.html#a40ba4acecb58080ba33aa57d99e14cad" title="The char used as a place holder when SwitchArgs are combined.">Arg::blankChar</a>. <a href="#a170a4e711c2a6d58a05e9ad3bc03c08a"></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_cmd_line.html#a42d669ed2037ac24fc78883aa8600655">deleteOnExit</a> (<a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> *ptr)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Perform a delete ptr; operation on ptr when this object is deleted. <a href="#a42d669ed2037ac24fc78883aa8600655"></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_cmd_line.html#a262b8d929eb5b0dfbfc17637c1325c36">deleteOnExit</a> (<a class="el" href="class_t_c_l_a_p_1_1_visitor.html">Visitor</a> *ptr)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Perform a delete ptr; operation on ptr when this object is deleted. <a href="#a262b8d929eb5b0dfbfc17637c1325c36"></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="classstd_1_1list.html">std::list</a>< <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a4d70f73542d8184e077688bff3801baf">_argList</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The list of arguments that will be tested against the command line. <a href="#a4d70f73542d8184e077688bff3801baf"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a8b856dadc54fa30d0dddba4588ef9344">_progName</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the program. <a href="#a8b856dadc54fa30d0dddba4588ef9344"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a3ccd2ae40f6eb97aebca3de9a02f10cf">_message</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A message used to describe the program. <a href="#a3ccd2ae40f6eb97aebca3de9a02f10cf"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a2b2b52fffed2dcb7df3cdfc582ec8fd1">_version</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The version to be displayed with the --version switch. <a href="#a2b2b52fffed2dcb7df3cdfc582ec8fd1"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a2285207b528d5fad18c82a2ee8155f37">_numRequired</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The number of arguments that are required to be present on the command line. <a href="#a2285207b528d5fad18c82a2ee8155f37"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a602e65692dc07ea872134f354026a54f">_delimiter</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The character that is used to separate the argument flag/name from the value. <a href="#a602e65692dc07ea872134f354026a54f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_t_c_l_a_p_1_1_xor_handler.html">XorHandler</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a33846aa10c62ecd61640c93c16ac315d">_xorHandler</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The handler that manages xoring lists of args. <a href="#a33846aa10c62ecd61640c93c16ac315d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1list.html">std::list</a>< <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#af8d37fbf9d0b60b6acbd737af380f3e5">_argDeleteOnExitList</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A list of Args to be explicitly deleted when the destructor is called. <a href="#af8d37fbf9d0b60b6acbd737af380f3e5"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1list.html">std::list</a>< <a class="el" href="class_t_c_l_a_p_1_1_visitor.html">Visitor</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a79b8a947f8100de977574b45b91117ac">_visitorDeleteOnExitList</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A list of Visitors to be explicitly deleted when the destructor is called. <a href="#a79b8a947f8100de977574b45b91117ac"></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_cmd_line.html#a5152bf4ef26217583a3bc708aa0ea83e">_output</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Object that handles all output for 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>. <a href="#a5152bf4ef26217583a3bc708aa0ea83e"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pri-methods"></a> Private 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_cmd_line.html#a955b1935c7b2e5118b2573bd2fbb958c">_constructor</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Encapsulates the code common to the constructors (which is all of it). <a href="#a955b1935c7b2e5118b2573bd2fbb958c"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pri-attribs"></a> Private Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#ab78aec340244f230a41dd946d0138aba">_userSetOutput</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Is set to true when a user sets the output object. <a href="#ab78aec340244f230a41dd946d0138aba"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#aea29ec639729a22384ee8759069a5017">_helpAndVersion</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Whether or not to automatically create help and version switches. <a href="#aea29ec639729a22384ee8759069a5017"></a><br/></td></tr> </table> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a2e62a3493f8700afb49a7deb872a5b96"></a><!-- doxytag: member="TCLAP::CmdLine::CmdLine" ref="a2e62a3493f8700afb49a7deb872a5b96" args="(const std::string &message, const char delimiter= ' ', const std::string &version="none", bool helpAndVersion=true)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">TCLAP::CmdLine::CmdLine </td> <td>(</td> <td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td> <td class="paramname"><em>message</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char </td> <td class="paramname"><em>delimiter</em> = <code>' '</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td> <td class="paramname"><em>version</em> = <code>"none"</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>helpAndVersion</em> = <code>true</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Command line constructor. </p> <p>Defines how the arguments will be parsed. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">message</td><td>- The message to be used in the usage output. </td></tr> <tr><td class="paramname">delimiter</td><td>- The character that is used to separate the argument flag/name from the value. Defaults to ' ' (space). </td></tr> <tr><td class="paramname">version</td><td>- The version number to be used in the --version switch. </td></tr> <tr><td class="paramname">helpAndVersion</td><td>- Whether or not to create the Help and Version switches. Defaults to true. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00264">264</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00298">_constructor()</a>.</p> </div> </div> <a class="anchor" id="a8a7bddba32c3d96e2a01e4c8e160e6fa"></a><!-- doxytag: member="TCLAP::CmdLine::~CmdLine" ref="a8a7bddba32c3d96e2a01e4c8e160e6fa" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">TCLAP::CmdLine::~CmdLine </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Deletes any resources allocated by a <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> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00279">279</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00103">_argDeleteOnExitList</a>, <a class="el" href="_cmd_line_8h_source.html#l00110">_visitorDeleteOnExitList</a>, <a class="el" href="_cmd_line_8h_source.html#l00147">_userSetOutput</a>, and <a class="el" href="_cmd_line_8h_source.html#l00115">_output</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a955b1935c7b2e5118b2573bd2fbb958c"></a><!-- doxytag: member="TCLAP::CmdLine::_constructor" ref="a955b1935c7b2e5118b2573bd2fbb958c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::CmdLine::_constructor </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Encapsulates the code common to the constructors (which is all of it). </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00298">298</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00115">_output</a>, <a class="el" href="_arg_8h_source.html#l00216">TCLAP::Arg::setDelimiter()</a>, <a class="el" href="_cmd_line_8h_source.html#l00091">_delimiter</a>, <a class="el" href="_cmd_line_8h_source.html#l00152">_helpAndVersion</a>, <a class="el" href="_cmd_line_8h_source.html#l00356">add()</a>, <a class="el" href="_cmd_line_8h_source.html#l00443">deleteOnExit()</a>, <a class="el" href="_arg_8h_source.html#l00199">TCLAP::Arg::flagStartString()</a>, and <a class="el" href="_arg_8h_source.html#l00210">TCLAP::Arg::ignoreNameString()</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00264">CmdLine()</a>.</p> </div> </div> <a class="anchor" id="a170a4e711c2a6d58a05e9ad3bc03c08a"></a><!-- doxytag: member="TCLAP::CmdLine::_emptyCombined" ref="a170a4e711c2a6d58a05e9ad3bc03c08a" args="(const std::string &s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool TCLAP::CmdLine::_emptyCombined </td> <td>(</td> <td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td> <td class="paramname"><em>s</em></td><td>)</td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Checks whether a name/flag string matches entirely matches the <a class="el" href="class_t_c_l_a_p_1_1_arg.html#a40ba4acecb58080ba33aa57d99e14cad" title="The char used as a place holder when SwitchArgs are combined.">Arg::blankChar</a>. </p> <p>Used when multiple switches are combined into a single argument. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">s</td><td>- The message to be used in the usage. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00431">431</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_arg_8h_source.html#l00193">TCLAP::Arg::flagStartChar()</a>, and <a class="el" href="_arg_8h_source.html#l00188">TCLAP::Arg::blankChar()</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00375">parse()</a>.</p> </div> </div> <a class="anchor" id="a94c511d4735ad9b8c97edaa3827f8bbf"></a><!-- doxytag: member="TCLAP::CmdLine::add" ref="a94c511d4735ad9b8c97edaa3827f8bbf" args="(Arg &a)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::CmdLine::add </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>a</em></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Adds an argument to the list of arguments to be parsed. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">a</td><td>- Argument to be added. </td></tr> </table> </dd> </dl> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a13b29ab754c030185e58f779dc355631">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00356">356</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00298">_constructor()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00335">xorAdd()</a>.</p> </div> </div> <a class="anchor" id="ab8a08e8f4d3ca7709c85416f76e805a3"></a><!-- doxytag: member="TCLAP::CmdLine::add" ref="ab8a08e8f4d3ca7709c85416f76e805a3" args="(Arg *a)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::CmdLine::add </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>a</em></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>An alternative add. </p> <p>Functionally identical. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">a</td><td>- Argument to be added. </td></tr> </table> </dd> </dl> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a7c6a097c0f2a09dd1987e9da1af8b457">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00361">361</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00063">_argList</a>, <a class="el" href="_arg_8h_source.html#l00423">TCLAP::Arg::longID()</a>, <a class="el" href="_arg_8h_source.html#l00564">TCLAP::Arg::addToList()</a>, <a class="el" href="_arg_8h_source.html#l00471">TCLAP::Arg::isRequired()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00085">_numRequired</a>.</p> </div> </div> <a class="anchor" id="a42d669ed2037ac24fc78883aa8600655"></a><!-- doxytag: member="TCLAP::CmdLine::deleteOnExit" ref="a42d669ed2037ac24fc78883aa8600655" args="(Arg *ptr)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::CmdLine::deleteOnExit </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>ptr</em></td><td>)</td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Perform a delete ptr; operation on ptr when this object is deleted. </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00443">443</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00103">_argDeleteOnExitList</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00298">_constructor()</a>.</p> </div> </div> <a class="anchor" id="a262b8d929eb5b0dfbfc17637c1325c36"></a><!-- doxytag: member="TCLAP::CmdLine::deleteOnExit" ref="a262b8d929eb5b0dfbfc17637c1325c36" args="(Visitor *ptr)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::CmdLine::deleteOnExit </td> <td>(</td> <td class="paramtype"><a class="el" href="class_t_c_l_a_p_1_1_visitor.html">Visitor</a> * </td> <td class="paramname"><em>ptr</em></td><td>)</td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Perform a delete ptr; operation on ptr when this object is deleted. </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00448">448</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00110">_visitorDeleteOnExitList</a>.</p> </div> </div> <a class="anchor" id="a3c281da929a281fb883ea47632b7ad38"></a><!-- doxytag: member="TCLAP::CmdLine::getArgList" ref="a3c281da929a281fb883ea47632b7ad38" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1list.html">std::list</a>< <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * > & TCLAP::CmdLine::getArgList </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the argList. </p> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a4de8d988f5a6f3007c4dfb0fc9dad476">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00474">474</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00063">_argList</a>.</p> </div> </div> <a class="anchor" id="a3e9f0ac2c1e97d1f8527da713ddd5a8f"></a><!-- doxytag: member="TCLAP::CmdLine::getDelimiter" ref="a3e9f0ac2c1e97d1f8527da713ddd5a8f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char TCLAP::CmdLine::getDelimiter </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the delimiter string. </p> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a7d6a64cff6b3a30e2cf1e81d7b1d4521">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00484">484</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00091">_delimiter</a>.</p> </div> </div> <a class="anchor" id="a8f61a8c201e31ada985fa998180fd40f"></a><!-- doxytag: member="TCLAP::CmdLine::getMessage" ref="a8f61a8c201e31ada985fa998180fd40f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> & TCLAP::CmdLine::getMessage </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the message string. </p> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a30175a2567f7ab78a2c6bbea9269a2fa">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00489">489</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00073">_message</a>.</p> </div> </div> <a class="anchor" id="ad8aea2617edf53bbc20c8964ee5476e6"></a><!-- doxytag: member="TCLAP::CmdLine::getOutput" ref="ad8aea2617edf53bbc20c8964ee5476e6" 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> * TCLAP::CmdLine::getOutput </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns 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> object. </p> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#aebc72daedeaeb03e06bb2e6e0f00363d">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00453">453</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00115">_output</a>.</p> </div> </div> <a class="anchor" id="a47a6d496980ee11ffc42e27144a61797"></a><!-- doxytag: member="TCLAP::CmdLine::getProgramName" ref="a47a6d496980ee11ffc42e27144a61797" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> & TCLAP::CmdLine::getProgramName </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the program name string. </p> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a1a5672df72a6b5021cd70b37c4dbd0a7">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00469">469</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00068">_progName</a>.</p> </div> </div> <a class="anchor" id="a85b5653d1a5b48fe6accead64615cf33"></a><!-- doxytag: member="TCLAP::CmdLine::getVersion" ref="a85b5653d1a5b48fe6accead64615cf33" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> & TCLAP::CmdLine::getVersion </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the version string. </p> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a0a552fa57212800dfb8aec84fb07b8bb">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00464">464</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00078">_version</a>.</p> </div> </div> <a class="anchor" id="a805433b7718d1bc5bc9317bbd061449b"></a><!-- doxytag: member="TCLAP::CmdLine::getXorHandler" ref="a805433b7718d1bc5bc9317bbd061449b" 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_xor_handler.html">XorHandler</a> & TCLAP::CmdLine::getXorHandler </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the <a class="el" href="class_t_c_l_a_p_1_1_xor_handler.html" title="This class handles lists of Arg's that are to be XOR'd on the command line.">XorHandler</a>. </p> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a11ce9c77a1111960741f05e343849e4e">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00479">479</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00096">_xorHandler</a>.</p> </div> </div> <a class="anchor" id="a5b23895feae4f4110b77dae372226475"></a><!-- doxytag: member="TCLAP::CmdLine::hasHelpAndVersion" ref="a5b23895feae4f4110b77dae372226475" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool TCLAP::CmdLine::hasHelpAndVersion </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Indicates whether or not the help and version switches were created automatically. </p> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a441b06b764836a62083b163508210905">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00494">494</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00152">_helpAndVersion</a>.</p> </div> </div> <a class="anchor" id="af84dff8ae4966e799ec033129e5a058b"></a><!-- doxytag: member="TCLAP::CmdLine::parse" ref="af84dff8ae4966e799ec033129e5a058b" args="(int argc, char **argv)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool TCLAP::CmdLine::parse </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>argc</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char ** </td> <td class="paramname"><em>argv</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Parses the command line. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">argc</td><td>- Number of arguments. </td></tr> <tr><td class="paramname">argv</td><td>- Array of arguments. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>(Added by JLBC for MRPT): Return false if the program should exit (error in args, it was --help, etc...) </dd></dl> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a544eafc7da68a9392a75ee07f9ffcf00">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00375">375</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00068">_progName</a>, <a class="el" href="_cmd_line_8h_source.html#l00063">_argList</a>, <a class="el" href="_cmd_line_8h_source.html#l00096">_xorHandler</a>, <a class="el" href="_xor_handler_8h_source.html#l00100">TCLAP::XorHandler::check()</a>, <a class="el" href="_cmd_line_8h_source.html#l00431">_emptyCombined()</a>, <a class="el" href="_arg_8h_source.html#l00175">TCLAP::Arg::ignoreRest()</a>, <a class="el" href="_cmd_line_8h_source.html#l00085">_numRequired</a>, <a class="el" href="_cmd_line_8h_source.html#l00115">_output</a>, and <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_output.html#ad23a57ac3d8d957a4328fc78aec94e16">TCLAP::CmdLineOutput::failure()</a>.</p> </div> </div> <a class="anchor" id="a4506e305cd10437c7ce5a5ba34cfed0f"></a><!-- doxytag: member="TCLAP::CmdLine::setOutput" ref="a4506e305cd10437c7ce5a5ba34cfed0f" args="(CmdLineOutput *co)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::CmdLine::setOutput </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>co</em></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">co</td><td>- <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 that we want to use instead. </td></tr> </table> </dd> </dl> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#ab208b32bd9489781509d7ecddf8a92a0">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00458">458</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00147">_userSetOutput</a>, and <a class="el" href="_cmd_line_8h_source.html#l00115">_output</a>.</p> </div> </div> <a class="anchor" id="afbaa2071d0c3276b383089acabdc0dd2"></a><!-- doxytag: member="TCLAP::CmdLine::xorAdd" ref="afbaa2071d0c3276b383089acabdc0dd2" args="(Arg &a, Arg &b)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::CmdLine::xorAdd </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>a</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.html">Arg</a> & </td> <td class="paramname"><em>b</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Add two Args that will be xor'd. </p> <p>If this method is used, add does not need to be called. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">a</td><td>- Argument to be added and xor'd. </td></tr> <tr><td class="paramname">b</td><td>- Argument to be added and xor'd. </td></tr> </table> </dd> </dl> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a69859e3713623eb06c9c335248d9c83f">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00348">348</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> </div> </div> <a class="anchor" id="ac7f2d7ee32a5157f625ad9833ab148cf"></a><!-- doxytag: member="TCLAP::CmdLine::xorAdd" ref="ac7f2d7ee32a5157f625ad9833ab148cf" args="(std::vector< Arg * > &xors)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::CmdLine::xorAdd </td> <td>(</td> <td class="paramtype"><a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> * > & </td> <td class="paramname"><em>xors</em></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Add a list of Args that will be xor'd. </p> <p>If this method is used, add does not need to be called. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">xors</td><td>- List of Args to be added and xor'd. </td></tr> </table> </dd> </dl> <p>Implements <a class="el" href="class_t_c_l_a_p_1_1_cmd_line_interface.html#a6a94140e522bcf6104928fcf0c434ab8">TCLAP::CmdLineInterface</a>.</p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00335">335</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>References <a class="el" href="_cmd_line_8h_source.html#l00096">_xorHandler</a>, <a class="el" href="_xor_handler_8h_source.html#l00095">TCLAP::XorHandler::add()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00356">add()</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="af8d37fbf9d0b60b6acbd737af380f3e5"></a><!-- doxytag: member="TCLAP::CmdLine::_argDeleteOnExitList" ref="af8d37fbf9d0b60b6acbd737af380f3e5" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1list.html">std::list</a><<a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a>*> <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#af8d37fbf9d0b60b6acbd737af380f3e5">TCLAP::CmdLine::_argDeleteOnExitList</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>A list of Args to be explicitly deleted when the destructor is called. </p> <p>At the moment, this only includes the three default Args. </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00103">103</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00279">~CmdLine()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00443">deleteOnExit()</a>.</p> </div> </div> <a class="anchor" id="a4d70f73542d8184e077688bff3801baf"></a><!-- doxytag: member="TCLAP::CmdLine::_argList" ref="a4d70f73542d8184e077688bff3801baf" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1list.html">std::list</a><<a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a>*> <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a4d70f73542d8184e077688bff3801baf">TCLAP::CmdLine::_argList</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The list of arguments that will be tested against the command line. </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00063">63</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00361">add()</a>, <a class="el" href="_cmd_line_8h_source.html#l00375">parse()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00474">getArgList()</a>.</p> </div> </div> <a class="anchor" id="a602e65692dc07ea872134f354026a54f"></a><!-- doxytag: member="TCLAP::CmdLine::_delimiter" ref="a602e65692dc07ea872134f354026a54f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a602e65692dc07ea872134f354026a54f">TCLAP::CmdLine::_delimiter</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The character that is used to separate the argument flag/name from the value. </p> <p>Defaults to ' ' (space). </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00091">91</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00298">_constructor()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00484">getDelimiter()</a>.</p> </div> </div> <a class="anchor" id="aea29ec639729a22384ee8759069a5017"></a><!-- doxytag: member="TCLAP::CmdLine::_helpAndVersion" ref="aea29ec639729a22384ee8759069a5017" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#aea29ec639729a22384ee8759069a5017">TCLAP::CmdLine::_helpAndVersion</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Whether or not to automatically create help and version switches. </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00152">152</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00298">_constructor()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00494">hasHelpAndVersion()</a>.</p> </div> </div> <a class="anchor" id="a3ccd2ae40f6eb97aebca3de9a02f10cf"></a><!-- doxytag: member="TCLAP::CmdLine::_message" ref="a3ccd2ae40f6eb97aebca3de9a02f10cf" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a3ccd2ae40f6eb97aebca3de9a02f10cf">TCLAP::CmdLine::_message</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>A message used to describe the program. </p> <p>Used in the usage output. </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00073">73</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00489">getMessage()</a>.</p> </div> </div> <a class="anchor" id="a2285207b528d5fad18c82a2ee8155f37"></a><!-- doxytag: member="TCLAP::CmdLine::_numRequired" ref="a2285207b528d5fad18c82a2ee8155f37" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a2285207b528d5fad18c82a2ee8155f37">TCLAP::CmdLine::_numRequired</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The number of arguments that are required to be present on the command line. </p> <p>This is set dynamically, based on the Args added to 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. </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00085">85</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00361">add()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00375">parse()</a>.</p> </div> </div> <a class="anchor" id="a5152bf4ef26217583a3bc708aa0ea83e"></a><!-- doxytag: member="TCLAP::CmdLine::_output" ref="a5152bf4ef26217583a3bc708aa0ea83e" 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_cmd_line.html#a5152bf4ef26217583a3bc708aa0ea83e">TCLAP::CmdLine::_output</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Object that handles all output for 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>. </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00115">115</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00279">~CmdLine()</a>, <a class="el" href="_cmd_line_8h_source.html#l00298">_constructor()</a>, <a class="el" href="_cmd_line_8h_source.html#l00375">parse()</a>, <a class="el" href="_cmd_line_8h_source.html#l00453">getOutput()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00458">setOutput()</a>.</p> </div> </div> <a class="anchor" id="a8b856dadc54fa30d0dddba4588ef9344"></a><!-- doxytag: member="TCLAP::CmdLine::_progName" ref="a8b856dadc54fa30d0dddba4588ef9344" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a8b856dadc54fa30d0dddba4588ef9344">TCLAP::CmdLine::_progName</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The name of the program. </p> <p>Set to argv[0]. </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00068">68</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00375">parse()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00469">getProgramName()</a>.</p> </div> </div> <a class="anchor" id="ab78aec340244f230a41dd946d0138aba"></a><!-- doxytag: member="TCLAP::CmdLine::_userSetOutput" ref="ab78aec340244f230a41dd946d0138aba" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#ab78aec340244f230a41dd946d0138aba">TCLAP::CmdLine::_userSetOutput</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Is set to true when a user sets the output object. </p> <p>We use this so that we don't delete objects that are created outside of this lib. </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00147">147</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00279">~CmdLine()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00458">setOutput()</a>.</p> </div> </div> <a class="anchor" id="a2b2b52fffed2dcb7df3cdfc582ec8fd1"></a><!-- doxytag: member="TCLAP::CmdLine::_version" ref="a2b2b52fffed2dcb7df3cdfc582ec8fd1" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a2b2b52fffed2dcb7df3cdfc582ec8fd1">TCLAP::CmdLine::_version</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The version to be displayed with the --version switch. </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00078">78</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00464">getVersion()</a>.</p> </div> </div> <a class="anchor" id="a79b8a947f8100de977574b45b91117ac"></a><!-- doxytag: member="TCLAP::CmdLine::_visitorDeleteOnExitList" ref="a79b8a947f8100de977574b45b91117ac" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1list.html">std::list</a><<a class="el" href="class_t_c_l_a_p_1_1_visitor.html">Visitor</a>*> <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a79b8a947f8100de977574b45b91117ac">TCLAP::CmdLine::_visitorDeleteOnExitList</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>A list of Visitors to be explicitly deleted when the destructor is called. </p> <p>At the moment, these are the Vistors created for the default Args. </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00110">110</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00279">~CmdLine()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00448">deleteOnExit()</a>.</p> </div> </div> <a class="anchor" id="a33846aa10c62ecd61640c93c16ac315d"></a><!-- doxytag: member="TCLAP::CmdLine::_xorHandler" ref="a33846aa10c62ecd61640c93c16ac315d" 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_xor_handler.html">XorHandler</a> <a class="el" href="class_t_c_l_a_p_1_1_cmd_line.html#a33846aa10c62ecd61640c93c16ac315d">TCLAP::CmdLine::_xorHandler</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The handler that manages xoring lists of args. </p> <p>Definition at line <a class="el" href="_cmd_line_8h_source.html#l00096">96</a> of file <a class="el" href="_cmd_line_8h_source.html">CmdLine.h</a>.</p> <p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00335">xorAdd()</a>, <a class="el" href="_cmd_line_8h_source.html#l00375">parse()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00479">getXorHandler()</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>