<!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::Arg 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_arg.html">Arg</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pri-static-methods">Static Private Member Functions</a> </div>
<div class="headertitle">
<div class="title">TCLAP::Arg Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="TCLAP::Arg" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A virtual base class that defines the essential data for all arguments. </p>
<p>This class, or one of its existing children, must be subclassed to do anything. </p>
</div>
<p><code>#include <<a class="el" href="_arg_8h_source.html">mrpt/otherlibs/tclap/Arg.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for TCLAP::Arg:</div>
<div class="dyncontent">
<div class="center"><img src="class_t_c_l_a_p_1_1_arg__inherit__graph.png" border="0" usemap="#_t_c_l_a_p_1_1_arg_inherit__map" alt="Inheritance graph"/></div>
<map name="_t_c_l_a_p_1_1_arg_inherit__map" id="_t_c_l_a_p_1_1_arg_inherit__map">
<area shape="rect" id="node3" href="class_t_c_l_a_p_1_1_multi_arg.html" title="An argument that allows multiple values of type T to be specified." alt="" coords="57,83,177,109"/><area shape="rect" id="node9" href="class_t_c_l_a_p_1_1_switch_arg.html" title="A simple switch argument." alt="" coords="209,83,343,109"/><area shape="rect" id="node13" href="class_t_c_l_a_p_1_1_value_arg.html" title="The basic labeled argument that parses a value." alt="" coords="374,83,500,109"/><area shape="rect" id="node5" href="class_t_c_l_a_p_1_1_multi_arg.html" title="TCLAP::MultiArg\< T \>" alt="" coords="18,173,171,200"/><area shape="rect" id="node7" href="class_t_c_l_a_p_1_1_unlabeled_multi_arg.html" title="Just like a MultiArg, except that the arguments are unlabeled." alt="" coords="5,251,184,277"/><area shape="rect" id="node11" href="class_t_c_l_a_p_1_1_multi_switch_arg.html" title="A multiple switch argument." alt="" coords="195,173,356,200"/><area shape="rect" id="node15" href="class_t_c_l_a_p_1_1_value_arg.html" title="TCLAP::ValueArg\< T \>" alt="" coords="381,173,539,200"/><area shape="rect" id="node17" href="class_t_c_l_a_p_1_1_unlabeled_value_arg.html" title="The basic unlabeled argument that parses a value." alt="" coords="368,251,552,277"/></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_arg-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#a15734a7cf52c8c4ab6df70f0997bbee3">~Arg</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a15734a7cf52c8c4ab6df70f0997bbee3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#a9ff1564beeea2ef855f7fa483c37d0e2">addToList</a> (<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> * > &argList) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds this to the specified list of Args. <a href="#a9ff1564beeea2ef855f7fa483c37d0e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#a61ffe2f660a76111d256f7b22a686146">processArg</a> (int *i, <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="classstd_1_1string.html">std::string</a> > &args)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual method meant to handle the parsing and value assignment of the string on the command line. <a href="#a61ffe2f660a76111d256f7b22a686146"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#a657a8d2842b7de9ced5a5a55db01d367">operator==</a> (const <a class="el" href="class_t_c_l_a_p_1_1_arg.html">Arg</a> &a) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator ==. <a href="#a657a8d2842b7de9ced5a5a55db01d367"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <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_arg.html#a22f616e81a423e794f13a9ae1549ac77">getFlag</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the argument flag. <a href="#a22f616e81a423e794f13a9ae1549ac77"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <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_arg.html#a641ced141a56c74fee11d3e3a808f731">getName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the argument name. <a href="#a641ced141a56c74fee11d3e3a808f731"></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_arg.html#a1943999fadcb4f28cecd6ba55ed0b085">getDescription</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the argument description. <a href="#a1943999fadcb4f28cecd6ba55ed0b085"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#a00a3cfdb2b6e9a111ad39cbd4978b96c">isRequired</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether the argument is required. <a href="#a00a3cfdb2b6e9a111ad39cbd4978b96c"></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_arg.html#a58e3de560f364d0bb6bdf36ab533a6fd">forceRequired</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets _required to true. <a href="#a58e3de560f364d0bb6bdf36ab533a6fd"></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_arg.html#aec525c8092e56f7f5aa455e71bc72374">xorSet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the _alreadySet value to true. <a href="#aec525c8092e56f7f5aa455e71bc72374"></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_arg.html#a1373d50d4b93c16db43c7600cf6d0355">isValueRequired</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether a value must be specified for argument. <a href="#a1373d50d4b93c16db43c7600cf6d0355"></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_arg.html#a6af7a1e92b5d92fc2d90c1a95aab4384">isSet</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether the argument has already been set. <a href="#a6af7a1e92b5d92fc2d90c1a95aab4384"></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_arg.html#a33816b5ccc58a15f3a998480e5d988e2">isIgnoreable</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether the argument can be ignored, if desired. <a href="#a33816b5ccc58a15f3a998480e5d988e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#aac37b1b734b477e5d16f2037dba9c125">argMatches</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &s) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A method that tests whether a string matches this argument. <a href="#aac37b1b734b477e5d16f2037dba9c125"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <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_arg.html#ac98a357568c21f0eb6ca2220b8a3d4a2">toString</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a simple string representation of the argument. <a href="#ac98a357568c21f0eb6ca2220b8a3d4a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <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_arg.html#aef8efaf3811162b2b2b2a84c6db280fa">shortID</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &valueId="val") const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a short ID for the usage. <a href="#aef8efaf3811162b2b2b2a84c6db280fa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <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_arg.html#aad93aff46e1fc67e3853765f565bfa96">longID</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &valueId="val") const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a long ID for the usage. <a href="#aad93aff46e1fc67e3853765f565bfa96"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#a54595328e81f5fb77859563690faab25">trimFlag</a> (<a class="el" href="classstd_1_1string.html">std::string</a> &flag, <a class="el" href="classstd_1_1string.html">std::string</a> &value) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Trims a value off of the flag. <a href="#a54595328e81f5fb77859563690faab25"></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_arg.html#a2eb0ffefe163218bdc8b4b7a33a974a7">_hasBlanks</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &s) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether a given string has blank chars, indicating that it is a combined <a class="el" href="class_t_c_l_a_p_1_1_switch_arg.html" title="A simple switch argument.">SwitchArg</a>. <a href="#a2eb0ffefe163218bdc8b4b7a33a974a7"></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_arg.html#aae5c959f31af1a484a8af06f84a6e8b0">setRequireLabel</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the requireLabel. <a href="#aae5c959f31af1a484a8af06f84a6e8b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#a9aef735d37ef95ca1b7dc7a07850b984">allowMore</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#ad356870538a255d639e26b30330202ae">acceptsMultipleValues</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#a24165d31c1ec70777fb201356b6cdf6a">beginIgnoring</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Begin ignoring arguments since the "--" argument was specified. <a href="#a24165d31c1ec70777fb201356b6cdf6a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#a4d412155b8f9b4956e64e91c48e55a3b">ignoreRest</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether to ignore the rest. <a href="#a4d412155b8f9b4956e64e91c48e55a3b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#aadef6ca7e40f5b3d3fd03186976aea7e">delimiter</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The delimiter that separates an argument flag/name from the value. <a href="#aadef6ca7e40f5b3d3fd03186976aea7e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#a40ba4acecb58080ba33aa57d99e14cad">blankChar</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The char used as a place holder when SwitchArgs are combined. <a href="#a40ba4acecb58080ba33aa57d99e14cad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#ad270774ee5dba351c988df53d87a3b0f">flagStartChar</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The char that indicates the beginning of a flag. <a href="#ad270774ee5dba351c988df53d87a3b0f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <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_arg.html#af8e739295b0f75028e7bff6d670d97a1">flagStartString</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The sting that indicates the beginning of a flag. <a href="#af8e739295b0f75028e7bff6d670d97a1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <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_arg.html#a1df2134870528b80f9f35347fef6fd14">nameStartString</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The sting that indicates the beginning of a name. <a href="#a1df2134870528b80f9f35347fef6fd14"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <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_arg.html#a6ce0cbe4effd44679ca11f25e3c318e7">ignoreNameString</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name used to identify the ignore rest argument. <a href="#a6ce0cbe4effd44679ca11f25e3c318e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#ad059b63424001b9aedb4c019e2854c3c">setDelimiter</a> (char c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the delimiter for all arguments. <a href="#ad059b63424001b9aedb4c019e2854c3c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#aa963d0d4c8cb297e1f4cf74143bf6d1b">_checkWithVisitor</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Performs the special handling described by the Vistitor. <a href="#aa963d0d4c8cb297e1f4cf74143bf6d1b"></a><br/></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_arg.html#ab25a06db5edf82a5b965b641b3c63372">Arg</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &flag, const <a class="el" href="classstd_1_1string.html">std::string</a> &name, const <a class="el" href="classstd_1_1string.html">std::string</a> &desc, bool req, bool valreq, <a class="el" href="class_t_c_l_a_p_1_1_visitor.html">Visitor</a> *v=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Primary constructor. <a href="#ab25a06db5edf82a5b965b641b3c63372"></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_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#ae68407a0a8223023ad0ae3b9dc7986f5">_flag</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The single char flag used to identify the argument. <a href="#ae68407a0a8223023ad0ae3b9dc7986f5"></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_arg.html#ac0f138057a99fb5d94ff4acb41a083aa">_name</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A single work namd indentifying the argument. <a href="#ac0f138057a99fb5d94ff4acb41a083aa"></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_arg.html#a9882fe256eaab01ac53db54ac657d272">_description</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Description of the argument. <a href="#a9882fe256eaab01ac53db54ac657d272"></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_arg.html#ad16408bd1ca4d8b1d14d6c5129545a84">_required</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicating whether the argument is required. <a href="#ad16408bd1ca4d8b1d14d6c5129545a84"></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_arg.html#a2ed097a868e34a0c4f6062ead744ac54">_requireLabel</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Label to be used in usage description. <a href="#a2ed097a868e34a0c4f6062ead744ac54"></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_arg.html#a776682b7e19f4dc231bbad3d10034dfa">_valueRequired</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether a value is required for the argument. <a href="#a776682b7e19f4dc231bbad3d10034dfa"></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_arg.html#a829e32129857d2683e5791a5df1208ec">_alreadySet</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether the argument has been set. <a href="#a829e32129857d2683e5791a5df1208ec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><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_arg.html#aa9ff037e92c9fa5bd85e532f61899300">_visitor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A pointer to a vistitor object. <a href="#aa9ff037e92c9fa5bd85e532f61899300"></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_arg.html#a9832bb7564f4ab472bd51b7b1bbc683f">_ignoreable</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether this argument can be ignored, if desired. <a href="#a9832bb7564f4ab472bd51b7b1bbc683f"></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_arg.html#ab413bd1d8a7ecf3c89672ee23ef791ba">_xorSet</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates that the arg was set as part of an XOR and not on the command line. <a href="#ab413bd1d8a7ecf3c89672ee23ef791ba"></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_arg.html#a13130a9a5d22c57a6d42a8883c9b1e0f">_acceptsMultipleValues</a></td></tr>
<tr><td colspan="2"><h2><a name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#afa32140f7c01f99f6a9e85deb79281e1">ignoreRestRef</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether the rest of the arguments should be ignored. <a href="#afa32140f7c01f99f6a9e85deb79281e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static char & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_l_a_p_1_1_arg.html#a863591150a407ff29276ac13d0058144">delimiterRef</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The delimiter that separates an argument flag/name from the value. <a href="#a863591150a407ff29276ac13d0058144"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab25a06db5edf82a5b965b641b3c63372"></a><!-- doxytag: member="TCLAP::Arg::Arg" ref="ab25a06db5edf82a5b965b641b3c63372" args="(const std::string &flag, const std::string &name, const std::string &desc, bool req, bool valreq, Visitor *v=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TCLAP::Arg::Arg </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>flag</em>, </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>name</em>, </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>desc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>req</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>valreq</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_visitor.html">Visitor</a> * </td>
<td class="paramname"><em>v</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Primary constructor. </p>
<p>YOU (yes you) should NEVER construct an <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> directly, this is a base class that is extended by various children that are meant to be used. Use <a class="el" href="class_t_c_l_a_p_1_1_switch_arg.html" title="A simple switch argument.">SwitchArg</a>, <a class="el" href="class_t_c_l_a_p_1_1_value_arg.html" title="The basic labeled argument that parses a value.">ValueArg</a>, <a class="el" href="class_t_c_l_a_p_1_1_multi_arg.html" title="An argument that allows multiple values of type T to be specified.">MultiArg</a>, <a class="el" href="class_t_c_l_a_p_1_1_unlabeled_value_arg.html" title="The basic unlabeled argument that parses a value.">UnlabeledValueArg</a>, or <a class="el" href="class_t_c_l_a_p_1_1_unlabeled_multi_arg.html" title="Just like a MultiArg, except that the arguments are unlabeled.">UnlabeledMultiArg</a> instead.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">flag</td><td>- The flag identifying the argument. </td></tr>
<tr><td class="paramname">name</td><td>- The name identifying the argument. </td></tr>
<tr><td class="paramname">desc</td><td>- The description of the argument, used in the usage. </td></tr>
<tr><td class="paramname">req</td><td>- Whether the argument is required. </td></tr>
<tr><td class="paramname">valreq</td><td>- Whether the a value is required for the argument. </td></tr>
<tr><td class="paramname">v</td><td>- The visitor checked by the argument. Defaults to NULL. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00359">359</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00068">_flag</a>, <a class="el" href="_arg_8h_source.html#l00499">toString()</a>, <a class="el" href="_arg_8h_source.html#l00077">_name</a>, <a class="el" href="_arg_8h_source.html#l00210">ignoreNameString()</a>, <a class="el" href="_arg_8h_source.html#l00199">flagStartString()</a>, and <a class="el" href="_arg_8h_source.html#l00205">nameStartString()</a>.</p>
</div>
</div>
<a class="anchor" id="a15734a7cf52c8c4ab6df70f0997bbee3"></a><!-- doxytag: member="TCLAP::Arg::~Arg" ref="a15734a7cf52c8c4ab6df70f0997bbee3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TCLAP::Arg::~Arg </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00400">400</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa963d0d4c8cb297e1f4cf74143bf6d1b"></a><!-- doxytag: member="TCLAP::Arg::_checkWithVisitor" ref="aa963d0d4c8cb297e1f4cf74143bf6d1b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::Arg::_checkWithVisitor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Performs the special handling described by the Vistitor. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00511">511</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00115">_visitor</a>, and <a class="el" href="_visitor_8h_source.html#l00048">TCLAP::Visitor::visit()</a>.</p>
<p>Referenced by <a class="el" href="_multi_switch_arg_8h_source.html#l00145">TCLAP::MultiSwitchArg::processArg()</a>, and <a class="el" href="_switch_arg_8h_source.html#l00168">TCLAP::SwitchArg::processArg()</a>.</p>
</div>
</div>
<a class="anchor" id="a2eb0ffefe163218bdc8b4b7a33a974a7"></a><!-- doxytag: member="TCLAP::Arg::_hasBlanks" ref="a2eb0ffefe163218bdc8b4b7a33a974a7" args="(const std::string &s) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool TCLAP::Arg::_hasBlanks </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> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks whether a given string has blank chars, indicating that it is a combined <a class="el" href="class_t_c_l_a_p_1_1_switch_arg.html" title="A simple switch argument.">SwitchArg</a>. </p>
<p>Implementation of _hasBlanks.</p>
<p>If so, return true, otherwise return false. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>- string to be checked. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00541">541</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00188">blankChar()</a>.</p>
</div>
</div>
<a class="anchor" id="ad356870538a255d639e26b30330202ae"></a><!-- doxytag: member="TCLAP::Arg::acceptsMultipleValues" ref="ad356870538a255d639e26b30330202ae" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool TCLAP::Arg::acceptsMultipleValues </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00574">574</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00128">_acceptsMultipleValues</a>.</p>
<p>Referenced by <a class="el" href="_doc_book_output_8h_source.html#l00218">TCLAP::DocBookOutput::printShortArg()</a>.</p>
</div>
</div>
<a class="anchor" id="a9ff1564beeea2ef855f7fa483c37d0e2"></a><!-- doxytag: member="TCLAP::Arg::addToList" ref="a9ff1564beeea2ef855f7fa483c37d0e2" args="(std::list< Arg * > &argList) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::Arg::addToList </td>
<td>(</td>
<td class="paramtype"><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="paramname"><em>argList</em></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds this to the specified list of Args. </p>
<p>Overridden by Args that need to added to the end of the list.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">argList</td><td>- The list to add this to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00564">564</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00361">TCLAP::CmdLine::add()</a>.</p>
</div>
</div>
<a class="anchor" id="a9aef735d37ef95ca1b7dc7a07850b984"></a><!-- doxytag: member="TCLAP::Arg::allowMore" ref="a9aef735d37ef95ca1b7dc7a07850b984" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool TCLAP::Arg::allowMore </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="class_t_c_l_a_p_1_1_multi_arg.html#aef3bed723518c4361362c73f37830e82">TCLAP::MultiArg</a>.</p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00569">569</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
</div>
</div>
<a class="anchor" id="aac37b1b734b477e5d16f2037dba9c125"></a><!-- doxytag: member="TCLAP::Arg::argMatches" ref="aac37b1b734b477e5d16f2037dba9c125" args="(const std::string &s) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool TCLAP::Arg::argMatches </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> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A method that tests whether a string matches this argument. </p>
<p>This is generally called by the <a class="el" href="class_t_c_l_a_p_1_1_arg.html#a61ffe2f660a76111d256f7b22a686146" title="Pure virtual method meant to handle the parsing and value assignment of the string on the command lin...">processArg()</a> method. This method could be re-implemented by a child to change how arguments are specified on the command line. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>- The string to be compared to the flag/name to determine whether the arg matches. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00490">490</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00199">flagStartString()</a>, <a class="el" href="_arg_8h_source.html#l00068">_flag</a>, <a class="el" href="_arg_8h_source.html#l00205">nameStartString()</a>, and <a class="el" href="_arg_8h_source.html#l00077">_name</a>.</p>
<p>Referenced by <a class="el" href="_multi_switch_arg_8h_source.html#l00145">TCLAP::MultiSwitchArg::processArg()</a>, and <a class="el" href="_switch_arg_8h_source.html#l00168">TCLAP::SwitchArg::processArg()</a>.</p>
</div>
</div>
<a class="anchor" id="a24165d31c1ec70777fb201356b6cdf6a"></a><!-- doxytag: member="TCLAP::Arg::beginIgnoring" ref="a24165d31c1ec70777fb201356b6cdf6a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void TCLAP::Arg::beginIgnoring </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Begin ignoring arguments since the "--" argument was specified. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00170">170</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00050">ignoreRestRef()</a>.</p>
<p>Referenced by <a class="el" href="_ignore_rest_visitor_8h_source.html#l00047">TCLAP::IgnoreRestVisitor::visit()</a>.</p>
</div>
</div>
<a class="anchor" id="a40ba4acecb58080ba33aa57d99e14cad"></a><!-- doxytag: member="TCLAP::Arg::blankChar" ref="a40ba4acecb58080ba33aa57d99e14cad" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char TCLAP::Arg::blankChar </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The char used as a place holder when SwitchArgs are combined. </p>
<p>Currently set to '*', which shouldn't cause many problems since *'s are expanded by most shells on the command line. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00188">188</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00541">_hasBlanks()</a>, <a class="el" href="_cmd_line_8h_source.html#l00431">TCLAP::CmdLine::_emptyCombined()</a>, and <a class="el" href="_switch_arg_8h_source.html#l00139">TCLAP::SwitchArg::combinedSwitchesMatch()</a>.</p>
</div>
</div>
<a class="anchor" id="aadef6ca7e40f5b3d3fd03186976aea7e"></a><!-- doxytag: member="TCLAP::Arg::delimiter" ref="aadef6ca7e40f5b3d3fd03186976aea7e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static char TCLAP::Arg::delimiter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The delimiter that separates an argument flag/name from the value. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00181">181</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00056">delimiterRef()</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00402">shortID()</a>, and <a class="el" href="_arg_8h_source.html#l00520">trimFlag()</a>.</p>
</div>
</div>
<a class="anchor" id="a863591150a407ff29276ac13d0058144"></a><!-- doxytag: member="TCLAP::Arg::delimiterRef" ref="a863591150a407ff29276ac13d0058144" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static char& TCLAP::Arg::delimiterRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The delimiter that separates an argument flag/name from the value. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00056">56</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00181">delimiter()</a>, and <a class="el" href="_arg_8h_source.html#l00216">setDelimiter()</a>.</p>
</div>
</div>
<a class="anchor" id="ad270774ee5dba351c988df53d87a3b0f"></a><!-- doxytag: member="TCLAP::Arg::flagStartChar" ref="ad270774ee5dba351c988df53d87a3b0f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char TCLAP::Arg::flagStartChar </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The char that indicates the beginning of a flag. </p>
<p>Currently '-'. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00193">193</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00431">TCLAP::CmdLine::_emptyCombined()</a>.</p>
</div>
</div>
<a class="anchor" id="af8e739295b0f75028e7bff6d670d97a1"></a><!-- doxytag: member="TCLAP::Arg::flagStartString" ref="af8e739295b0f75028e7bff6d670d97a1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classstd_1_1string.html">std::string</a> TCLAP::Arg::flagStartString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The sting that indicates the beginning of a flag. </p>
<p>Currently "-". Should be identical to flagStartChar. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00199">199</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00359">Arg()</a>, <a class="el" href="_arg_8h_source.html#l00402">shortID()</a>, <a class="el" href="_arg_8h_source.html#l00423">longID()</a>, <a class="el" href="_arg_8h_source.html#l00490">argMatches()</a>, <a class="el" href="_arg_8h_source.html#l00499">toString()</a>, <a class="el" href="_cmd_line_8h_source.html#l00298">TCLAP::CmdLine::_constructor()</a>, and <a class="el" href="_switch_arg_8h_source.html#l00139">TCLAP::SwitchArg::combinedSwitchesMatch()</a>.</p>
</div>
</div>
<a class="anchor" id="a58e3de560f364d0bb6bdf36ab533a6fd"></a><!-- doxytag: member="TCLAP::Arg::forceRequired" ref="a58e3de560f364d0bb6bdf36ab533a6fd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::Arg::forceRequired </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets _required to true. </p>
<p>This is used by 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>. You really have no reason to ever use it. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00550">550</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00087">_required</a>.</p>
</div>
</div>
<a class="anchor" id="a1943999fadcb4f28cecd6ba55ed0b085"></a><!-- doxytag: member="TCLAP::Arg::getDescription" ref="a1943999fadcb4f28cecd6ba55ed0b085" args="() const " -->
<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::Arg::getDescription </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the argument description. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00454">454</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00087">_required</a>, <a class="el" href="_arg_8h_source.html#l00093">_requireLabel</a>, and <a class="el" href="_arg_8h_source.html#l00082">_description</a>.</p>
<p>Referenced by <a class="el" href="_doc_book_output_8h_source.html#l00245">TCLAP::DocBookOutput::printLongArg()</a>, <a class="el" href="_unlabeled_multi_arg_8h_source.html#l00287">TCLAP::UnlabeledMultiArg::operator==()</a>, and <a class="el" href="_unlabeled_value_arg_8h_source.html#l00326">TCLAP::UnlabeledValueArg::operator==()</a>.</p>
</div>
</div>
<a class="anchor" id="a22f616e81a423e794f13a9ae1549ac77"></a><!-- doxytag: member="TCLAP::Arg::getFlag" ref="a22f616e81a423e794f13a9ae1549ac77" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classstd_1_1string.html">std::string</a> & TCLAP::Arg::getFlag </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the argument flag. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00467">467</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00068">_flag</a>.</p>
</div>
</div>
<a class="anchor" id="a641ced141a56c74fee11d3e3a808f731"></a><!-- doxytag: member="TCLAP::Arg::getName" ref="a641ced141a56c74fee11d3e3a808f731" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classstd_1_1string.html">std::string</a> & TCLAP::Arg::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the argument name. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00469">469</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00077">_name</a>.</p>
<p>Referenced by <a class="el" href="_unlabeled_multi_arg_8h_source.html#l00287">TCLAP::UnlabeledMultiArg::operator==()</a>, and <a class="el" href="_unlabeled_value_arg_8h_source.html#l00326">TCLAP::UnlabeledValueArg::operator==()</a>.</p>
</div>
</div>
<a class="anchor" id="a6ce0cbe4effd44679ca11f25e3c318e7"></a><!-- doxytag: member="TCLAP::Arg::ignoreNameString" ref="a6ce0cbe4effd44679ca11f25e3c318e7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classstd_1_1string.html">std::string</a> TCLAP::Arg::ignoreNameString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name used to identify the ignore rest argument. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00210">210</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00359">Arg()</a>, and <a class="el" href="_cmd_line_8h_source.html#l00298">TCLAP::CmdLine::_constructor()</a>.</p>
</div>
</div>
<a class="anchor" id="a4d412155b8f9b4956e64e91c48e55a3b"></a><!-- doxytag: member="TCLAP::Arg::ignoreRest" ref="a4d412155b8f9b4956e64e91c48e55a3b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool TCLAP::Arg::ignoreRest </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Whether to ignore the rest. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00175">175</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00050">ignoreRestRef()</a>.</p>
<p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00375">TCLAP::CmdLine::parse()</a>, <a class="el" href="_multi_switch_arg_8h_source.html#l00145">TCLAP::MultiSwitchArg::processArg()</a>, and <a class="el" href="_switch_arg_8h_source.html#l00168">TCLAP::SwitchArg::processArg()</a>.</p>
</div>
</div>
<a class="anchor" id="afa32140f7c01f99f6a9e85deb79281e1"></a><!-- doxytag: member="TCLAP::Arg::ignoreRestRef" ref="afa32140f7c01f99f6a9e85deb79281e1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool& TCLAP::Arg::ignoreRestRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates whether the rest of the arguments should be ignored. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00050">50</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00170">beginIgnoring()</a>, and <a class="el" href="_arg_8h_source.html#l00175">ignoreRest()</a>.</p>
</div>
</div>
<a class="anchor" id="a33816b5ccc58a15f3a998480e5d988e2"></a><!-- doxytag: member="TCLAP::Arg::isIgnoreable" ref="a33816b5ccc58a15f3a998480e5d988e2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool TCLAP::Arg::isIgnoreable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates whether the argument can be ignored, if desired. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00483">483</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00120">_ignoreable</a>.</p>
</div>
</div>
<a class="anchor" id="a00a3cfdb2b6e9a111ad39cbd4978b96c"></a><!-- doxytag: member="TCLAP::Arg::isRequired" ref="a00a3cfdb2b6e9a111ad39cbd4978b96c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool TCLAP::Arg::isRequired </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates whether the argument is required. </p>
<p>Reimplemented in <a class="el" href="class_t_c_l_a_p_1_1_multi_arg.html#add0f8021548e5f2a37674f47788af8b0">TCLAP::MultiArg</a>.</p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00471">471</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00087">_required</a>.</p>
<p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00361">TCLAP::CmdLine::add()</a>, <a class="el" href="_doc_book_output_8h_source.html#l00218">TCLAP::DocBookOutput::printShortArg()</a>, and <a class="el" href="_xor_handler_8h_source.html#l00100">TCLAP::XorHandler::check()</a>.</p>
</div>
</div>
<a class="anchor" id="a6af7a1e92b5d92fc2d90c1a95aab4384"></a><!-- doxytag: member="TCLAP::Arg::isSet" ref="a6af7a1e92b5d92fc2d90c1a95aab4384" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool TCLAP::Arg::isSet </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates whether the argument has already been set. </p>
<p>Only true if the arg has been matched on the command line. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00475">475</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00107">_alreadySet</a>, and <a class="el" href="_arg_8h_source.html#l00126">_xorSet</a>.</p>
</div>
</div>
<a class="anchor" id="a1373d50d4b93c16db43c7600cf6d0355"></a><!-- doxytag: member="TCLAP::Arg::isValueRequired" ref="a1373d50d4b93c16db43c7600cf6d0355" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool TCLAP::Arg::isValueRequired </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates whether a value must be specified for argument. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00473">473</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00100">_valueRequired</a>.</p>
</div>
</div>
<a class="anchor" id="aad93aff46e1fc67e3853765f565bfa96"></a><!-- doxytag: member="TCLAP::Arg::longID" ref="aad93aff46e1fc67e3853765f565bfa96" args="(const std::string &valueId="val") const " -->
<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::Arg::longID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>valueId</em> = <code>"val"</code></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a long ID for the usage. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">valueId</td><td>- The value used in the id. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="class_t_c_l_a_p_1_1_value_arg.html#a65f614d1864b7baf6857cdbdd5fc7830">TCLAP::ValueArg</a>, <a class="el" href="class_t_c_l_a_p_1_1_multi_arg.html#ac5d45a5ae312d148e47b01a9e9d8c157">TCLAP::MultiArg</a>, and <a class="el" href="class_t_c_l_a_p_1_1_multi_switch_arg.html#a0b0aacc09c93462bab4347f86db0fccd">TCLAP::MultiSwitchArg</a>.</p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00423">423</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00068">_flag</a>, <a class="el" href="_arg_8h_source.html#l00199">flagStartString()</a>, <a class="el" href="_arg_8h_source.html#l00100">_valueRequired</a>, <a class="el" href="_arg_8h_source.html#l00205">nameStartString()</a>, and <a class="el" href="_arg_8h_source.html#l00077">_name</a>.</p>
<p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00361">TCLAP::CmdLine::add()</a>, and <a class="el" href="_doc_book_output_8h_source.html#l00245">TCLAP::DocBookOutput::printLongArg()</a>.</p>
</div>
</div>
<a class="anchor" id="a1df2134870528b80f9f35347fef6fd14"></a><!-- doxytag: member="TCLAP::Arg::nameStartString" ref="a1df2134870528b80f9f35347fef6fd14" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classstd_1_1string.html">std::string</a> TCLAP::Arg::nameStartString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The sting that indicates the beginning of a name. </p>
<p>Currently "--". Should be flagStartChar twice. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00205">205</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00359">Arg()</a>, <a class="el" href="_arg_8h_source.html#l00402">shortID()</a>, <a class="el" href="_arg_8h_source.html#l00423">longID()</a>, <a class="el" href="_arg_8h_source.html#l00490">argMatches()</a>, <a class="el" href="_arg_8h_source.html#l00499">toString()</a>, and <a class="el" href="_switch_arg_8h_source.html#l00139">TCLAP::SwitchArg::combinedSwitchesMatch()</a>.</p>
</div>
</div>
<a class="anchor" id="a657a8d2842b7de9ced5a5a55db01d367"></a><!-- doxytag: member="TCLAP::Arg::operator==" ref="a657a8d2842b7de9ced5a5a55db01d367" args="(const Arg &a) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool TCLAP::Arg::operator== </td>
<td>(</td>
<td class="paramtype">const <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> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Operator ==. </p>
<p>Equality operator. Must be virtual to handle unlabeled args. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>- The <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> to be compared to this. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00446">446</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00068">_flag</a>, and <a class="el" href="_arg_8h_source.html#l00077">_name</a>.</p>
</div>
</div>
<a class="anchor" id="a61ffe2f660a76111d256f7b22a686146"></a><!-- doxytag: member="TCLAP::Arg::processArg" ref="a61ffe2f660a76111d256f7b22a686146" args="(int *i, std::vector< std::string > &args)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool TCLAP::Arg::processArg </td>
<td>(</td>
<td class="paramtype">int * </td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="classstd_1_1string.html">std::string</a> > & </td>
<td class="paramname"><em>args</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pure virtual method meant to handle the parsing and value assignment of the string on the command line. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>- Pointer the the current argument in the list. </td></tr>
<tr><td class="paramname">args</td><td>- Mutable list of strings. What is passed in from main. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="class_t_c_l_a_p_1_1_value_arg.html#a8450096a5f8d383498e91b7ef78caf48">TCLAP::ValueArg</a>, <a class="el" href="class_t_c_l_a_p_1_1_multi_arg.html#a357e850e230cf7537c13d776f278c2ef">TCLAP::MultiArg</a>, <a class="el" href="class_t_c_l_a_p_1_1_multi_switch_arg.html#a91c3d349570f21d8af6dc90767d747a2">TCLAP::MultiSwitchArg</a>, and <a class="el" href="class_t_c_l_a_p_1_1_switch_arg.html#a624f98df6c4907efec95ffc353e9d08c">TCLAP::SwitchArg</a>.</p>
</div>
</div>
<a class="anchor" id="ad059b63424001b9aedb4c019e2854c3c"></a><!-- doxytag: member="TCLAP::Arg::setDelimiter" ref="ad059b63424001b9aedb4c019e2854c3c" args="(char c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void TCLAP::Arg::setDelimiter </td>
<td>(</td>
<td class="paramtype">char </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the delimiter for all arguments. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>- The character that delimits flags/names from values. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00216">216</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00056">delimiterRef()</a>.</p>
<p>Referenced by <a class="el" href="_cmd_line_8h_source.html#l00298">TCLAP::CmdLine::_constructor()</a>.</p>
</div>
</div>
<a class="anchor" id="aae5c959f31af1a484a8af06f84a6e8b0"></a><!-- doxytag: member="TCLAP::Arg::setRequireLabel" ref="aae5c959f31af1a484a8af06f84a6e8b0" args="(const std::string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::Arg::setRequireLabel </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]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the requireLabel. </p>
<p>Used by <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>. You shouldn't ever use this. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>- Set the requireLabel to this value. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00485">485</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00093">_requireLabel</a>.</p>
</div>
</div>
<a class="anchor" id="aef8efaf3811162b2b2b2a84c6db280fa"></a><!-- doxytag: member="TCLAP::Arg::shortID" ref="aef8efaf3811162b2b2b2a84c6db280fa" args="(const std::string &valueId="val") const " -->
<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::Arg::shortID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>valueId</em> = <code>"val"</code></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a short ID for the usage. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">valueId</td><td>- The value used in the id. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="class_t_c_l_a_p_1_1_value_arg.html#a0681144a46ae08d7ad354978c1bac2aa">TCLAP::ValueArg</a>, <a class="el" href="class_t_c_l_a_p_1_1_multi_arg.html#abe2ad6623b2959e4236bde1433c10bc2">TCLAP::MultiArg</a>, and <a class="el" href="class_t_c_l_a_p_1_1_multi_switch_arg.html#a083c07003f948691e94ce94d0b6376ed">TCLAP::MultiSwitchArg</a>.</p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00402">402</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00068">_flag</a>, <a class="el" href="_arg_8h_source.html#l00199">flagStartString()</a>, <a class="el" href="_arg_8h_source.html#l00205">nameStartString()</a>, <a class="el" href="_arg_8h_source.html#l00077">_name</a>, <a class="el" href="_arg_8h_source.html#l00181">delimiter()</a>, <a class="el" href="_arg_8h_source.html#l00100">_valueRequired</a>, and <a class="el" href="_arg_8h_source.html#l00087">_required</a>.</p>
<p>Referenced by <a class="el" href="_doc_book_output_8h_source.html#l00218">TCLAP::DocBookOutput::printShortArg()</a>.</p>
</div>
</div>
<a class="anchor" id="ac98a357568c21f0eb6ca2220b8a3d4a2"></a><!-- doxytag: member="TCLAP::Arg::toString" ref="ac98a357568c21f0eb6ca2220b8a3d4a2" args="() const " -->
<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::Arg::toString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a simple string representation of the argument. </p>
<p>Primarily for debugging. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00499">499</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00068">_flag</a>, <a class="el" href="_arg_8h_source.html#l00199">flagStartString()</a>, <a class="el" href="_arg_8h_source.html#l00205">nameStartString()</a>, and <a class="el" href="_arg_8h_source.html#l00077">_name</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00359">Arg()</a>, and <a class="el" href="_switch_arg_8h_source.html#l00168">TCLAP::SwitchArg::processArg()</a>.</p>
</div>
</div>
<a class="anchor" id="a54595328e81f5fb77859563690faab25"></a><!-- doxytag: member="TCLAP::Arg::trimFlag" ref="a54595328e81f5fb77859563690faab25" args="(std::string &flag, std::string &value) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::Arg::trimFlag </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>flag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Trims a value off of the flag. </p>
<p>Implementation of trimFlag.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">flag</td><td>- The string from which the flag and value will be trimmed. Contains the flag once the value has been trimmed. </td></tr>
<tr><td class="paramname">value</td><td>- Where the value trimmed from the string will be stored. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00520">520</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00181">delimiter()</a>.</p>
</div>
</div>
<a class="anchor" id="aec525c8092e56f7f5aa455e71bc72374"></a><!-- doxytag: member="TCLAP::Arg::xorSet" ref="aec525c8092e56f7f5aa455e71bc72374" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCLAP::Arg::xorSet </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the _alreadySet value to true. </p>
<p>This is used by 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>. You really have no reason to ever use it. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00555">555</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>References <a class="el" href="_arg_8h_source.html#l00107">_alreadySet</a>, and <a class="el" href="_arg_8h_source.html#l00126">_xorSet</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a13130a9a5d22c57a6d42a8883c9b1e0f"></a><!-- doxytag: member="TCLAP::Arg::_acceptsMultipleValues" ref="a13130a9a5d22c57a6d42a8883c9b1e0f" 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_arg.html#a13130a9a5d22c57a6d42a8883c9b1e0f">TCLAP::Arg::_acceptsMultipleValues</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00128">128</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00574">acceptsMultipleValues()</a>, and <a class="el" href="_multi_arg_8h_source.html#l00333">TCLAP::MultiArg::MultiArg()</a>.</p>
</div>
</div>
<a class="anchor" id="a829e32129857d2683e5791a5df1208ec"></a><!-- doxytag: member="TCLAP::Arg::_alreadySet" ref="a829e32129857d2683e5791a5df1208ec" 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_arg.html#a829e32129857d2683e5791a5df1208ec">TCLAP::Arg::_alreadySet</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates whether the argument has been set. </p>
<p>Indicates that a value on the command line has matched the name/flag of this argument and the values have been set accordingly. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00107">107</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00475">isSet()</a>, <a class="el" href="_arg_8h_source.html#l00555">xorSet()</a>, <a class="el" href="_multi_switch_arg_8h_source.html#l00145">TCLAP::MultiSwitchArg::processArg()</a>, and <a class="el" href="_switch_arg_8h_source.html#l00168">TCLAP::SwitchArg::processArg()</a>.</p>
</div>
</div>
<a class="anchor" id="a9882fe256eaab01ac53db54ac657d272"></a><!-- doxytag: member="TCLAP::Arg::_description" ref="a9882fe256eaab01ac53db54ac657d272" 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_arg.html#a9882fe256eaab01ac53db54ac657d272">TCLAP::Arg::_description</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Description of the argument. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00082">82</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00454">getDescription()</a>.</p>
</div>
</div>
<a class="anchor" id="ae68407a0a8223023ad0ae3b9dc7986f5"></a><!-- doxytag: member="TCLAP::Arg::_flag" ref="ae68407a0a8223023ad0ae3b9dc7986f5" 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_arg.html#ae68407a0a8223023ad0ae3b9dc7986f5">TCLAP::Arg::_flag</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The single char flag used to identify the argument. </p>
<p>This value (preceded by a dash {-}), can be used to identify an argument on the command line. The _flag can be blank, in fact this is how unlabeled args work. Unlabeled args must override appropriate functions to get correct handling. Note that the _flag does NOT include the dash as part of the flag. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00068">68</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00359">Arg()</a>, <a class="el" href="_arg_8h_source.html#l00402">shortID()</a>, <a class="el" href="_arg_8h_source.html#l00423">longID()</a>, <a class="el" href="_arg_8h_source.html#l00446">operator==()</a>, <a class="el" href="_arg_8h_source.html#l00467">getFlag()</a>, <a class="el" href="_arg_8h_source.html#l00490">argMatches()</a>, <a class="el" href="_arg_8h_source.html#l00499">toString()</a>, and <a class="el" href="_switch_arg_8h_source.html#l00139">TCLAP::SwitchArg::combinedSwitchesMatch()</a>.</p>
</div>
</div>
<a class="anchor" id="a9832bb7564f4ab472bd51b7b1bbc683f"></a><!-- doxytag: member="TCLAP::Arg::_ignoreable" ref="a9832bb7564f4ab472bd51b7b1bbc683f" 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_arg.html#a9832bb7564f4ab472bd51b7b1bbc683f">TCLAP::Arg::_ignoreable</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Whether this argument can be ignored, if desired. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00120">120</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00483">isIgnoreable()</a>, <a class="el" href="_multi_switch_arg_8h_source.html#l00145">TCLAP::MultiSwitchArg::processArg()</a>, and <a class="el" href="_switch_arg_8h_source.html#l00168">TCLAP::SwitchArg::processArg()</a>.</p>
</div>
</div>
<a class="anchor" id="ac0f138057a99fb5d94ff4acb41a083aa"></a><!-- doxytag: member="TCLAP::Arg::_name" ref="ac0f138057a99fb5d94ff4acb41a083aa" 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_arg.html#ac0f138057a99fb5d94ff4acb41a083aa">TCLAP::Arg::_name</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A single work namd indentifying the argument. </p>
<p>This value (preceded by two dashed {--}) can also be used to identify an argument on the command line. Note that the _name does NOT include the two dashes as part of the _name. The _name cannot be blank. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00077">77</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00359">Arg()</a>, <a class="el" href="_arg_8h_source.html#l00402">shortID()</a>, <a class="el" href="_arg_8h_source.html#l00423">longID()</a>, <a class="el" href="_arg_8h_source.html#l00446">operator==()</a>, <a class="el" href="_arg_8h_source.html#l00469">getName()</a>, <a class="el" href="_arg_8h_source.html#l00490">argMatches()</a>, and <a class="el" href="_arg_8h_source.html#l00499">toString()</a>.</p>
</div>
</div>
<a class="anchor" id="ad16408bd1ca4d8b1d14d6c5129545a84"></a><!-- doxytag: member="TCLAP::Arg::_required" ref="ad16408bd1ca4d8b1d14d6c5129545a84" 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_arg.html#ad16408bd1ca4d8b1d14d6c5129545a84">TCLAP::Arg::_required</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicating whether the argument is required. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00087">87</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00402">shortID()</a>, <a class="el" href="_arg_8h_source.html#l00454">getDescription()</a>, <a class="el" href="_arg_8h_source.html#l00471">isRequired()</a>, and <a class="el" href="_arg_8h_source.html#l00550">forceRequired()</a>.</p>
</div>
</div>
<a class="anchor" id="a2ed097a868e34a0c4f6062ead744ac54"></a><!-- doxytag: member="TCLAP::Arg::_requireLabel" ref="a2ed097a868e34a0c4f6062ead744ac54" 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_arg.html#a2ed097a868e34a0c4f6062ead744ac54">TCLAP::Arg::_requireLabel</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Label to be used in usage description. </p>
<p>Normally set to "required", but can be changed when necessary. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00093">93</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00454">getDescription()</a>, and <a class="el" href="_arg_8h_source.html#l00485">setRequireLabel()</a>.</p>
</div>
</div>
<a class="anchor" id="a776682b7e19f4dc231bbad3d10034dfa"></a><!-- doxytag: member="TCLAP::Arg::_valueRequired" ref="a776682b7e19f4dc231bbad3d10034dfa" 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_arg.html#a776682b7e19f4dc231bbad3d10034dfa">TCLAP::Arg::_valueRequired</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates whether a value is required for the argument. </p>
<p>Note that the value may be required but the argument/value combination may not be, as specified by _required. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00100">100</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00402">shortID()</a>, <a class="el" href="_arg_8h_source.html#l00423">longID()</a>, and <a class="el" href="_arg_8h_source.html#l00473">isValueRequired()</a>.</p>
</div>
</div>
<a class="anchor" id="aa9ff037e92c9fa5bd85e532f61899300"></a><!-- doxytag: member="TCLAP::Arg::_visitor" ref="aa9ff037e92c9fa5bd85e532f61899300" 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_visitor.html">Visitor</a>* <a class="el" href="class_t_c_l_a_p_1_1_arg.html#aa9ff037e92c9fa5bd85e532f61899300">TCLAP::Arg::_visitor</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A pointer to a vistitor object. </p>
<p>The visitor allows special handling to occur as soon as the argument is matched. This defaults to NULL and should not be used unless absolutely necessary. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00115">115</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00511">_checkWithVisitor()</a>.</p>
</div>
</div>
<a class="anchor" id="ab413bd1d8a7ecf3c89672ee23ef791ba"></a><!-- doxytag: member="TCLAP::Arg::_xorSet" ref="ab413bd1d8a7ecf3c89672ee23ef791ba" 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_arg.html#ab413bd1d8a7ecf3c89672ee23ef791ba">TCLAP::Arg::_xorSet</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates that the arg was set as part of an XOR and not on the command line. </p>
<p>Definition at line <a class="el" href="_arg_8h_source.html#l00126">126</a> of file <a class="el" href="_arg_8h_source.html">Arg.h</a>.</p>
<p>Referenced by <a class="el" href="_arg_8h_source.html#l00475">isSet()</a>, and <a class="el" href="_arg_8h_source.html#l00555">xorSet()</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>
