1441 lines
73 KiB
HTML
1441 lines
73 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::MultiArg< 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_1MultiArg.html">MultiArg</a>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>TCLAP::MultiArg< T > Class Template Reference</h1><!-- doxytag: class="TCLAP::MultiArg" -->
|
|
<!-- doxytag: inherits="TCLAP::Arg" -->
|
|
<p>An argument that allows multiple values of type T to be specified.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="MultiArg_8h_source.html">MultiArg.h</a>></code></p>
|
|
|
|
<div class="dynheader">
|
|
Inheritance diagram for TCLAP::MultiArg< T >:
|
|
</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classTCLAP_1_1MultiArg.gif" usemap="#TCLAP::MultiArg< T >_map" alt=""/>
|
|
<map id="TCLAP::MultiArg< T >_map" name="TCLAP::MultiArg< T >_map">
|
|
<area href="classTCLAP_1_1Arg.html" alt="TCLAP::Arg" shape="rect" coords="0,0,193,24"/>
|
|
<area href="classTCLAP_1_1UnlabeledMultiArg.html" alt="TCLAP::UnlabeledMultiArg< T >" shape="rect"
|
|
coords="0,112,193,136"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classTCLAP_1_1MultiArg-members.html">List of all members.</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr>
|
|
<td colspan="2"><h2>Public Types</h2></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">typedef std::vector< T > </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#adae435f03fdde769bca57327487aab78">container_type</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">typedef container_type::iterator </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#a34196784baca2bd5aa079d639d49a7ca">iterator</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
|
|
container_type::const_iterator </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#a3f8e9e8f5dcc7d3e6a518f42134cf64f">const_iterator</a>
|
|
</td>
|
|
</tr>
|
|
<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_1MultiArg.html#a49b5437c7f06cd6864c07dc59814a953">MultiArg</a>
|
|
(const std::string &flag, const std::string &name, const std::string &desc, bool req, const
|
|
std::string &typeDesc, <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="#a49b5437c7f06cd6864c07dc59814a953"></a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top"> </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#a48c90a873389280f72fb5d6ef707b400">MultiArg</a>
|
|
(const std::string &flag, 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, <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="#a48c90a873389280f72fb5d6ef707b400"></a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top"> </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#a38b1e32a8189356bd1e5ec7c2d43c1a3">MultiArg</a>
|
|
(const std::string &flag, 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_1Visitor.html">Visitor</a> *v=NULL)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Constructor. <a href="#a38b1e32a8189356bd1e5ec7c2d43c1a3"></a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top"> </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#ad4fcd892de2f1ef275c30dc499215208">MultiArg</a>
|
|
(const std::string &flag, 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, <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="#ad4fcd892de2f1ef275c30dc499215208"></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_1MultiArg.html#a344d3cf2128c510f92825e421ea667c7">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="#a344d3cf2128c510f92825e421ea667c7"></a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">const std::vector< T > & </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#aff4ff7f8d854dd668aaaf80511d8002b">getValue</a>
|
|
()
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Returns a vector of type T containing the values parsed from the command line. <a
|
|
href="#aff4ff7f8d854dd668aaaf80511d8002b"></a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#a3f8e9e8f5dcc7d3e6a518f42134cf64f">const_iterator</a>
|
|
</td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#a48058500cdc9ef8b9c2c9e6394ab499d">begin</a>
|
|
() const
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Returns an iterator over the values parsed from the command line. <a
|
|
href="#a48058500cdc9ef8b9c2c9e6394ab499d"></a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#a3f8e9e8f5dcc7d3e6a518f42134cf64f">const_iterator</a>
|
|
</td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#ac30e414b799158ff6710fb1e7ce83aee">end</a>
|
|
() const
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Returns the end of the values parsed from the command line. <a
|
|
href="#ac30e414b799158ff6710fb1e7ce83aee"></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_1MultiArg.html#ac2c962112704b899f4c8b8565f2c4bb3">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="#ac2c962112704b899f4c8b8565f2c4bb3"></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_1MultiArg.html#a16c00fbce6876bceabb3dab4723f7e79">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="#a16c00fbce6876bceabb3dab4723f7e79"></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_1MultiArg.html#a3cb7fec92f3d70e0e455c6bc33fbebab">isRequired</a>
|
|
() const
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Once we've matched the first value, then the arg is no longer required. <a
|
|
href="#a3cb7fec92f3d70e0e455c6bc33fbebab"></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_1MultiArg.html#ab05097627c81cd65975fa1b99fae9bd0">allowMore</a>
|
|
()
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Used for MultiArgs and <a class="el" href="classTCLAP_1_1XorHandler.html"
|
|
title="This class handles lists of Arg's that are to be XOR'd on the command line...">XorHandler</a>
|
|
to determine whether args can still be set. <a href="#ab05097627c81cd65975fa1b99fae9bd0"></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_1MultiArg.html#ab21f01f22978a1c0eea716399e9ff89b">reset</a>
|
|
()
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Clears the <a class="el" href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a>
|
|
object and allows it to be reused by new command lines. <a
|
|
href="#ab21f01f22978a1c0eea716399e9ff89b"></a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2"><h2>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="classTCLAP_1_1MultiArg.html#a26cbf5e86ac66d876f9285f1fda22470">_extractValue</a>
|
|
(const std::string &val)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Extracts the value from the string. <a href="#a26cbf5e86ac66d876f9285f1fda22470"></a><br/>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2"><h2>Protected Attributes</h2></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">std::vector< T > </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#aabcab153e09608343713a6ffef431783">_values</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">The list of values parsed from the <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>.
|
|
<a href="#aabcab153e09608343713a6ffef431783"></a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">std::string </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#a0f6a2b04fe15d1ede95165fc6e1949e8">_typeDesc</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">The description of type T to be used in the usage. <a
|
|
href="#a0f6a2b04fe15d1ede95165fc6e1949e8"></a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top"><a class="el" href="classTCLAP_1_1Constraint.html">Constraint</a><
|
|
T > * </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#afc754048b66bc3a251268947273ea906">_constraint</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A list of constraint on this <a class="el" href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a>.
|
|
<a href="#afc754048b66bc3a251268947273ea906"></a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">bool </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#a93a3ef586f763d46839c0e737689b85f">_allowMore</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Used by <a class="el" href="classTCLAP_1_1XorHandler.html"
|
|
title="This class handles lists of Arg's that are to be XOR'd on the command line...">XorHandler</a>
|
|
to decide whether to keep parsing for this arg. <a href="#a93a3ef586f763d46839c0e737689b85f"></a><br/>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr/>
|
|
<a name="_details"></a>
|
|
|
|
<h2>Detailed Description</h2>
|
|
|
|
<h3>template<class T><br/>
|
|
class TCLAP::MultiArg< T ></h3>
|
|
|
|
<p>An argument that allows multiple values of type T to be specified. </p>
|
|
|
|
<p>Very similar to a <a class="el" href="classTCLAP_1_1ValueArg.html"
|
|
title="The basic labeled argument that parses a value.">ValueArg</a>, except a vector of
|
|
values will be returned instead of just one. </p>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00039">39</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
<hr/>
|
|
<h2>Member Typedef Documentation</h2>
|
|
<a class="anchor" id="a3f8e9e8f5dcc7d3e6a518f42134cf64f"></a><!-- doxytag: member="TCLAP::MultiArg::const_iterator" ref="a3f8e9e8f5dcc7d3e6a518f42134cf64f" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef container_type::const_iterator <a class="el"
|
|
href="classTCLAP_1_1MultiArg.html">TCLAP::MultiArg</a><
|
|
T >::<a class="el" href="classTCLAP_1_1MultiArg.html#a3f8e9e8f5dcc7d3e6a518f42134cf64f">const_iterator</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00044">44</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adae435f03fdde769bca57327487aab78"></a><!-- doxytag: member="TCLAP::MultiArg::container_type" ref="adae435f03fdde769bca57327487aab78" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef std::vector<T> <a class="el" href="classTCLAP_1_1MultiArg.html">TCLAP::MultiArg</a><
|
|
T >::<a class="el" href="classTCLAP_1_1MultiArg.html#adae435f03fdde769bca57327487aab78">container_type</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00042">42</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a34196784baca2bd5aa079d639d49a7ca"></a><!-- doxytag: member="TCLAP::MultiArg::iterator" ref="a34196784baca2bd5aa079d639d49a7ca" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef container_type::iterator <a class="el"
|
|
href="classTCLAP_1_1MultiArg.html">TCLAP::MultiArg</a><
|
|
T >::<a class="el" href="classTCLAP_1_1MultiArg.html#a34196784baca2bd5aa079d639d49a7ca">iterator</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00043">43</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>
|
|
<h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a49b5437c7f06cd6864c07dc59814a953"></a><!-- doxytag: member="TCLAP::MultiArg::MultiArg" ref="a49b5437c7f06cd6864c07dc59814a953" args="(const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, 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_1MultiArg.html">TCLAP::MultiArg</a>< T >::<a
|
|
class="el" href="classTCLAP_1_1MultiArg.html">MultiArg</a></td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>flag</em>,</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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_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>flag</em> </td>
|
|
<td>- The one character flag that identifies this argument on the command line.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"></td>
|
|
<td valign="top"><em>name</em> </td>
|
|
<td>- A one word name for the argument. Can be used as a long flag on the command line.</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>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="MultiArg_8h_source.html#l00234">234</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="Arg_8h_source.html#l00158">TCLAP::Arg::_acceptsMultipleValues</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a48c90a873389280f72fb5d6ef707b400"></a><!-- doxytag: member="TCLAP::MultiArg::MultiArg" ref="a48c90a873389280f72fb5d6ef707b400" args="(const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, CmdLineInterface &parser, 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_1MultiArg.html">TCLAP::MultiArg</a>< T >::<a
|
|
class="el" href="classTCLAP_1_1MultiArg.html">MultiArg</a></td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>flag</em>,</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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"><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>flag</em> </td>
|
|
<td>- The one character flag that identifies this argument on the command line.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"></td>
|
|
<td valign="top"><em>name</em> </td>
|
|
<td>- A one word name for the argument. Can be used as a long flag on the command line.</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>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="MultiArg_8h_source.html#l00250">250</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="Arg_8h_source.html#l00158">TCLAP::Arg::_acceptsMultipleValues</a>, and <a
|
|
class="el" href="classTCLAP_1_1CmdLineInterface.html#a13b29ab754c030185e58f779dc355631">TCLAP::CmdLineInterface::add()</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a38b1e32a8189356bd1e5ec7c2d43c1a3"></a><!-- doxytag: member="TCLAP::MultiArg::MultiArg" ref="a38b1e32a8189356bd1e5ec7c2d43c1a3" args="(const std::string &flag, const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, 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_1MultiArg.html">TCLAP::MultiArg</a>< T >::<a
|
|
class="el" href="classTCLAP_1_1MultiArg.html">MultiArg</a></td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>flag</em>,</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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_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>flag</em> </td>
|
|
<td>- The one character flag that identifies this argument on the command line.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"></td>
|
|
<td valign="top"><em>name</em> </td>
|
|
<td>- A one word name for the argument. Can be used as a long flag on the command line.</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>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="MultiArg_8h_source.html#l00271">271</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="Arg_8h_source.html#l00158">TCLAP::Arg::_acceptsMultipleValues</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad4fcd892de2f1ef275c30dc499215208"></a><!-- doxytag: member="TCLAP::MultiArg::MultiArg" ref="ad4fcd892de2f1ef275c30dc499215208" args="(const std::string &flag, const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, CmdLineInterface &parser, 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_1MultiArg.html">TCLAP::MultiArg</a>< T >::<a
|
|
class="el" href="classTCLAP_1_1MultiArg.html">MultiArg</a></td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>flag</em>,</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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"><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>flag</em> </td>
|
|
<td>- The one character flag that identifies this argument on the command line.</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"></td>
|
|
<td valign="top"><em>name</em> </td>
|
|
<td>- A one word name for the argument. Can be used as a long flag on the command line.</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>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="MultiArg_8h_source.html#l00287">287</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="Arg_8h_source.html#l00158">TCLAP::Arg::_acceptsMultipleValues</a>, and <a
|
|
class="el" href="classTCLAP_1_1CmdLineInterface.html#a13b29ab754c030185e58f779dc355631">TCLAP::CmdLineInterface::add()</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>
|
|
<h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a26cbf5e86ac66d876f9285f1fda22470"></a><!-- doxytag: member="TCLAP::MultiArg::_extractValue" ref="a26cbf5e86ac66d876f9285f1fda22470" args="(const std::string &val)" -->
|
|
<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_1MultiArg.html">TCLAP::MultiArg</a>< T
|
|
>::_extractValue
|
|
</td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>val</em></td>
|
|
<td> ) </td>
|
|
<td><code> [inline, protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Extracts the value from the string. </p>
|
|
|
|
<p>Attempts to parse string as type T, if this fails an exception is thrown. </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>- The string to be read.</td>
|
|
</tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00398">398</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="MultiArg_8h_source.html#l00061">TCLAP::MultiArg< T
|
|
>::_constraint</a>, <a class="el" href="MultiArg_8h_source.html#l00051">TCLAP::MultiArg< T >::_values</a>,
|
|
<a class="el" href="ArgException_8h_source.html#l00064">TCLAP::ArgException::error()</a>, <a class="el"
|
|
href="Arg_8h_source.html#l00415">TCLAP::ExtractValue()</a>,
|
|
and <a class="el" href="Arg_8h_source.html#l00599">TCLAP::Arg::toString()</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="UnlabeledMultiArg_8h_source.html#l00245">TCLAP::UnlabeledMultiArg< T
|
|
>::processArg()</a>, and <a class="el" href="MultiArg_8h_source.html#l00308">TCLAP::MultiArg< T
|
|
>::processArg()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab05097627c81cd65975fa1b99fae9bd0"></a><!-- doxytag: member="TCLAP::MultiArg::allowMore" ref="ab05097627c81cd65975fa1b99fae9bd0" 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_1MultiArg.html">TCLAP::MultiArg</a>< T
|
|
>::allowMore
|
|
</td>
|
|
<td>(</td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Used for MultiArgs and <a class="el" href="classTCLAP_1_1XorHandler.html"
|
|
title="This class handles lists of Arg's that are to be XOR'd on the command line...">XorHandler</a>
|
|
to determine whether args can still be set. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="classTCLAP_1_1Arg.html#a9aef735d37ef95ca1b7dc7a07850b984">TCLAP::Arg</a>.
|
|
</p>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00417">417</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="MultiArg_8h_source.html#l00074">TCLAP::MultiArg< T >::_allowMore</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a48058500cdc9ef8b9c2c9e6394ab499d"></a><!-- doxytag: member="TCLAP::MultiArg::begin" ref="a48058500cdc9ef8b9c2c9e6394ab499d" args="() const " -->
|
|
<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_1MultiArg.html#a3f8e9e8f5dcc7d3e6a518f42134cf64f">const_iterator</a>
|
|
<a class="el" href="classTCLAP_1_1MultiArg.html">TCLAP::MultiArg</a>< T >::begin
|
|
</td>
|
|
<td>(</td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns an iterator over the values parsed from the command line. </p>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00194">194</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="MultiArg_8h_source.html#l00051">TCLAP::MultiArg< T >::_values</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac30e414b799158ff6710fb1e7ce83aee"></a><!-- doxytag: member="TCLAP::MultiArg::end" ref="ac30e414b799158ff6710fb1e7ce83aee" args="() const " -->
|
|
<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_1MultiArg.html#a3f8e9e8f5dcc7d3e6a518f42134cf64f">const_iterator</a>
|
|
<a class="el" href="classTCLAP_1_1MultiArg.html">TCLAP::MultiArg</a>< T >::end
|
|
</td>
|
|
<td>(</td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the end of the values parsed from the command line. </p>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00200">200</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="MultiArg_8h_source.html#l00051">TCLAP::MultiArg< T >::_values</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aff4ff7f8d854dd668aaaf80511d8002b"></a><!-- doxytag: member="TCLAP::MultiArg::getValue" ref="aff4ff7f8d854dd668aaaf80511d8002b" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::vector< T > & <a class="el"
|
|
href="classTCLAP_1_1MultiArg.html">TCLAP::MultiArg</a><
|
|
T >::getValue
|
|
</td>
|
|
<td>(</td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns a vector of type T containing the values parsed from the command line. </p>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00305">305</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="MultiArg_8h_source.html#l00051">TCLAP::MultiArg< T >::_values</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3cb7fec92f3d70e0e455c6bc33fbebab"></a><!-- doxytag: member="TCLAP::MultiArg::isRequired" ref="a3cb7fec92f3d70e0e455c6bc33fbebab" args="() 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_1MultiArg.html">TCLAP::MultiArg</a>< T
|
|
>::isRequired
|
|
</td>
|
|
<td>(</td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td> const<code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Once we've matched the first value, then the arg is no longer required. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="classTCLAP_1_1Arg.html#a00a3cfdb2b6e9a111ad39cbd4978b96c">TCLAP::Arg</a>.
|
|
</p>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00383">383</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="Arg_8h_source.html#l00117">TCLAP::Arg::_required</a>, and <a class="el"
|
|
href="MultiArg_8h_source.html#l00051">TCLAP::MultiArg<
|
|
T >::_values</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a16c00fbce6876bceabb3dab4723f7e79"></a><!-- doxytag: member="TCLAP::MultiArg::longID" ref="a16c00fbce6876bceabb3dab4723f7e79" 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_1MultiArg.html">TCLAP::MultiArg</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_1Arg.html#aad93aff46e1fc67e3853765f565bfa96">TCLAP::Arg</a>.
|
|
</p>
|
|
|
|
<p>Reimplemented in <a class="el"
|
|
href="classTCLAP_1_1UnlabeledMultiArg.html#a1e7262967b850fb30e1003890a45f1ca">TCLAP::UnlabeledMultiArg<
|
|
T ></a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00372">372</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.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="a344d3cf2128c510f92825e421ea667c7"></a><!-- doxytag: member="TCLAP::MultiArg::processArg" ref="a344d3cf2128c510f92825e421ea667c7" 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_1MultiArg.html">TCLAP::MultiArg</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>Implements <a class="el" href="classTCLAP_1_1Arg.html#a61ffe2f660a76111d256f7b22a686146">TCLAP::Arg</a>.
|
|
</p>
|
|
|
|
<p>Reimplemented in <a class="el"
|
|
href="classTCLAP_1_1UnlabeledMultiArg.html#aa5a35665519518dcb60e53d3a4858802">TCLAP::UnlabeledMultiArg<
|
|
T ></a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00308">308</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="Arg_8h_source.html#l00137">TCLAP::Arg::_alreadySet</a>, <a class="el"
|
|
href="Arg_8h_source.html#l00611">TCLAP::Arg::_checkWithVisitor()</a>,
|
|
<a class="el" href="MultiArg_8h_source.html#l00398">TCLAP::MultiArg< T >::_extractValue()</a>, <a
|
|
class="el" href="Arg_8h_source.html#l00641">TCLAP::Arg::_hasBlanks()</a>, <a class="el"
|
|
href="Arg_8h_source.html#l00150">TCLAP::Arg::_ignoreable</a>,
|
|
<a class="el" href="Arg_8h_source.html#l00590">TCLAP::Arg::argMatches()</a>, <a class="el"
|
|
href="Arg_8h_source.html#l00211">TCLAP::Arg::delimiter()</a>,
|
|
<a class="el" href="Arg_8h_source.html#l00205">TCLAP::Arg::ignoreRest()</a>, <a class="el"
|
|
href="Arg_8h_source.html#l00599">TCLAP::Arg::toString()</a>,
|
|
and <a class="el" href="Arg_8h_source.html#l00620">TCLAP::Arg::trimFlag()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab21f01f22978a1c0eea716399e9ff89b"></a><!-- doxytag: member="TCLAP::MultiArg::reset" ref="ab21f01f22978a1c0eea716399e9ff89b" args="()" -->
|
|
<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_1MultiArg.html">TCLAP::MultiArg</a>< T
|
|
>::reset
|
|
</td>
|
|
<td>(</td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Clears the <a class="el" href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a>
|
|
object and allows it to be reused by new command lines. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="classTCLAP_1_1Arg.html#ab5b5dc9a9b0381561f0684523f943a2c">TCLAP::Arg</a>.
|
|
</p>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00425">425</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="MultiArg_8h_source.html#l00051">TCLAP::MultiArg< T >::_values</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac2c962112704b899f4c8b8565f2c4bb3"></a><!-- doxytag: member="TCLAP::MultiArg::shortID" ref="ac2c962112704b899f4c8b8565f2c4bb3" 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_1MultiArg.html">TCLAP::MultiArg</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_1Arg.html#aef8efaf3811162b2b2b2a84c6db280fa">TCLAP::Arg</a>.
|
|
</p>
|
|
|
|
<p>Reimplemented in <a class="el"
|
|
href="classTCLAP_1_1UnlabeledMultiArg.html#a5971af8f29fa4d798ffde3293504c15b">TCLAP::UnlabeledMultiArg<
|
|
T ></a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00362">362</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="MultiArg_8h_source.html#l00056">TCLAP::MultiArg< T >::_typeDesc</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>
|
|
<h2>Member Data Documentation</h2>
|
|
<a class="anchor" id="a93a3ef586f763d46839c0e737689b85f"></a><!-- doxytag: member="TCLAP::MultiArg::_allowMore" ref="a93a3ef586f763d46839c0e737689b85f" 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_1MultiArg.html">TCLAP::MultiArg</a>< T
|
|
>::<a class="el" href="classTCLAP_1_1MultiArg.html#a93a3ef586f763d46839c0e737689b85f">_allowMore</a><code>
|
|
[protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Used by <a class="el" href="classTCLAP_1_1XorHandler.html"
|
|
title="This class handles lists of Arg's that are to be XOR'd on the command line...">XorHandler</a>
|
|
to decide whether to keep parsing for this arg. </p>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00074">74</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>Referenced by <a class="el" href="MultiArg_8h_source.html#l00417">TCLAP::MultiArg< T
|
|
>::allowMore()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afc754048b66bc3a251268947273ea906"></a><!-- doxytag: member="TCLAP::MultiArg::_constraint" ref="afc754048b66bc3a251268947273ea906" args="" -->
|
|
<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_1Constraint.html">Constraint</a><T>* <a
|
|
class="el" href="classTCLAP_1_1MultiArg.html">TCLAP::MultiArg</a>< T >::<a class="el"
|
|
href="classTCLAP_1_1MultiArg.html#afc754048b66bc3a251268947273ea906">_constraint</a><code>
|
|
[protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>A list of constraint on this <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="MultiArg_8h_source.html#l00061">61</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>Referenced by <a class="el" href="MultiArg_8h_source.html#l00398">TCLAP::MultiArg< T >::_extractValue()</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0f6a2b04fe15d1ede95165fc6e1949e8"></a><!-- doxytag: member="TCLAP::MultiArg::_typeDesc" ref="a0f6a2b04fe15d1ede95165fc6e1949e8" args="" -->
|
|
<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_1MultiArg.html">TCLAP::MultiArg</a><
|
|
T >::<a class="el" href="classTCLAP_1_1MultiArg.html#a0f6a2b04fe15d1ede95165fc6e1949e8">_typeDesc</a><code>
|
|
[protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>The description of type T to be used in the usage. </p>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00056">56</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>Referenced by <a class="el" href="UnlabeledMultiArg_8h_source.html#l00278">TCLAP::UnlabeledMultiArg< T
|
|
>::longID()</a>, <a class="el" href="MultiArg_8h_source.html#l00372">TCLAP::MultiArg< T >::longID()</a>,
|
|
<a class="el" href="UnlabeledMultiArg_8h_source.html#l00271">TCLAP::UnlabeledMultiArg< T >::shortID()</a>,
|
|
and <a class="el" href="MultiArg_8h_source.html#l00362">TCLAP::MultiArg< T >::shortID()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aabcab153e09608343713a6ffef431783"></a><!-- doxytag: member="TCLAP::MultiArg::_values" ref="aabcab153e09608343713a6ffef431783" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<T> <a class="el" href="classTCLAP_1_1MultiArg.html">TCLAP::MultiArg</a><
|
|
T >::<a class="el" href="classTCLAP_1_1MultiArg.html#aabcab153e09608343713a6ffef431783">_values</a><code>
|
|
[protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>The list of values parsed from the <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>.
|
|
</p>
|
|
|
|
<p>Definition at line <a class="el" href="MultiArg_8h_source.html#l00051">51</a> of file <a class="el"
|
|
href="MultiArg_8h_source.html">MultiArg.h</a>.
|
|
</p>
|
|
|
|
<p>Referenced by <a class="el" href="MultiArg_8h_source.html#l00398">TCLAP::MultiArg< T >::_extractValue()</a>,
|
|
<a class="el" href="MultiArg_8h_source.html#l00194">TCLAP::MultiArg< T >::begin()</a>, <a
|
|
class="el" href="MultiArg_8h_source.html#l00200">TCLAP::MultiArg< T >::end()</a>, <a
|
|
class="el" href="MultiArg_8h_source.html#l00305">TCLAP::MultiArg< T >::getValue()</a>, <a
|
|
class="el" href="MultiArg_8h_source.html#l00383">TCLAP::MultiArg< T >::isRequired()</a>,
|
|
and <a class="el" href="MultiArg_8h_source.html#l00425">TCLAP::MultiArg< T >::reset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>
|
|
The documentation for this class was generated from the following file:
|
|
<ul>
|
|
<li><a class="el" href="MultiArg_8h_source.html">MultiArg.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>
|