<!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>CmdLine.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CmdLine.h</div> </div>
</div>
<div class="contents">
<a href="_cmd_line_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00002"></a>00002 <span class="comment">/******************************************************************************</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * file: CmdLine.h</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * Copyright (c) 2003, Michael E. Smoot .</span>
<a name="l00007"></a>00007 <span class="comment"> * Copyright (c) 2004, Michael E. Smoot, Daniel Aarno.</span>
<a name="l00008"></a>00008 <span class="comment"> * All rights reverved.</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * See the file COPYING in the top directory of this distribution for</span>
<a name="l00011"></a>00011 <span class="comment"> * more information.</span>
<a name="l00012"></a>00012 <span class="comment"> *</span>
<a name="l00013"></a>00013 <span class="comment"> * THE SOFTWARE IS PROVIDED _AS IS_, WITHOUT WARRANTY OF ANY KIND, EXPRESS</span>
<a name="l00014"></a>00014 <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<a name="l00015"></a>00015 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL</span>
<a name="l00016"></a>00016 <span class="comment"> * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<a name="l00017"></a>00017 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span>
<a name="l00018"></a>00018 <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span>
<a name="l00019"></a>00019 <span class="comment"> * DEALINGS IN THE SOFTWARE.</span>
<a name="l00020"></a>00020 <span class="comment"> *</span>
<a name="l00021"></a>00021 <span class="comment"> *****************************************************************************/</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef TCLAP_CMDLINE_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define TCLAP_CMDLINE_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <<a class="code" href="_switch_arg_8h.html">mrpt/otherlibs/tclap/SwitchArg.h</a>></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="_multi_switch_arg_8h.html">mrpt/otherlibs/tclap/MultiSwitchArg.h</a>></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <<a class="code" href="_unlabeled_value_arg_8h.html">mrpt/otherlibs/tclap/UnlabeledValueArg.h</a>></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <<a class="code" href="_unlabeled_multi_arg_8h.html">mrpt/otherlibs/tclap/UnlabeledMultiArg.h</a>></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="_xor_handler_8h.html">mrpt/otherlibs/tclap/XorHandler.h</a>></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="_help_visitor_8h.html">mrpt/otherlibs/tclap/HelpVisitor.h</a>></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <<a class="code" href="_version_visitor_8h.html">mrpt/otherlibs/tclap/VersionVisitor.h</a>></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <<a class="code" href="_ignore_rest_visitor_8h.html">mrpt/otherlibs/tclap/IgnoreRestVisitor.h</a>></span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="preprocessor">#include <<a class="code" href="_cmd_line_output_8h.html">mrpt/otherlibs/tclap/CmdLineOutput.h</a>></span>
<a name="l00037"></a>00037 <span class="preprocessor">#include <<a class="code" href="_std_output_8h.html">mrpt/otherlibs/tclap/StdOutput.h</a>></span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="preprocessor">#include <<a class="code" href="_constraint_8h.html">mrpt/otherlibs/tclap/Constraint.h</a>></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <<a class="code" href="_values_constraint_8h.html">mrpt/otherlibs/tclap/ValuesConstraint.h</a>></span>
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="preprocessor">#include <string></span>
<a name="l00043"></a>00043 <span class="preprocessor">#include <vector></span>
<a name="l00044"></a>00044 <span class="preprocessor">#include <list></span>
<a name="l00045"></a>00045 <span class="preprocessor">#include <iostream></span>
<a name="l00046"></a>00046 <span class="preprocessor">#include <iomanip></span>
<a name="l00047"></a>00047 <span class="preprocessor">#include <algorithm></span>
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">namespace </span>TCLAP {
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment">/**</span>
<a name="l00052"></a>00052 <span class="comment"> * The base class that manages the command line definition and passes</span>
<a name="l00053"></a>00053 <span class="comment"> * along the parsing to the appropriate Arg classes.</span>
<a name="l00054"></a>00054 <span class="comment"> */</span>
<a name="l00055"></a>00055 <span class="keyword">class </span>CmdLine : <span class="keyword">public</span> CmdLineInterface
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057 <span class="keyword">protected</span>:
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> /**</span>
<a name="l00060"></a>00060 <span class="comment"> * The list of arguments that will be tested against the</span>
<a name="l00061"></a>00061 <span class="comment"> * command line.</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a4d70f73542d8184e077688bff3801baf">00063</a> std::list<Arg*> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a4d70f73542d8184e077688bff3801baf" title="The list of arguments that will be tested against the command line.">_argList</a>;
<a name="l00064"></a>00064 <span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment"> /**</span>
<a name="l00066"></a>00066 <span class="comment"> * The name of the program. Set to argv[0].</span>
<a name="l00067"></a>00067 <span class="comment"> */</span>
<a name="l00068"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a8b856dadc54fa30d0dddba4588ef9344">00068</a> std::string <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a8b856dadc54fa30d0dddba4588ef9344" title="The name of the program.">_progName</a>;
<a name="l00069"></a>00069 <span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment"> /**</span>
<a name="l00071"></a>00071 <span class="comment"> * A message used to describe the program. Used in the usage output.</span>
<a name="l00072"></a>00072 <span class="comment"> */</span>
<a name="l00073"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a3ccd2ae40f6eb97aebca3de9a02f10cf">00073</a> std::string <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a3ccd2ae40f6eb97aebca3de9a02f10cf" title="A message used to describe the program.">_message</a>;
<a name="l00074"></a>00074 <span class="comment"></span>
<a name="l00075"></a>00075 <span class="comment"> /**</span>
<a name="l00076"></a>00076 <span class="comment"> * The version to be displayed with the --version switch.</span>
<a name="l00077"></a>00077 <span class="comment"> */</span>
<a name="l00078"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a2b2b52fffed2dcb7df3cdfc582ec8fd1">00078</a> std::string <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a2b2b52fffed2dcb7df3cdfc582ec8fd1" title="The version to be displayed with the --version switch.">_version</a>;
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> /**</span>
<a name="l00081"></a>00081 <span class="comment"> * The number of arguments that are required to be present on</span>
<a name="l00082"></a>00082 <span class="comment"> * the command line. This is set dynamically, based on the</span>
<a name="l00083"></a>00083 <span class="comment"> * Args added to the CmdLine object.</span>
<a name="l00084"></a>00084 <span class="comment"> */</span>
<a name="l00085"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a2285207b528d5fad18c82a2ee8155f37">00085</a> <span class="keywordtype">int</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a2285207b528d5fad18c82a2ee8155f37" title="The number of arguments that are required to be present on the command line.">_numRequired</a>;
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment"> /**</span>
<a name="l00088"></a>00088 <span class="comment"> * The character that is used to separate the argument flag/name</span>
<a name="l00089"></a>00089 <span class="comment"> * from the value. Defaults to ' ' (space).</span>
<a name="l00090"></a>00090 <span class="comment"> */</span>
<a name="l00091"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a602e65692dc07ea872134f354026a54f">00091</a> <span class="keywordtype">char</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a602e65692dc07ea872134f354026a54f" title="The character that is used to separate the argument flag/name from the value.">_delimiter</a>;
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment"> /**</span>
<a name="l00094"></a>00094 <span class="comment"> * The handler that manages xoring lists of args.</span>
<a name="l00095"></a>00095 <span class="comment"> */</span>
<a name="l00096"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a33846aa10c62ecd61640c93c16ac315d">00096</a> <a class="code" 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 class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a33846aa10c62ecd61640c93c16ac315d" title="The handler that manages xoring lists of args.">_xorHandler</a>;
<a name="l00097"></a>00097 <span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment"> /**</span>
<a name="l00099"></a>00099 <span class="comment"> * A list of Args to be explicitly deleted when the destructor</span>
<a name="l00100"></a>00100 <span class="comment"> * is called. At the moment, this only includes the three default</span>
<a name="l00101"></a>00101 <span class="comment"> * Args.</span>
<a name="l00102"></a>00102 <span class="comment"> */</span>
<a name="l00103"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#af8d37fbf9d0b60b6acbd737af380f3e5">00103</a> std::list<Arg*> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#af8d37fbf9d0b60b6acbd737af380f3e5" title="A list of Args to be explicitly deleted when the destructor is called.">_argDeleteOnExitList</a>;
<a name="l00104"></a>00104 <span class="comment"></span>
<a name="l00105"></a>00105 <span class="comment"> /**</span>
<a name="l00106"></a>00106 <span class="comment"> * A list of Visitors to be explicitly deleted when the destructor</span>
<a name="l00107"></a>00107 <span class="comment"> * is called. At the moment, these are the Vistors created for the</span>
<a name="l00108"></a>00108 <span class="comment"> * default Args.</span>
<a name="l00109"></a>00109 <span class="comment"> */</span>
<a name="l00110"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a79b8a947f8100de977574b45b91117ac">00110</a> std::list<Visitor*> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a79b8a947f8100de977574b45b91117ac" title="A list of Visitors to be explicitly deleted when the destructor is called.">_visitorDeleteOnExitList</a>;
<a name="l00111"></a>00111 <span class="comment"></span>
<a name="l00112"></a>00112 <span class="comment"> /**</span>
<a name="l00113"></a>00113 <span class="comment"> * Object that handles all output for the CmdLine.</span>
<a name="l00114"></a>00114 <span class="comment"> */</span>
<a name="l00115"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a5152bf4ef26217583a3bc708aa0ea83e">00115</a> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line_output.html" title="The interface that any output object must implement.">CmdLineOutput</a>* <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a5152bf4ef26217583a3bc708aa0ea83e" title="Object that handles all output for the CmdLine.">_output</a>;
<a name="l00116"></a>00116 <span class="comment"></span>
<a name="l00117"></a>00117 <span class="comment"> /**</span>
<a name="l00118"></a>00118 <span class="comment"> * Checks whether a name/flag string matches entirely matches</span>
<a name="l00119"></a>00119 <span class="comment"> * the Arg::blankChar. Used when multiple switches are combined</span>
<a name="l00120"></a>00120 <span class="comment"> * into a single argument.</span>
<a name="l00121"></a>00121 <span class="comment"> * \param s - The message to be used in the usage.</span>
<a name="l00122"></a>00122 <span class="comment"> */</span>
<a name="l00123"></a>00123 <span class="keywordtype">bool</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a170a4e711c2a6d58a05e9ad3bc03c08a" title="Checks whether a name/flag string matches entirely matches the Arg::blankChar.">_emptyCombined</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>& s);
<a name="l00124"></a>00124 <span class="comment"></span>
<a name="l00125"></a>00125 <span class="comment"> /**</span>
<a name="l00126"></a>00126 <span class="comment"> * Perform a delete ptr; operation on ptr when this object is deleted.</span>
<a name="l00127"></a>00127 <span class="comment"> */</span>
<a name="l00128"></a>00128 <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a42d669ed2037ac24fc78883aa8600655" title="Perform a delete ptr; operation on ptr when this object is deleted.">deleteOnExit</a>(<a class="code" 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>* ptr);
<a name="l00129"></a>00129 <span class="comment"></span>
<a name="l00130"></a>00130 <span class="comment"> /**</span>
<a name="l00131"></a>00131 <span class="comment"> * Perform a delete ptr; operation on ptr when this object is deleted.</span>
<a name="l00132"></a>00132 <span class="comment"> */</span>
<a name="l00133"></a>00133 <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a42d669ed2037ac24fc78883aa8600655" title="Perform a delete ptr; operation on ptr when this object is deleted.">deleteOnExit</a>(<a class="code" href="class_t_c_l_a_p_1_1_visitor.html" title="A base class that defines the interface for visitors.">Visitor</a>* ptr);
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="keyword">private</span>:
<a name="l00136"></a>00136 <span class="comment"></span>
<a name="l00137"></a>00137 <span class="comment"> /**</span>
<a name="l00138"></a>00138 <span class="comment"> * Encapsulates the code common to the constructors (which is all</span>
<a name="l00139"></a>00139 <span class="comment"> * of it).</span>
<a name="l00140"></a>00140 <span class="comment"> */</span>
<a name="l00141"></a>00141 <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a955b1935c7b2e5118b2573bd2fbb958c" title="Encapsulates the code common to the constructors (which is all of it).">_constructor</a>();
<a name="l00142"></a>00142 <span class="comment"></span>
<a name="l00143"></a>00143 <span class="comment"> /**</span>
<a name="l00144"></a>00144 <span class="comment"> * Is set to true when a user sets the output object. We use this so</span>
<a name="l00145"></a>00145 <span class="comment"> * that we don't delete objects that are created outside of this lib.</span>
<a name="l00146"></a>00146 <span class="comment"> */</span>
<a name="l00147"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#ab78aec340244f230a41dd946d0138aba">00147</a> <span class="keywordtype">bool</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#ab78aec340244f230a41dd946d0138aba" title="Is set to true when a user sets the output object.">_userSetOutput</a>;
<a name="l00148"></a>00148 <span class="comment"></span>
<a name="l00149"></a>00149 <span class="comment"> /**</span>
<a name="l00150"></a>00150 <span class="comment"> * Whether or not to automatically create help and version switches.</span>
<a name="l00151"></a>00151 <span class="comment"> */</span>
<a name="l00152"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#aea29ec639729a22384ee8759069a5017">00152</a> <span class="keywordtype">bool</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#aea29ec639729a22384ee8759069a5017" title="Whether or not to automatically create help and version switches.">_helpAndVersion</a>;
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="keyword">public</span>:
<a name="l00155"></a>00155 <span class="comment"></span>
<a name="l00156"></a>00156 <span class="comment"> /**</span>
<a name="l00157"></a>00157 <span class="comment"> * Command line constructor. Defines how the arguments will be</span>
<a name="l00158"></a>00158 <span class="comment"> * parsed.</span>
<a name="l00159"></a>00159 <span class="comment"> * \param message - The message to be used in the usage</span>
<a name="l00160"></a>00160 <span class="comment"> * output.</span>
<a name="l00161"></a>00161 <span class="comment"> * \param delimiter - The character that is used to separate</span>
<a name="l00162"></a>00162 <span class="comment"> * the argument flag/name from the value. Defaults to ' ' (space).</span>
<a name="l00163"></a>00163 <span class="comment"> * \param version - The version number to be used in the</span>
<a name="l00164"></a>00164 <span class="comment"> * --version switch.</span>
<a name="l00165"></a>00165 <span class="comment"> * \param helpAndVersion - Whether or not to create the Help and</span>
<a name="l00166"></a>00166 <span class="comment"> * Version switches. Defaults to true.</span>
<a name="l00167"></a>00167 <span class="comment"> */</span>
<a name="l00168"></a>00168 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a2e62a3493f8700afb49a7deb872a5b96" title="Command line constructor.">CmdLine</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>& message,
<a name="l00169"></a>00169 <span class="keyword">const</span> <span class="keywordtype">char</span> delimiter = <span class="charliteral">' '</span>,
<a name="l00170"></a>00170 <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>& version = <span class="stringliteral">"none"</span>,
<a name="l00171"></a>00171 <span class="keywordtype">bool</span> helpAndVersion = <span class="keyword">true</span>);
<a name="l00172"></a>00172 <span class="comment"></span>
<a name="l00173"></a>00173 <span class="comment"> /**</span>
<a name="l00174"></a>00174 <span class="comment"> * Deletes any resources allocated by a CmdLine object.</span>
<a name="l00175"></a>00175 <span class="comment"> */</span>
<a name="l00176"></a>00176 <span class="keyword">virtual</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a8a7bddba32c3d96e2a01e4c8e160e6fa" title="Deletes any resources allocated by a CmdLine object.">~CmdLine</a>();
<a name="l00177"></a>00177 <span class="comment"></span>
<a name="l00178"></a>00178 <span class="comment"> /**</span>
<a name="l00179"></a>00179 <span class="comment"> * Adds an argument to the list of arguments to be parsed.</span>
<a name="l00180"></a>00180 <span class="comment"> * \param a - Argument to be added.</span>
<a name="l00181"></a>00181 <span class="comment"> */</span>
<a name="l00182"></a>00182 <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a94c511d4735ad9b8c97edaa3827f8bbf" title="Adds an argument to the list of arguments to be parsed.">add</a>( <a class="code" 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>& a );
<a name="l00183"></a>00183 <span class="comment"></span>
<a name="l00184"></a>00184 <span class="comment"> /**</span>
<a name="l00185"></a>00185 <span class="comment"> * An alternative add. Functionally identical.</span>
<a name="l00186"></a>00186 <span class="comment"> * \param a - Argument to be added.</span>
<a name="l00187"></a>00187 <span class="comment"> */</span>
<a name="l00188"></a>00188 <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a94c511d4735ad9b8c97edaa3827f8bbf" title="Adds an argument to the list of arguments to be parsed.">add</a>( <a class="code" 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>* a );
<a name="l00189"></a>00189 <span class="comment"></span>
<a name="l00190"></a>00190 <span class="comment"> /**</span>
<a name="l00191"></a>00191 <span class="comment"> * Add two Args that will be xor'd. If this method is used, add does</span>
<a name="l00192"></a>00192 <span class="comment"> * not need to be called.</span>
<a name="l00193"></a>00193 <span class="comment"> * \param a - Argument to be added and xor'd.</span>
<a name="l00194"></a>00194 <span class="comment"> * \param b - Argument to be added and xor'd.</span>
<a name="l00195"></a>00195 <span class="comment"> */</span>
<a name="l00196"></a>00196 <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#afbaa2071d0c3276b383089acabdc0dd2" title="Add two Args that will be xor'd.">xorAdd</a>( <a class="code" 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>& a, <a class="code" 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>& b );
<a name="l00197"></a>00197 <span class="comment"></span>
<a name="l00198"></a>00198 <span class="comment"> /**</span>
<a name="l00199"></a>00199 <span class="comment"> * Add a list of Args that will be xor'd. If this method is used,</span>
<a name="l00200"></a>00200 <span class="comment"> * add does not need to be called.</span>
<a name="l00201"></a>00201 <span class="comment"> * \param xors - List of Args to be added and xor'd.</span>
<a name="l00202"></a>00202 <span class="comment"> */</span>
<a name="l00203"></a>00203 <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#afbaa2071d0c3276b383089acabdc0dd2" title="Add two Args that will be xor'd.">xorAdd</a>( <a class="code" href="classstd_1_1vector.html" title="STL class.">std::vector<Arg*></a>& xors );
<a name="l00204"></a>00204 <span class="comment"></span>
<a name="l00205"></a>00205 <span class="comment"> /**</span>
<a name="l00206"></a>00206 <span class="comment"> * Parses the command line.</span>
<a name="l00207"></a>00207 <span class="comment"> * \param argc - Number of arguments.</span>
<a name="l00208"></a>00208 <span class="comment"> * \param argv - Array of arguments.</span>
<a name="l00209"></a>00209 <span class="comment"> * \return (Added by JLBC for MRPT): Return false if the program should exit (error in args, it was --help, etc...)</span>
<a name="l00210"></a>00210 <span class="comment"> */</span>
<a name="l00211"></a>00211 <span class="keywordtype">bool</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#af84dff8ae4966e799ec033129e5a058b" title="Parses the command line.">parse</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv);
<a name="l00212"></a>00212 <span class="comment"></span>
<a name="l00213"></a>00213 <span class="comment"> /**</span>
<a name="l00214"></a>00214 <span class="comment"> *</span>
<a name="l00215"></a>00215 <span class="comment"> */</span>
<a name="l00216"></a>00216 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line_output.html" title="The interface that any output object must implement.">CmdLineOutput</a>* <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#ad8aea2617edf53bbc20c8964ee5476e6" title="Returns the CmdLineOutput object.">getOutput</a>();
<a name="l00217"></a>00217 <span class="comment"></span>
<a name="l00218"></a>00218 <span class="comment"> /**</span>
<a name="l00219"></a>00219 <span class="comment"> *</span>
<a name="l00220"></a>00220 <span class="comment"> */</span>
<a name="l00221"></a>00221 <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a4506e305cd10437c7ce5a5ba34cfed0f">setOutput</a>(<a class="code" href="class_t_c_l_a_p_1_1_cmd_line_output.html" title="The interface that any output object must implement.">CmdLineOutput</a>* co);
<a name="l00222"></a>00222 <span class="comment"></span>
<a name="l00223"></a>00223 <span class="comment"> /**</span>
<a name="l00224"></a>00224 <span class="comment"> *</span>
<a name="l00225"></a>00225 <span class="comment"> */</span>
<a name="l00226"></a>00226 std::string& <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a85b5653d1a5b48fe6accead64615cf33" title="Returns the version string.">getVersion</a>();
<a name="l00227"></a>00227 <span class="comment"></span>
<a name="l00228"></a>00228 <span class="comment"> /**</span>
<a name="l00229"></a>00229 <span class="comment"> *</span>
<a name="l00230"></a>00230 <span class="comment"> */</span>
<a name="l00231"></a>00231 std::string& <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a47a6d496980ee11ffc42e27144a61797" title="Returns the program name string.">getProgramName</a>();
<a name="l00232"></a>00232 <span class="comment"></span>
<a name="l00233"></a>00233 <span class="comment"> /**</span>
<a name="l00234"></a>00234 <span class="comment"> *</span>
<a name="l00235"></a>00235 <span class="comment"> */</span>
<a name="l00236"></a>00236 std::list<Arg*>& <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a3c281da929a281fb883ea47632b7ad38" title="Returns the argList.">getArgList</a>();
<a name="l00237"></a>00237 <span class="comment"></span>
<a name="l00238"></a>00238 <span class="comment"> /**</span>
<a name="l00239"></a>00239 <span class="comment"> *</span>
<a name="l00240"></a>00240 <span class="comment"> */</span>
<a name="l00241"></a>00241 <a class="code" 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 class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a805433b7718d1bc5bc9317bbd061449b" title="Returns the XorHandler.">getXorHandler</a>();
<a name="l00242"></a>00242 <span class="comment"></span>
<a name="l00243"></a>00243 <span class="comment"> /**</span>
<a name="l00244"></a>00244 <span class="comment"> *</span>
<a name="l00245"></a>00245 <span class="comment"> */</span>
<a name="l00246"></a>00246 <span class="keywordtype">char</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a3e9f0ac2c1e97d1f8527da713ddd5a8f" title="Returns the delimiter string.">getDelimiter</a>();
<a name="l00247"></a>00247 <span class="comment"></span>
<a name="l00248"></a>00248 <span class="comment"> /**</span>
<a name="l00249"></a>00249 <span class="comment"> *</span>
<a name="l00250"></a>00250 <span class="comment"> */</span>
<a name="l00251"></a>00251 std::string& <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a8f61a8c201e31ada985fa998180fd40f" title="Returns the message string.">getMessage</a>();
<a name="l00252"></a>00252 <span class="comment"></span>
<a name="l00253"></a>00253 <span class="comment"> /**</span>
<a name="l00254"></a>00254 <span class="comment"> *</span>
<a name="l00255"></a>00255 <span class="comment"> */</span>
<a name="l00256"></a>00256 <span class="keywordtype">bool</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a5b23895feae4f4110b77dae372226475" title="Indicates whether or not the help and version switches were created automatically.">hasHelpAndVersion</a>();
<a name="l00257"></a>00257 };
<a name="l00258"></a>00258
<a name="l00259"></a>00259 <span class="comment"></span>
<a name="l00260"></a>00260 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
<a name="l00261"></a>00261 <span class="comment"></span><span class="comment">//Begin CmdLine.cpp</span><span class="comment"></span>
<a name="l00262"></a>00262 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
<a name="l00263"></a>00263 <span class="comment"></span>
<a name="l00264"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a2e62a3493f8700afb49a7deb872a5b96">00264</a> <span class="keyword">inline</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a2e62a3493f8700afb49a7deb872a5b96" title="Command line constructor.">CmdLine::CmdLine</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>& m,
<a name="l00265"></a>00265 <span class="keywordtype">char</span> delim,
<a name="l00266"></a>00266 <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>& v,
<a name="l00267"></a>00267 <span class="keywordtype">bool</span> help )
<a name="l00268"></a>00268 : _progName(<span class="stringliteral">"not_set_yet"</span>),
<a name="l00269"></a>00269 _message(m),
<a name="l00270"></a>00270 _version(v),
<a name="l00271"></a>00271 _numRequired(0),
<a name="l00272"></a>00272 _delimiter(delim),
<a name="l00273"></a>00273 _userSetOutput(false),
<a name="l00274"></a>00274 _helpAndVersion(help)
<a name="l00275"></a>00275 {
<a name="l00276"></a>00276 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a955b1935c7b2e5118b2573bd2fbb958c" title="Encapsulates the code common to the constructors (which is all of it).">_constructor</a>();
<a name="l00277"></a>00277 }
<a name="l00278"></a>00278
<a name="l00279"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a8a7bddba32c3d96e2a01e4c8e160e6fa">00279</a> <span class="keyword">inline</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a8a7bddba32c3d96e2a01e4c8e160e6fa" title="Deletes any resources allocated by a CmdLine object.">CmdLine::~CmdLine</a>()
<a name="l00280"></a>00280 {
<a name="l00281"></a>00281 <a class="code" href="classstd_1_1list_1_1iterator.html" title="STL iterator class.">ArgListIterator</a> argIter;
<a name="l00282"></a>00282 <a class="code" href="classstd_1_1list_1_1iterator.html" title="STL iterator class.">VisitorListIterator</a> visIter;
<a name="l00283"></a>00283
<a name="l00284"></a>00284 <span class="keywordflow">for</span>( argIter = <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#af8d37fbf9d0b60b6acbd737af380f3e5" title="A list of Args to be explicitly deleted when the destructor is called.">_argDeleteOnExitList</a>.begin();
<a name="l00285"></a>00285 argIter != <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#af8d37fbf9d0b60b6acbd737af380f3e5" title="A list of Args to be explicitly deleted when the destructor is called.">_argDeleteOnExitList</a>.end();
<a name="l00286"></a>00286 ++argIter)
<a name="l00287"></a>00287 <span class="keyword">delete</span> *argIter;
<a name="l00288"></a>00288
<a name="l00289"></a>00289 <span class="keywordflow">for</span>( visIter = <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a79b8a947f8100de977574b45b91117ac" title="A list of Visitors to be explicitly deleted when the destructor is called.">_visitorDeleteOnExitList</a>.begin();
<a name="l00290"></a>00290 visIter != <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a79b8a947f8100de977574b45b91117ac" title="A list of Visitors to be explicitly deleted when the destructor is called.">_visitorDeleteOnExitList</a>.end();
<a name="l00291"></a>00291 ++visIter)
<a name="l00292"></a>00292 <span class="keyword">delete</span> *visIter;
<a name="l00293"></a>00293
<a name="l00294"></a>00294 <span class="keywordflow">if</span> ( !<a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#ab78aec340244f230a41dd946d0138aba" title="Is set to true when a user sets the output object.">_userSetOutput</a> )
<a name="l00295"></a>00295 <span class="keyword">delete</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a5152bf4ef26217583a3bc708aa0ea83e" title="Object that handles all output for the CmdLine.">_output</a>;
<a name="l00296"></a>00296 }
<a name="l00297"></a>00297
<a name="l00298"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a955b1935c7b2e5118b2573bd2fbb958c">00298</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a955b1935c7b2e5118b2573bd2fbb958c" title="Encapsulates the code common to the constructors (which is all of it).">CmdLine::_constructor</a>()
<a name="l00299"></a>00299 {
<a name="l00300"></a>00300 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a5152bf4ef26217583a3bc708aa0ea83e" title="Object that handles all output for the CmdLine.">_output</a> = <span class="keyword">new</span> <a class="code" href="class_t_c_l_a_p_1_1_std_output.html" title="A class that isolates any output from the CmdLine object so that it may be easily modified...">StdOutput</a>;
<a name="l00301"></a>00301
<a name="l00302"></a>00302 <a class="code" href="class_t_c_l_a_p_1_1_arg.html#ad059b63424001b9aedb4c019e2854c3c" title="Sets the delimiter for all arguments.">Arg::setDelimiter</a>( <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a602e65692dc07ea872134f354026a54f" title="The character that is used to separate the argument flag/name from the value.">_delimiter</a> );
<a name="l00303"></a>00303
<a name="l00304"></a>00304 <a class="code" href="class_t_c_l_a_p_1_1_visitor.html" title="A base class that defines the interface for visitors.">Visitor</a>* v;
<a name="l00305"></a>00305
<a name="l00306"></a>00306 <span class="keywordflow">if</span> ( <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#aea29ec639729a22384ee8759069a5017" title="Whether or not to automatically create help and version switches.">_helpAndVersion</a> )
<a name="l00307"></a>00307 {
<a name="l00308"></a>00308 v = <span class="keyword">new</span> <a class="code" href="class_t_c_l_a_p_1_1_help_visitor.html" title="A Visitor object that calls the usage method of the given CmdLineOutput object for the specified CmdL...">HelpVisitor</a>( <span class="keyword">this</span>, &<a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a5152bf4ef26217583a3bc708aa0ea83e" title="Object that handles all output for the CmdLine.">_output</a> );
<a name="l00309"></a>00309 <a class="code" href="class_t_c_l_a_p_1_1_switch_arg.html" title="A simple switch argument.">SwitchArg</a>* help = <span class="keyword">new</span> <a class="code" href="class_t_c_l_a_p_1_1_switch_arg.html" title="A simple switch argument.">SwitchArg</a>(<span class="stringliteral">"h"</span>,<span class="stringliteral">"help"</span>,
<a name="l00310"></a>00310 <span class="stringliteral">"Displays usage information and exits."</span>,
<a name="l00311"></a>00311 <span class="keyword">false</span>, v);
<a name="l00312"></a>00312 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a94c511d4735ad9b8c97edaa3827f8bbf" title="Adds an argument to the list of arguments to be parsed.">add</a>( help );
<a name="l00313"></a>00313 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a42d669ed2037ac24fc78883aa8600655" title="Perform a delete ptr; operation on ptr when this object is deleted.">deleteOnExit</a>(help);
<a name="l00314"></a>00314 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a42d669ed2037ac24fc78883aa8600655" title="Perform a delete ptr; operation on ptr when this object is deleted.">deleteOnExit</a>(v);
<a name="l00315"></a>00315
<a name="l00316"></a>00316 v = <span class="keyword">new</span> <a class="code" href="class_t_c_l_a_p_1_1_version_visitor.html" title="A Vistor that will call the version method of the given CmdLineOutput for the specified CmdLine objec...">VersionVisitor</a>( <span class="keyword">this</span>, &<a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a5152bf4ef26217583a3bc708aa0ea83e" title="Object that handles all output for the CmdLine.">_output</a> );
<a name="l00317"></a>00317 <a class="code" href="class_t_c_l_a_p_1_1_switch_arg.html" title="A simple switch argument.">SwitchArg</a>* vers = <span class="keyword">new</span> <a class="code" href="class_t_c_l_a_p_1_1_switch_arg.html" title="A simple switch argument.">SwitchArg</a>(<span class="stringliteral">""</span>,<span class="stringliteral">"version"</span>,
<a name="l00318"></a>00318 <span class="stringliteral">"Displays version information and exits."</span>,
<a name="l00319"></a>00319 <span class="keyword">false</span>, v);
<a name="l00320"></a>00320 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a94c511d4735ad9b8c97edaa3827f8bbf" title="Adds an argument to the list of arguments to be parsed.">add</a>( vers );
<a name="l00321"></a>00321 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a42d669ed2037ac24fc78883aa8600655" title="Perform a delete ptr; operation on ptr when this object is deleted.">deleteOnExit</a>(vers);
<a name="l00322"></a>00322 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a42d669ed2037ac24fc78883aa8600655" title="Perform a delete ptr; operation on ptr when this object is deleted.">deleteOnExit</a>(v);
<a name="l00323"></a>00323 }
<a name="l00324"></a>00324
<a name="l00325"></a>00325 v = <span class="keyword">new</span> <a class="code" href="class_t_c_l_a_p_1_1_ignore_rest_visitor.html" title="A Vistor that tells the CmdLine to begin ignoring arguments after this one is parsed.">IgnoreRestVisitor</a>();
<a name="l00326"></a>00326 <a class="code" href="class_t_c_l_a_p_1_1_switch_arg.html" title="A simple switch argument.">SwitchArg</a>* ignore = <span class="keyword">new</span> <a class="code" href="class_t_c_l_a_p_1_1_switch_arg.html" title="A simple switch argument.">SwitchArg</a>(<a class="code" href="class_t_c_l_a_p_1_1_arg.html#af8e739295b0f75028e7bff6d670d97a1" title="The sting that indicates the beginning of a flag.">Arg::flagStartString</a>(),
<a name="l00327"></a>00327 <a class="code" href="class_t_c_l_a_p_1_1_arg.html#a6ce0cbe4effd44679ca11f25e3c318e7" title="The name used to identify the ignore rest argument.">Arg::ignoreNameString</a>(),
<a name="l00328"></a>00328 <span class="stringliteral">"Ignores the rest of the labeled arguments following this flag."</span>,
<a name="l00329"></a>00329 <span class="keyword">false</span>, v);
<a name="l00330"></a>00330 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a94c511d4735ad9b8c97edaa3827f8bbf" title="Adds an argument to the list of arguments to be parsed.">add</a>( ignore );
<a name="l00331"></a>00331 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a42d669ed2037ac24fc78883aa8600655" title="Perform a delete ptr; operation on ptr when this object is deleted.">deleteOnExit</a>(ignore);
<a name="l00332"></a>00332 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a42d669ed2037ac24fc78883aa8600655" title="Perform a delete ptr; operation on ptr when this object is deleted.">deleteOnExit</a>(v);
<a name="l00333"></a>00333 }
<a name="l00334"></a>00334
<a name="l00335"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#ac7f2d7ee32a5157f625ad9833ab148cf">00335</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#afbaa2071d0c3276b383089acabdc0dd2" title="Add two Args that will be xor'd.">CmdLine::xorAdd</a>( <a class="code" href="classstd_1_1vector.html" title="STL class.">std::vector<Arg*></a>& ors )
<a name="l00336"></a>00336 {
<a name="l00337"></a>00337 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a33846aa10c62ecd61640c93c16ac315d" title="The handler that manages xoring lists of args.">_xorHandler</a>.<a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a76f156bf36a8aede334801aa242f31b9" title="Add a list of Arg*'s that will be orred together.">add</a>( ors );
<a name="l00338"></a>00338
<a name="l00339"></a>00339 <span class="keywordflow">for</span> (<a class="code" href="classstd_1_1vector_1_1iterator.html" title="STL iterator class.">ArgVectorIterator</a> it = ors.begin(); it != ors.end(); it++)
<a name="l00340"></a>00340 {
<a name="l00341"></a>00341 (*it)->forceRequired();
<a name="l00342"></a>00342 (*it)->setRequireLabel( <span class="stringliteral">"OR required"</span> );
<a name="l00343"></a>00343
<a name="l00344"></a>00344 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a94c511d4735ad9b8c97edaa3827f8bbf" title="Adds an argument to the list of arguments to be parsed.">add</a>( *it );
<a name="l00345"></a>00345 }
<a name="l00346"></a>00346 }
<a name="l00347"></a>00347
<a name="l00348"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#afbaa2071d0c3276b383089acabdc0dd2">00348</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#afbaa2071d0c3276b383089acabdc0dd2" title="Add two Args that will be xor'd.">CmdLine::xorAdd</a>( <a class="code" 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>& a, <a class="code" 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>& b )
<a name="l00349"></a>00349 {
<a name="l00350"></a>00350 std::vector<Arg*> ors;
<a name="l00351"></a>00351 ors.push_back( &a );
<a name="l00352"></a>00352 ors.push_back( &b );
<a name="l00353"></a>00353 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#afbaa2071d0c3276b383089acabdc0dd2" title="Add two Args that will be xor'd.">xorAdd</a>( ors );
<a name="l00354"></a>00354 }
<a name="l00355"></a>00355
<a name="l00356"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a94c511d4735ad9b8c97edaa3827f8bbf">00356</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a94c511d4735ad9b8c97edaa3827f8bbf" title="Adds an argument to the list of arguments to be parsed.">CmdLine::add</a>( <a class="code" 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>& a )
<a name="l00357"></a>00357 {
<a name="l00358"></a>00358 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a94c511d4735ad9b8c97edaa3827f8bbf" title="Adds an argument to the list of arguments to be parsed.">add</a>( &a );
<a name="l00359"></a>00359 }
<a name="l00360"></a>00360
<a name="l00361"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#ab8a08e8f4d3ca7709c85416f76e805a3">00361</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a94c511d4735ad9b8c97edaa3827f8bbf" title="Adds an argument to the list of arguments to be parsed.">CmdLine::add</a>( <a class="code" 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>* a )
<a name="l00362"></a>00362 {
<a name="l00363"></a>00363 <span class="keywordflow">for</span>( <a class="code" href="classstd_1_1list_1_1iterator.html" title="STL iterator class.">ArgListIterator</a> it = <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a4d70f73542d8184e077688bff3801baf" title="The list of arguments that will be tested against the command line.">_argList</a>.begin(); it != <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a4d70f73542d8184e077688bff3801baf" title="The list of arguments that will be tested against the command line.">_argList</a>.end(); it++ )
<a name="l00364"></a>00364 <span class="keywordflow">if</span> ( *a == *(*it) )
<a name="l00365"></a>00365 <span class="keywordflow">throw</span>( <a class="code" href="class_t_c_l_a_p_1_1_specification_exception.html" title="Thrown from Arg and CmdLine when an Arg is improperly specified, e.g.">SpecificationException</a>(
<a name="l00366"></a>00366 <span class="stringliteral">"Argument with same flag/name already exists!"</span>,
<a name="l00367"></a>00367 a-><a class="code" href="class_t_c_l_a_p_1_1_arg.html#aad93aff46e1fc67e3853765f565bfa96" title="Returns a long ID for the usage.">longID</a>() ) );
<a name="l00368"></a>00368
<a name="l00369"></a>00369 a-><a class="code" href="class_t_c_l_a_p_1_1_arg.html#a9ff1564beeea2ef855f7fa483c37d0e2" title="Adds this to the specified list of Args.">addToList</a>( <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a4d70f73542d8184e077688bff3801baf" title="The list of arguments that will be tested against the command line.">_argList</a> );
<a name="l00370"></a>00370
<a name="l00371"></a>00371 <span class="keywordflow">if</span> ( a-><a class="code" href="class_t_c_l_a_p_1_1_arg.html#a00a3cfdb2b6e9a111ad39cbd4978b96c" title="Indicates whether the argument is required.">isRequired</a>() )
<a name="l00372"></a>00372 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a2285207b528d5fad18c82a2ee8155f37" title="The number of arguments that are required to be present on the command line.">_numRequired</a>++;
<a name="l00373"></a>00373 }
<a name="l00374"></a>00374
<a name="l00375"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#af84dff8ae4966e799ec033129e5a058b">00375</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#af84dff8ae4966e799ec033129e5a058b" title="Parses the command line.">CmdLine::parse</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv)
<a name="l00376"></a>00376 {
<a name="l00377"></a>00377 <span class="keywordflow">try</span> {
<a name="l00378"></a>00378
<a name="l00379"></a>00379 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a8b856dadc54fa30d0dddba4588ef9344" title="The name of the program.">_progName</a> = argv[0];
<a name="l00380"></a>00380
<a name="l00381"></a>00381 <span class="comment">// this step is necessary so that we have easy access to mutable strings.</span>
<a name="l00382"></a>00382 std::vector<std::string> args;
<a name="l00383"></a>00383 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 1; i < argc; i++)
<a name="l00384"></a>00384 args.push_back(argv[i]);
<a name="l00385"></a>00385
<a name="l00386"></a>00386 <span class="keywordtype">int</span> requiredCount = 0;
<a name="l00387"></a>00387
<a name="l00388"></a>00388 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; <span class="keyword">static_cast<</span><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span><span class="keyword">></span>(i) < args.size(); i++)
<a name="l00389"></a>00389 {
<a name="l00390"></a>00390 <span class="keywordtype">bool</span> matched = <span class="keyword">false</span>;
<a name="l00391"></a>00391 <span class="keywordflow">for</span> (<a class="code" href="classstd_1_1list_1_1iterator.html" title="STL iterator class.">ArgListIterator</a> it = <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a4d70f73542d8184e077688bff3801baf" title="The list of arguments that will be tested against the command line.">_argList</a>.begin(); it != <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a4d70f73542d8184e077688bff3801baf" title="The list of arguments that will be tested against the command line.">_argList</a>.end(); it++)
<a name="l00392"></a>00392 {
<a name="l00393"></a>00393 <span class="keywordflow">if</span> ( (*it)->processArg( &i, args ) )
<a name="l00394"></a>00394 {
<a name="l00395"></a>00395 requiredCount += <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a33846aa10c62ecd61640c93c16ac315d" title="The handler that manages xoring lists of args.">_xorHandler</a>.<a class="code" href="class_t_c_l_a_p_1_1_xor_handler.html#a3df7722e4c4c5d331de69fc902336b00" title="Checks whether the specified Arg is in one of the xor lists and if it does match one, returns the size of the xor list that the Arg matched.">check</a>( *it );
<a name="l00396"></a>00396 matched = <span class="keyword">true</span>;
<a name="l00397"></a>00397 <span class="keywordflow">break</span>;
<a name="l00398"></a>00398 }
<a name="l00399"></a>00399 }
<a name="l00400"></a>00400
<a name="l00401"></a>00401 <span class="comment">// checks to see if the argument is an empty combined switch ...</span>
<a name="l00402"></a>00402 <span class="comment">// and if so, then we've actually matched it</span>
<a name="l00403"></a>00403 <span class="keywordflow">if</span> ( !matched && <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a170a4e711c2a6d58a05e9ad3bc03c08a" title="Checks whether a name/flag string matches entirely matches the Arg::blankChar.">_emptyCombined</a>( args[i] ) )
<a name="l00404"></a>00404 matched = <span class="keyword">true</span>;
<a name="l00405"></a>00405
<a name="l00406"></a>00406 <span class="keywordflow">if</span> ( !matched && !<a class="code" href="class_t_c_l_a_p_1_1_arg.html#a4d412155b8f9b4956e64e91c48e55a3b" title="Whether to ignore the rest.">Arg::ignoreRest</a>() )
<a name="l00407"></a>00407 <span class="keywordflow">throw</span>(<a class="code" href="class_t_c_l_a_p_1_1_cmd_line_parse_exception.html" title="Thrown from CmdLine when the arguments on the command line are not properly specified, e.g.">CmdLineParseException</a>(<span class="stringliteral">"Couldn't find match for argument"</span>,
<a name="l00408"></a>00408 args[i]));
<a name="l00409"></a>00409 }
<a name="l00410"></a>00410
<a name="l00411"></a>00411 <span class="keywordflow">if</span> ( requiredCount < <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a2285207b528d5fad18c82a2ee8155f37" title="The number of arguments that are required to be present on the command line.">_numRequired</a> )
<a name="l00412"></a>00412 <span class="keywordflow">throw</span>(<a class="code" href="class_t_c_l_a_p_1_1_cmd_line_parse_exception.html" title="Thrown from CmdLine when the arguments on the command line are not properly specified, e.g.">CmdLineParseException</a>(<span class="stringliteral">"One or more required arguments missing!"</span>));
<a name="l00413"></a>00413
<a name="l00414"></a>00414 <span class="keywordflow">if</span> ( requiredCount > <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a2285207b528d5fad18c82a2ee8155f37" title="The number of arguments that are required to be present on the command line.">_numRequired</a> )
<a name="l00415"></a>00415 <span class="keywordflow">throw</span>(<a class="code" href="class_t_c_l_a_p_1_1_cmd_line_parse_exception.html" title="Thrown from CmdLine when the arguments on the command line are not properly specified, e.g.">CmdLineParseException</a>(<span class="stringliteral">"Too many arguments!"</span>));
<a name="l00416"></a>00416
<a name="l00417"></a>00417 <span class="keywordflow">return</span> <span class="keyword">true</span>; <span class="comment">// Ok</span>
<a name="l00418"></a>00418
<a name="l00419"></a>00419 }
<a name="l00420"></a>00420 <span class="keywordflow">catch</span> ( <a class="code" href="class_t_c_l_a_p_1_1_action_done_exception.html" title="(Added by JLBC for MRPT): An exception that indicates to CmdLine::parse that help,version,...">ActionDoneException</a> e )
<a name="l00421"></a>00421 {
<a name="l00422"></a>00422 <span class="keywordflow">return</span> <span class="keyword">false</span>; <span class="comment">// Done</span>
<a name="l00423"></a>00423 }
<a name="l00424"></a>00424 <span class="keywordflow">catch</span> ( <a class="code" href="class_t_c_l_a_p_1_1_arg_exception.html" title="A simple class that defines and argument exception.">ArgException</a> e )
<a name="l00425"></a>00425 {
<a name="l00426"></a>00426 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a5152bf4ef26217583a3bc708aa0ea83e" title="Object that handles all output for the CmdLine.">_output</a>-><a class="code" href="class_t_c_l_a_p_1_1_cmd_line_output.html#ad23a57ac3d8d957a4328fc78aec94e16" title="Generates some sort of output for a failure.">failure</a>(*<span class="keyword">this</span>,e);
<a name="l00427"></a>00427 <span class="keywordflow">return</span> <span class="keyword">false</span>; <span class="comment">// Error </span>
<a name="l00428"></a>00428 }
<a name="l00429"></a>00429 }
<a name="l00430"></a>00430
<a name="l00431"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a170a4e711c2a6d58a05e9ad3bc03c08a">00431</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a170a4e711c2a6d58a05e9ad3bc03c08a" title="Checks whether a name/flag string matches entirely matches the Arg::blankChar.">CmdLine::_emptyCombined</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>& s)
<a name="l00432"></a>00432 {
<a name="l00433"></a>00433 <span class="keywordflow">if</span> ( s[0] != <a class="code" href="class_t_c_l_a_p_1_1_arg.html#ad270774ee5dba351c988df53d87a3b0f" title="The char that indicates the beginning of a flag.">Arg::flagStartChar</a>() )
<a name="l00434"></a>00434 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00435"></a>00435
<a name="l00436"></a>00436 <span class="keywordflow">for</span> ( <span class="keywordtype">int</span> i = 1; <span class="keyword">static_cast<</span><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span><span class="keyword">></span>(i) < s.length(); i++ )
<a name="l00437"></a>00437 <span class="keywordflow">if</span> ( s[i] != <a class="code" 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 name="l00438"></a>00438 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00439"></a>00439
<a name="l00440"></a>00440 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00441"></a>00441 }
<a name="l00442"></a>00442
<a name="l00443"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a42d669ed2037ac24fc78883aa8600655">00443</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a42d669ed2037ac24fc78883aa8600655" title="Perform a delete ptr; operation on ptr when this object is deleted.">CmdLine::deleteOnExit</a>(<a class="code" 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>* ptr)
<a name="l00444"></a>00444 {
<a name="l00445"></a>00445 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#af8d37fbf9d0b60b6acbd737af380f3e5" title="A list of Args to be explicitly deleted when the destructor is called.">_argDeleteOnExitList</a>.push_back(ptr);
<a name="l00446"></a>00446 }
<a name="l00447"></a>00447
<a name="l00448"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a262b8d929eb5b0dfbfc17637c1325c36">00448</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a42d669ed2037ac24fc78883aa8600655" title="Perform a delete ptr; operation on ptr when this object is deleted.">CmdLine::deleteOnExit</a>(<a class="code" href="class_t_c_l_a_p_1_1_visitor.html" title="A base class that defines the interface for visitors.">Visitor</a>* ptr)
<a name="l00449"></a>00449 {
<a name="l00450"></a>00450 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a79b8a947f8100de977574b45b91117ac" title="A list of Visitors to be explicitly deleted when the destructor is called.">_visitorDeleteOnExitList</a>.push_back(ptr);
<a name="l00451"></a>00451 }
<a name="l00452"></a>00452
<a name="l00453"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#ad8aea2617edf53bbc20c8964ee5476e6">00453</a> <span class="keyword">inline</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line_output.html" title="The interface that any output object must implement.">CmdLineOutput</a>* <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#ad8aea2617edf53bbc20c8964ee5476e6" title="Returns the CmdLineOutput object.">CmdLine::getOutput</a>()
<a name="l00454"></a>00454 {
<a name="l00455"></a>00455 <span class="keywordflow">return</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a5152bf4ef26217583a3bc708aa0ea83e" title="Object that handles all output for the CmdLine.">_output</a>;
<a name="l00456"></a>00456 }
<a name="l00457"></a>00457
<a name="l00458"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a4506e305cd10437c7ce5a5ba34cfed0f">00458</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a4506e305cd10437c7ce5a5ba34cfed0f">CmdLine::setOutput</a>(<a class="code" href="class_t_c_l_a_p_1_1_cmd_line_output.html" title="The interface that any output object must implement.">CmdLineOutput</a>* co)
<a name="l00459"></a>00459 {
<a name="l00460"></a>00460 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#ab78aec340244f230a41dd946d0138aba" title="Is set to true when a user sets the output object.">_userSetOutput</a> = <span class="keyword">true</span>;
<a name="l00461"></a>00461 <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a5152bf4ef26217583a3bc708aa0ea83e" title="Object that handles all output for the CmdLine.">_output</a> = co;
<a name="l00462"></a>00462 }
<a name="l00463"></a>00463
<a name="l00464"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a85b5653d1a5b48fe6accead64615cf33">00464</a> <span class="keyword">inline</span> std::string& <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a85b5653d1a5b48fe6accead64615cf33" title="Returns the version string.">CmdLine::getVersion</a>()
<a name="l00465"></a>00465 {
<a name="l00466"></a>00466 <span class="keywordflow">return</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a2b2b52fffed2dcb7df3cdfc582ec8fd1" title="The version to be displayed with the --version switch.">_version</a>;
<a name="l00467"></a>00467 }
<a name="l00468"></a>00468
<a name="l00469"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a47a6d496980ee11ffc42e27144a61797">00469</a> <span class="keyword">inline</span> std::string& <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a47a6d496980ee11ffc42e27144a61797" title="Returns the program name string.">CmdLine::getProgramName</a>()
<a name="l00470"></a>00470 {
<a name="l00471"></a>00471 <span class="keywordflow">return</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a8b856dadc54fa30d0dddba4588ef9344" title="The name of the program.">_progName</a>;
<a name="l00472"></a>00472 }
<a name="l00473"></a>00473
<a name="l00474"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a3c281da929a281fb883ea47632b7ad38">00474</a> <span class="keyword">inline</span> std::list<Arg*>& <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a3c281da929a281fb883ea47632b7ad38" title="Returns the argList.">CmdLine::getArgList</a>()
<a name="l00475"></a>00475 {
<a name="l00476"></a>00476 <span class="keywordflow">return</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a4d70f73542d8184e077688bff3801baf" title="The list of arguments that will be tested against the command line.">_argList</a>;
<a name="l00477"></a>00477 }
<a name="l00478"></a>00478
<a name="l00479"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a805433b7718d1bc5bc9317bbd061449b">00479</a> <span class="keyword">inline</span> <a class="code" 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 class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a805433b7718d1bc5bc9317bbd061449b" title="Returns the XorHandler.">CmdLine::getXorHandler</a>()
<a name="l00480"></a>00480 {
<a name="l00481"></a>00481 <span class="keywordflow">return</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a33846aa10c62ecd61640c93c16ac315d" title="The handler that manages xoring lists of args.">_xorHandler</a>;
<a name="l00482"></a>00482 }
<a name="l00483"></a>00483
<a name="l00484"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a3e9f0ac2c1e97d1f8527da713ddd5a8f">00484</a> <span class="keyword">inline</span> <span class="keywordtype">char</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a3e9f0ac2c1e97d1f8527da713ddd5a8f" title="Returns the delimiter string.">CmdLine::getDelimiter</a>()
<a name="l00485"></a>00485 {
<a name="l00486"></a>00486 <span class="keywordflow">return</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a602e65692dc07ea872134f354026a54f" title="The character that is used to separate the argument flag/name from the value.">_delimiter</a>;
<a name="l00487"></a>00487 }
<a name="l00488"></a>00488
<a name="l00489"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a8f61a8c201e31ada985fa998180fd40f">00489</a> <span class="keyword">inline</span> std::string& <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a8f61a8c201e31ada985fa998180fd40f" title="Returns the message string.">CmdLine::getMessage</a>()
<a name="l00490"></a>00490 {
<a name="l00491"></a>00491 <span class="keywordflow">return</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a3ccd2ae40f6eb97aebca3de9a02f10cf" title="A message used to describe the program.">_message</a>;
<a name="l00492"></a>00492 }
<a name="l00493"></a>00493
<a name="l00494"></a><a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a5b23895feae4f4110b77dae372226475">00494</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#a5b23895feae4f4110b77dae372226475" title="Indicates whether or not the help and version switches were created automatically.">CmdLine::hasHelpAndVersion</a>()
<a name="l00495"></a>00495 {
<a name="l00496"></a>00496 <span class="keywordflow">return</span> <a class="code" href="class_t_c_l_a_p_1_1_cmd_line.html#aea29ec639729a22384ee8759069a5017" title="Whether or not to automatically create help and version switches.">_helpAndVersion</a>;
<a name="l00497"></a>00497 }
<a name="l00498"></a>00498 <span class="comment"></span>
<a name="l00499"></a>00499 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
<a name="l00500"></a>00500 <span class="comment"></span><span class="comment">//End CmdLine.cpp</span><span class="comment"></span>
<a name="l00501"></a>00501 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
<a name="l00502"></a>00502 <span class="comment"></span>
<a name="l00503"></a>00503
<a name="l00504"></a>00504
<a name="l00505"></a>00505 } <span class="comment">//namespace TCLAP</span>
<a name="l00506"></a>00506 <span class="preprocessor">#endif</span>
</pre></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>
