560 lines
34 KiB
HTML
560 lines
34 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
|
|
<title>tclap: TCLAP::UnlabeledMultiArg< T > Class Template Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<!-- Generated by Doxygen 1.6.0 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main Page</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>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="navpath"><a class="el" href="namespaceTCLAP.html">TCLAP</a>::<a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">UnlabeledMultiArg</a>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>TCLAP::UnlabeledMultiArg< T > Class Template Reference</h1><!-- doxytag: class="TCLAP::UnlabeledMultiArg" --><!-- doxytag: inherits="TCLAP::MultiArg" -->
|
|
<p>Just like a <a class="el" href="classTCLAP_1_1MultiArg.html" title="An argument that allows multiple values of type T to be specified.">MultiArg</a>, except that the arguments are unlabeled.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="UnlabeledMultiArg_8h_source.html">UnlabeledMultiArg.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for TCLAP::UnlabeledMultiArg< T >:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classTCLAP_1_1UnlabeledMultiArg.gif" usemap="#TCLAP::UnlabeledMultiArg< T >_map" alt=""/>
|
|
<map id="TCLAP::UnlabeledMultiArg< T >_map" name="TCLAP::UnlabeledMultiArg< T >_map">
|
|
<area href="classTCLAP_1_1MultiArg.html" alt="TCLAP::MultiArg< T >" shape="rect" coords="0,56,193,80"/>
|
|
<area href="classTCLAP_1_1Arg.html" alt="TCLAP::Arg" shape="rect" coords="0,0,193,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classTCLAP_1_1UnlabeledMultiArg-members.html">List of all members.</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html#a776c124bf343d0ecfb73e7cc28423807">UnlabeledMultiArg</a> (const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, bool ignoreable=false, <a class="el" href="classTCLAP_1_1Visitor.html">Visitor</a> *v=NULL)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a776c124bf343d0ecfb73e7cc28423807"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html#a5c81005897f6b9673b39f5d1107f4074">UnlabeledMultiArg</a> (const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, <a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> &parser, bool ignoreable=false, <a class="el" href="classTCLAP_1_1Visitor.html">Visitor</a> *v=NULL)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a5c81005897f6b9673b39f5d1107f4074"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html#aa065c76cd23b4acfe62c4b31d73dcf87">UnlabeledMultiArg</a> (const std::string &name, const std::string &desc, bool req, <a class="el" href="classTCLAP_1_1Constraint.html">Constraint</a>< T > *constraint, bool ignoreable=false, <a class="el" href="classTCLAP_1_1Visitor.html">Visitor</a> *v=NULL)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#aa065c76cd23b4acfe62c4b31d73dcf87"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html#ad3d8c37cd3c71deb2275b48115a59f11">UnlabeledMultiArg</a> (const std::string &name, const std::string &desc, bool req, <a class="el" href="classTCLAP_1_1Constraint.html">Constraint</a>< T > *constraint, <a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> &parser, bool ignoreable=false, <a class="el" href="classTCLAP_1_1Visitor.html">Visitor</a> *v=NULL)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ad3d8c37cd3c71deb2275b48115a59f11"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html#aa5a35665519518dcb60e53d3a4858802">processArg</a> (int *i, std::vector< std::string > &args)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handles the processing of the argument. <a href="#aa5a35665519518dcb60e53d3a4858802"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html#a5971af8f29fa4d798ffde3293504c15b">shortID</a> (const std::string &val="val") const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the a short id string. <a href="#a5971af8f29fa4d798ffde3293504c15b"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html#a1e7262967b850fb30e1003890a45f1ca">longID</a> (const std::string &val="val") const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the a long id string. <a href="#a1e7262967b850fb30e1003890a45f1ca"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html#a059fa00203a9f643a10334fedbd43e39">operator==</a> (const <a class="el" href="classTCLAP_1_1Arg.html">Arg</a> &a) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opertor ==. <a href="#a059fa00203a9f643a10334fedbd43e39"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html#a290b15792de11abb5a4cf1c312d6a0d7">addToList</a> (std::list< <a class="el" href="classTCLAP_1_1Arg.html">Arg</a> * > &argList) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pushes this to back of list rather than front. <a href="#a290b15792de11abb5a4cf1c312d6a0d7"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<h3>template<class T><br/>
|
|
class TCLAP::UnlabeledMultiArg< T ></h3>
|
|
|
|
<p>Just like a <a class="el" href="classTCLAP_1_1MultiArg.html" title="An argument that allows multiple values of type T to be specified.">MultiArg</a>, except that the arguments are unlabeled. </p>
|
|
<p>Basically, this <a class="el" href="classTCLAP_1_1Arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a> will slurp up everything that hasn't been matched to another <a class="el" href="classTCLAP_1_1Arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a>. </p>
|
|
|
|
<p>Definition at line <a class="el" href="UnlabeledMultiArg_8h_source.html#l00040">40</a> of file <a class="el" href="UnlabeledMultiArg_8h_source.html">UnlabeledMultiArg.h</a>.</p>
|
|
<hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a776c124bf343d0ecfb73e7cc28423807"></a><!-- doxytag: member="TCLAP::UnlabeledMultiArg::UnlabeledMultiArg" ref="a776c124bf343d0ecfb73e7cc28423807" args="(const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, bool ignoreable=false, Visitor *v=NULL)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">TCLAP::UnlabeledMultiArg</a>< T >::<a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">UnlabeledMultiArg</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </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">const std::string & </td>
|
|
<td class="paramname"> <em>typeDesc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"> <em>ignoreable</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classTCLAP_1_1Visitor.html">Visitor</a> * </td>
|
|
<td class="paramname"> <em>v</em> = <code>NULL</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Constructor. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>- The name of the <a class="el" href="classTCLAP_1_1Arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a>. Note that this is used for identification, not as a long flag. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>desc</em> </td><td>- A description of what the argument is for or does. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>req</em> </td><td>- Whether the argument is required on the command line. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>typeDesc</em> </td><td>- A short, human readable description of the type that this object expects. This is used in the generation of the USAGE statement. The goal is to be helpful to the end user of the program. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ignoreable</em> </td><td>- Whether or not this argument can be ignored using the "--" flag. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>- An optional visitor. You probably should not use this unless you have a very good reason. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="UnlabeledMultiArg_8h_source.html#l00187">187</a> of file <a class="el" href="UnlabeledMultiArg_8h_source.html">UnlabeledMultiArg.h</a>.</p>
|
|
|
|
<p>References <a class="el" href="Arg_8h_source.html#l00150">TCLAP::Arg::_ignoreable</a>, <a class="el" href="OptionalUnlabeledTracker_8h_source.html#l00048">TCLAP::OptionalUnlabeledTracker::check()</a>, and <a class="el" href="Arg_8h_source.html#l00599">TCLAP::Arg::toString()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5c81005897f6b9673b39f5d1107f4074"></a><!-- doxytag: member="TCLAP::UnlabeledMultiArg::UnlabeledMultiArg" ref="a5c81005897f6b9673b39f5d1107f4074" args="(const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">TCLAP::UnlabeledMultiArg</a>< T >::<a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">UnlabeledMultiArg</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </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">const std::string & </td>
|
|
<td class="paramname"> <em>typeDesc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> & </td>
|
|
<td class="paramname"> <em>parser</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"> <em>ignoreable</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classTCLAP_1_1Visitor.html">Visitor</a> * </td>
|
|
<td class="paramname"> <em>v</em> = <code>NULL</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Constructor. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>- The name of the <a class="el" href="classTCLAP_1_1Arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a>. Note that this is used for identification, not as a long flag. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>desc</em> </td><td>- A description of what the argument is for or does. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>req</em> </td><td>- Whether the argument is required on the command line. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>typeDesc</em> </td><td>- A short, human readable description of the type that this object expects. This is used in the generation of the USAGE statement. The goal is to be helpful to the end user of the program. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>parser</em> </td><td>- A <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing...">CmdLine</a> parser object to add this <a class="el" href="classTCLAP_1_1Arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a> to </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ignoreable</em> </td><td>- Whether or not this argument can be ignored using the "--" flag. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>- An optional visitor. You probably should not use this unless you have a very good reason. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="UnlabeledMultiArg_8h_source.html#l00200">200</a> of file <a class="el" href="UnlabeledMultiArg_8h_source.html">UnlabeledMultiArg.h</a>.</p>
|
|
|
|
<p>References <a class="el" href="Arg_8h_source.html#l00150">TCLAP::Arg::_ignoreable</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a13b29ab754c030185e58f779dc355631">TCLAP::CmdLineInterface::add()</a>, <a class="el" href="OptionalUnlabeledTracker_8h_source.html#l00048">TCLAP::OptionalUnlabeledTracker::check()</a>, and <a class="el" href="Arg_8h_source.html#l00599">TCLAP::Arg::toString()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa065c76cd23b4acfe62c4b31d73dcf87"></a><!-- doxytag: member="TCLAP::UnlabeledMultiArg::UnlabeledMultiArg" ref="aa065c76cd23b4acfe62c4b31d73dcf87" args="(const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, bool ignoreable=false, Visitor *v=NULL)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">TCLAP::UnlabeledMultiArg</a>< T >::<a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">UnlabeledMultiArg</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </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"><a class="el" href="classTCLAP_1_1Constraint.html">Constraint</a>< T > * </td>
|
|
<td class="paramname"> <em>constraint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"> <em>ignoreable</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classTCLAP_1_1Visitor.html">Visitor</a> * </td>
|
|
<td class="paramname"> <em>v</em> = <code>NULL</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Constructor. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>- The name of the <a class="el" href="classTCLAP_1_1Arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a>. Note that this is used for identification, not as a long flag. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>desc</em> </td><td>- A description of what the argument is for or does. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>req</em> </td><td>- Whether the argument is required on the command line. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>constraint</em> </td><td>- A pointer to a <a class="el" href="classTCLAP_1_1Constraint.html" title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a> object used to constrain this <a class="el" href="classTCLAP_1_1Arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ignoreable</em> </td><td>- Whether or not this argument can be ignored using the "--" flag. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>- An optional visitor. You probably should not use this unless you have a very good reason. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="UnlabeledMultiArg_8h_source.html#l00216">216</a> of file <a class="el" href="UnlabeledMultiArg_8h_source.html">UnlabeledMultiArg.h</a>.</p>
|
|
|
|
<p>References <a class="el" href="Arg_8h_source.html#l00150">TCLAP::Arg::_ignoreable</a>, <a class="el" href="OptionalUnlabeledTracker_8h_source.html#l00048">TCLAP::OptionalUnlabeledTracker::check()</a>, and <a class="el" href="Arg_8h_source.html#l00599">TCLAP::Arg::toString()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad3d8c37cd3c71deb2275b48115a59f11"></a><!-- doxytag: member="TCLAP::UnlabeledMultiArg::UnlabeledMultiArg" ref="ad3d8c37cd3c71deb2275b48115a59f11" args="(const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">TCLAP::UnlabeledMultiArg</a>< T >::<a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">UnlabeledMultiArg</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </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"><a class="el" href="classTCLAP_1_1Constraint.html">Constraint</a>< T > * </td>
|
|
<td class="paramname"> <em>constraint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> & </td>
|
|
<td class="paramname"> <em>parser</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"> <em>ignoreable</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classTCLAP_1_1Visitor.html">Visitor</a> * </td>
|
|
<td class="paramname"> <em>v</em> = <code>NULL</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Constructor. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>- The name of the <a class="el" href="classTCLAP_1_1Arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a>. Note that this is used for identification, not as a long flag. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>desc</em> </td><td>- A description of what the argument is for or does. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>req</em> </td><td>- Whether the argument is required on the command line. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>constraint</em> </td><td>- A pointer to a <a class="el" href="classTCLAP_1_1Constraint.html" title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a> object used to constrain this <a class="el" href="classTCLAP_1_1Arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>parser</em> </td><td>- A <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing...">CmdLine</a> parser object to add this <a class="el" href="classTCLAP_1_1Arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a> to </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ignoreable</em> </td><td>- Whether or not this argument can be ignored using the "--" flag. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>- An optional visitor. You probably should not use this unless you have a very good reason. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="UnlabeledMultiArg_8h_source.html#l00229">229</a> of file <a class="el" href="UnlabeledMultiArg_8h_source.html">UnlabeledMultiArg.h</a>.</p>
|
|
|
|
<p>References <a class="el" href="Arg_8h_source.html#l00150">TCLAP::Arg::_ignoreable</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a13b29ab754c030185e58f779dc355631">TCLAP::CmdLineInterface::add()</a>, <a class="el" href="OptionalUnlabeledTracker_8h_source.html#l00048">TCLAP::OptionalUnlabeledTracker::check()</a>, and <a class="el" href="Arg_8h_source.html#l00599">TCLAP::Arg::toString()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a290b15792de11abb5a4cf1c312d6a0d7"></a><!-- doxytag: member="TCLAP::UnlabeledMultiArg::addToList" ref="a290b15792de11abb5a4cf1c312d6a0d7" args="(std::list< Arg * > &argList) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">TCLAP::UnlabeledMultiArg</a>< T >::addToList </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::list< <a class="el" href="classTCLAP_1_1Arg.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>Pushes this to back of list rather than front. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>argList</em> </td><td>- The list this should be added to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="UnlabeledMultiArg_8h_source.html#l00294">294</a> of file <a class="el" href="UnlabeledMultiArg_8h_source.html">UnlabeledMultiArg.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1e7262967b850fb30e1003890a45f1ca"></a><!-- doxytag: member="TCLAP::UnlabeledMultiArg::longID" ref="a1e7262967b850fb30e1003890a45f1ca" args="(const std::string &val="val") const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string <a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">TCLAP::UnlabeledMultiArg</a>< T >::longID </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"> <em>val</em> = <code>"val"</code></td>
|
|
<td> ) </td>
|
|
<td> const<code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the a long id string. </p>
|
|
<p>Used in the usage. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>- value to be used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classTCLAP_1_1MultiArg.html#a16c00fbce6876bceabb3dab4723f7e79">TCLAP::MultiArg< T ></a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="UnlabeledMultiArg_8h_source.html#l00278">278</a> of file <a class="el" href="UnlabeledMultiArg_8h_source.html">UnlabeledMultiArg.h</a>.</p>
|
|
|
|
<p>References <a class="el" href="MultiArg_8h_source.html#l00056">TCLAP::MultiArg< T >::_typeDesc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a059fa00203a9f643a10334fedbd43e39"></a><!-- doxytag: member="TCLAP::UnlabeledMultiArg::operator==" ref="a059fa00203a9f643a10334fedbd43e39" args="(const Arg &a) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">TCLAP::UnlabeledMultiArg</a>< T >::operator== </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classTCLAP_1_1Arg.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>Opertor ==. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>a</em> </td><td>- The <a class="el" href="classTCLAP_1_1Arg.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="UnlabeledMultiArg_8h_source.html#l00285">285</a> of file <a class="el" href="UnlabeledMultiArg_8h_source.html">UnlabeledMultiArg.h</a>.</p>
|
|
|
|
<p>References <a class="el" href="Arg_8h_source.html#l00112">TCLAP::Arg::_description</a>, <a class="el" href="Arg_8h_source.html#l00107">TCLAP::Arg::_name</a>, <a class="el" href="Arg_8h_source.html#l00554">TCLAP::Arg::getDescription()</a>, and <a class="el" href="Arg_8h_source.html#l00569">TCLAP::Arg::getName()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa5a35665519518dcb60e53d3a4858802"></a><!-- doxytag: member="TCLAP::UnlabeledMultiArg::processArg" ref="aa5a35665519518dcb60e53d3a4858802" args="(int *i, std::vector< std::string > &args)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">TCLAP::UnlabeledMultiArg</a>< T >::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">std::vector< std::string > & </td>
|
|
<td class="paramname"> <em>args</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Handles the processing of the argument. </p>
|
|
<p>This re-implements the <a class="el" href="classTCLAP_1_1Arg.html" title="A virtual base class that defines the essential data for all arguments.">Arg</a> version of this method to set the _value of the argument appropriately. It knows the difference between labeled and unlabeled. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>- Pointer the the current argument in the list. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>- Mutable list of strings. Passed from main(). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classTCLAP_1_1MultiArg.html#a344d3cf2128c510f92825e421ea667c7">TCLAP::MultiArg< T ></a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="UnlabeledMultiArg_8h_source.html#l00245">245</a> of file <a class="el" href="UnlabeledMultiArg_8h_source.html">UnlabeledMultiArg.h</a>.</p>
|
|
|
|
<p>References <a class="el" href="Arg_8h_source.html#l00137">TCLAP::Arg::_alreadySet</a>, <a class="el" href="MultiArg_8h_source.html#l00398">TCLAP::MultiArg< T >::_extractValue()</a>, and <a class="el" href="Arg_8h_source.html#l00641">TCLAP::Arg::_hasBlanks()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5971af8f29fa4d798ffde3293504c15b"></a><!-- doxytag: member="TCLAP::UnlabeledMultiArg::shortID" ref="a5971af8f29fa4d798ffde3293504c15b" args="(const std::string &val="val") const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string <a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">TCLAP::UnlabeledMultiArg</a>< T >::shortID </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"> <em>val</em> = <code>"val"</code></td>
|
|
<td> ) </td>
|
|
<td> const<code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the a short id string. </p>
|
|
<p>Used in the usage. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>- value to be used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classTCLAP_1_1MultiArg.html#ac2c962112704b899f4c8b8565f2c4bb3">TCLAP::MultiArg< T ></a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="UnlabeledMultiArg_8h_source.html#l00271">271</a> of file <a class="el" href="UnlabeledMultiArg_8h_source.html">UnlabeledMultiArg.h</a>.</p>
|
|
|
|
<p>References <a class="el" href="MultiArg_8h_source.html#l00056">TCLAP::MultiArg< T >::_typeDesc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="UnlabeledMultiArg_8h_source.html">UnlabeledMultiArg.h</a></li>
|
|
</ul>
|
|
</div>
|
|
<hr size="1"/><address style="text-align: right;"><small>Generated on Sat Apr 16 15:34:25 2011 for tclap by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.0 </small></address>
|
|
</body>
|
|
</html>
|