877 lines
46 KiB
HTML
877 lines
46 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 Namespace 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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><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="namespaces.html"><span>Namespace List</span></a></li>
|
|
<li><a href="namespacemembers.html"><span>Namespace Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>TCLAP Namespace Reference</h1>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr>
|
|
<td colspan="2"><h2>Classes</h2></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1Arg.html">Arg</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A virtual base class that defines the essential data for all arguments. <a
|
|
href="classTCLAP_1_1Arg.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1ArgException.html">ArgException</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A simple class that defines and argument exception. <a
|
|
href="classTCLAP_1_1ArgException.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgParseException.html">ArgParseException</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Thrown from within the child <a class="el" href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a>
|
|
classes when it fails to properly parse the argument it has been passed. <a
|
|
href="classTCLAP_1_1ArgParseException.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1CmdLineParseException.html">CmdLineParseException</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Thrown from <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>
|
|
when the arguments on the command line are not properly specified, e.g. <a
|
|
href="classTCLAP_1_1CmdLineParseException.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1SpecificationException.html">SpecificationException</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Thrown from <a class="el" href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a>
|
|
and <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>
|
|
when an <a class="el" href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a> is
|
|
improperly specified, e.g. <a href="classTCLAP_1_1SpecificationException.html#_details">More...</a><br/>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1ExitException.html">ExitException</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="structTCLAP_1_1ValueLike.html">ValueLike</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A value like argument value type is a value that can be set using operator>>.
|
|
<a href="structTCLAP_1_1ValueLike.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="structTCLAP_1_1StringLike.html">StringLike</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A string like argument value type is a value that can be set using operator=(string).
|
|
<a href="structTCLAP_1_1StringLike.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="structTCLAP_1_1StringLikeTrait.html">StringLikeTrait</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A class can inherit from this object to make it have string like traits. <a
|
|
href="structTCLAP_1_1StringLikeTrait.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="structTCLAP_1_1ValueLikeTrait.html">ValueLikeTrait</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A class can inherit from this object to make it have value like traits. <a
|
|
href="structTCLAP_1_1ValueLikeTrait.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="structTCLAP_1_1ArgTraits.html">ArgTraits</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight"><a class="el" href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a>
|
|
traits are used to get compile type specialization when parsing argument values. <a
|
|
href="structTCLAP_1_1ArgTraits.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1CmdLine.html">CmdLine</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">The base class that manages the command line definition and passes along the parsing
|
|
to the appropriate <a class="el" href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a>
|
|
classes. <a href="classTCLAP_1_1CmdLine.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">The base class that manages the command line definition and passes along the parsing
|
|
to the appropriate <a class="el" href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a>
|
|
classes. <a href="classTCLAP_1_1CmdLineInterface.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1CmdLineOutput.html">CmdLineOutput</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">The interface that any output object must implement. <a
|
|
href="classTCLAP_1_1CmdLineOutput.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1Constraint.html">Constraint</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">The interface that defines the interaction between the <a class="el"
|
|
href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a>
|
|
and <a class="el" href="classTCLAP_1_1Constraint.html"
|
|
title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a>.
|
|
<a href="classTCLAP_1_1Constraint.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="classTCLAP_1_1DocBookOutput.html">DocBookOutput</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A class that generates DocBook output for <a class="el"
|
|
href="classTCLAP_1_1DocBookOutput.html#adc1ec93f3f7e5e912690be01c5e7d6e2"
|
|
title="Prints the usage to stdout.">usage()</a>
|
|
method for the given <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>
|
|
and its Args. <a href="classTCLAP_1_1DocBookOutput.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1HelpVisitor.html">HelpVisitor</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A <a class="el" href="classTCLAP_1_1Visitor.html"
|
|
title="A base class that defines the interface for visitors.">Visitor</a> object
|
|
that calls the usage method of the given <a class="el" href="classTCLAP_1_1CmdLineOutput.html"
|
|
title="The interface that any output object must implement.">CmdLineOutput</a>
|
|
object for the specified <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>
|
|
object. <a href="classTCLAP_1_1HelpVisitor.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1IgnoreRestVisitor.html">IgnoreRestVisitor</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A Vistor that tells 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>
|
|
to begin ignoring arguments after this one is parsed. <a
|
|
href="classTCLAP_1_1IgnoreRestVisitor.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1MultiArg.html">MultiArg</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">An argument that allows multiple values of type T to be specified. <a
|
|
href="classTCLAP_1_1MultiArg.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1MultiSwitchArg.html">MultiSwitchArg</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A multiple switch argument. <a href="classTCLAP_1_1MultiSwitchArg.html#_details">More...</a><br/>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1OptionalUnlabeledTracker.html">OptionalUnlabeledTracker</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="structTCLAP_1_1ArgTraits_3_01long_01_4.html">ArgTraits<
|
|
long ></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">longs have value-like semantics. <a
|
|
href="structTCLAP_1_1ArgTraits_3_01long_01_4.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="structTCLAP_1_1ArgTraits_3_01int_01_4.html">ArgTraits<
|
|
int ></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">ints have value-like semantics. <a
|
|
href="structTCLAP_1_1ArgTraits_3_01int_01_4.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="structTCLAP_1_1ArgTraits_3_01short_01_4.html">ArgTraits<
|
|
short ></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">shorts have value-like semantics. <a
|
|
href="structTCLAP_1_1ArgTraits_3_01short_01_4.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="structTCLAP_1_1ArgTraits_3_01char_01_4.html">ArgTraits<
|
|
char ></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">chars have value-like semantics. <a
|
|
href="structTCLAP_1_1ArgTraits_3_01char_01_4.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="structTCLAP_1_1ArgTraits_3_01unsigned_01long_01_4.html">ArgTraits<
|
|
unsigned long ></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">unsigned longs have value-like semantics. <a
|
|
href="structTCLAP_1_1ArgTraits_3_01unsigned_01long_01_4.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="structTCLAP_1_1ArgTraits_3_01unsigned_01int_01_4.html">ArgTraits<
|
|
unsigned int ></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">unsigned ints have value-like semantics. <a
|
|
href="structTCLAP_1_1ArgTraits_3_01unsigned_01int_01_4.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="structTCLAP_1_1ArgTraits_3_01unsigned_01short_01_4.html">ArgTraits<
|
|
unsigned short ></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">unsigned shorts have value-like semantics. <a
|
|
href="structTCLAP_1_1ArgTraits_3_01unsigned_01short_01_4.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="structTCLAP_1_1ArgTraits_3_01unsigned_01char_01_4.html">ArgTraits<
|
|
unsigned char ></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">unsigned chars have value-like semantics. <a
|
|
href="structTCLAP_1_1ArgTraits_3_01unsigned_01char_01_4.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="structTCLAP_1_1ArgTraits_3_01float_01_4.html">ArgTraits<
|
|
float ></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">floats have value-like semantics. <a
|
|
href="structTCLAP_1_1ArgTraits_3_01float_01_4.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="structTCLAP_1_1ArgTraits_3_01double_01_4.html">ArgTraits<
|
|
double ></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">doubles have value-like semantics. <a
|
|
href="structTCLAP_1_1ArgTraits_3_01double_01_4.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="structTCLAP_1_1ArgTraits_3_01bool_01_4.html">ArgTraits<
|
|
bool ></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">bools have value-like semantics. <a
|
|
href="structTCLAP_1_1ArgTraits_3_01bool_01_4.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="structTCLAP_1_1ArgTraits_3_01wchar__t_01_4.html">ArgTraits<
|
|
wchar_t ></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">wchar_ts have value-like semantics. <a
|
|
href="structTCLAP_1_1ArgTraits_3_01wchar__t_01_4.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">struct </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="structTCLAP_1_1ArgTraits_3_01std_1_1string_01_4.html">ArgTraits<
|
|
std::string ></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Strings have string like argument traits. <a
|
|
href="structTCLAP_1_1ArgTraits_3_01std_1_1string_01_4.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1StdOutput.html">StdOutput</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A class that isolates any output 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>
|
|
object so that it may be easily modified. <a
|
|
href="classTCLAP_1_1StdOutput.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1SwitchArg.html">SwitchArg</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A simple switch argument. <a href="classTCLAP_1_1SwitchArg.html#_details">More...</a><br/>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1UnlabeledMultiArg.html">UnlabeledMultiArg</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">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="classTCLAP_1_1UnlabeledMultiArg.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1UnlabeledValueArg.html">UnlabeledValueArg</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">The basic unlabeled argument that parses a value. <a
|
|
href="classTCLAP_1_1UnlabeledValueArg.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ValueArg.html">ValueArg</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">The basic labeled argument that parses a value. <a
|
|
href="classTCLAP_1_1ValueArg.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ValuesConstraint.html">ValuesConstraint</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A <a class="el" href="classTCLAP_1_1Constraint.html"
|
|
title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a>
|
|
that constrains 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 only those values specified in the constraint. <a
|
|
href="classTCLAP_1_1ValuesConstraint.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1VersionVisitor.html">VersionVisitor</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A Vistor that will call the version method of the given <a class="el"
|
|
href="classTCLAP_1_1CmdLineOutput.html"
|
|
title="The interface that any output object must implement.">CmdLineOutput</a>
|
|
for the specified <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>
|
|
object and then exit. <a href="classTCLAP_1_1VersionVisitor.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1Visitor.html">Visitor</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A base class that defines the interface for visitors. <a
|
|
href="classTCLAP_1_1Visitor.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1XorHandler.html">XorHandler</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">This class handles lists of Arg's that are to be XOR'd on the command line. <a
|
|
href="classTCLAP_1_1XorHandler.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">class </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ZshCompletionOutput.html">ZshCompletionOutput</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">A class that generates a Zsh completion function as output from the <a class="el"
|
|
href="classTCLAP_1_1ZshCompletionOutput.html#a3ea685b174fce7ddf2353129863b49d7"
|
|
title="Prints the usage to stdout.">usage()</a>
|
|
method for the given <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>
|
|
and its Args. <a href="classTCLAP_1_1ZshCompletionOutput.html#_details">More...</a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2"><h2>Typedefs</h2></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">typedef std::list< <a class="el"
|
|
href="classTCLAP_1_1Arg.html">Arg</a>
|
|
* ><br class="typebreak"/>
|
|
::iterator </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="namespaceTCLAP.html#aa7d6a803e0690c3c8b1db57c145648c5">ArgListIterator</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Typedef of an <a class="el" href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a>
|
|
list iterator. <a href="#aa7d6a803e0690c3c8b1db57c145648c5"></a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">typedef std::vector< <a class="el"
|
|
href="classTCLAP_1_1Arg.html">Arg</a>
|
|
* ><br class="typebreak"/>
|
|
::iterator </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="namespaceTCLAP.html#a04213af1ffc3178ce5f771d21d5164a2">ArgVectorIterator</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Typedef of an <a class="el" href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a>
|
|
vector iterator. <a href="#a04213af1ffc3178ce5f771d21d5164a2"></a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memItemLeft" align="right" valign="top">typedef std::list< <a class="el"
|
|
href="classTCLAP_1_1Visitor.html">Visitor</a>
|
|
* ><br class="typebreak"/>
|
|
::iterator </td>
|
|
<td class="memItemRight" valign="bottom"><a class="el"
|
|
href="namespaceTCLAP.html#a30300bc675a64eacafa1298268de1101">VisitorListIterator</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdescLeft"> </td>
|
|
<td class="mdescRight">Typedef of a <a class="el" href="classTCLAP_1_1Visitor.html"
|
|
title="A base class that defines the interface for visitors.">Visitor</a>
|
|
list iterator. <a href="#a30300bc675a64eacafa1298268de1101"></a><br/></td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2"><h2>Functions</h2></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memTemplParams" colspan="2">template<typename T > </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memTemplItemLeft" align="right" valign="top">void </td>
|
|
<td class="memTemplItemRight" valign="bottom"><a class="el"
|
|
href="namespaceTCLAP.html#a80473f9a24db31df0206504c2cdf0a8d">ExtractValue</a>
|
|
(T &destVal, const std::string &strVal, <a class="el" href="structTCLAP_1_1ValueLike.html">ValueLike</a>
|
|
vl)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memTemplParams" colspan="2">template<typename T > </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memTemplItemLeft" align="right" valign="top">void </td>
|
|
<td class="memTemplItemRight" valign="bottom"><a class="el"
|
|
href="namespaceTCLAP.html#adf4c56655c8414e1dd70d56ceda8ce3f">ExtractValue</a>
|
|
(T &destVal, const std::string &strVal, <a class="el" href="structTCLAP_1_1StringLike.html">StringLike</a>
|
|
sl)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memTemplParams" colspan="2">template<typename T > </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memTemplItemLeft" align="right" valign="top">void </td>
|
|
<td class="memTemplItemRight" valign="bottom"><a class="el"
|
|
href="namespaceTCLAP.html#a5a9391091b2232ce2647aecd42ef82be">DelPtr</a>
|
|
(T ptr)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memTemplParams" colspan="2">template<typename C > </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memTemplItemLeft" align="right" valign="top">void </td>
|
|
<td class="memTemplItemRight" valign="bottom"><a class="el"
|
|
href="namespaceTCLAP.html#add5aef761d6b2640f418a050b68a500e">ClearContainer</a>
|
|
(C &c)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memTemplParams" colspan="2">template<typename T > </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memTemplItemLeft" align="right" valign="top">void </td>
|
|
<td class="memTemplItemRight" valign="bottom"><a class="el"
|
|
href="namespaceTCLAP.html#a06cca5c0de2e5803a67c63cde60a2dfb">SetString</a>
|
|
(T &dst, const std::string &src)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr/>
|
|
<h2>Typedef Documentation</h2>
|
|
<a class="anchor" id="aa7d6a803e0690c3c8b1db57c145648c5"></a><!-- doxytag: member="TCLAP::ArgListIterator" ref="aa7d6a803e0690c3c8b1db57c145648c5" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef std::list<<a class="el" href="classTCLAP_1_1Arg.html">Arg</a>*>::iterator
|
|
<a class="el" href="namespaceTCLAP.html#aa7d6a803e0690c3c8b1db57c145648c5">TCLAP::ArgListIterator</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Typedef of an <a class="el" href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a>
|
|
list iterator. </p>
|
|
|
|
<p>Definition at line <a class="el" href="Arg_8h_source.html#l00396">396</a> of file <a class="el"
|
|
href="Arg_8h_source.html">Arg.h</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a04213af1ffc3178ce5f771d21d5164a2"></a><!-- doxytag: member="TCLAP::ArgVectorIterator" ref="a04213af1ffc3178ce5f771d21d5164a2" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef std::vector<<a class="el" href="classTCLAP_1_1Arg.html">Arg</a>*>::iterator
|
|
<a class="el" href="namespaceTCLAP.html#a04213af1ffc3178ce5f771d21d5164a2">TCLAP::ArgVectorIterator</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Typedef of an <a class="el" href="classTCLAP_1_1Arg.html"
|
|
title="A virtual base class that defines the essential data for all arguments.">Arg</a>
|
|
vector iterator. </p>
|
|
|
|
<p>Definition at line <a class="el" href="Arg_8h_source.html#l00401">401</a> of file <a class="el"
|
|
href="Arg_8h_source.html">Arg.h</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a30300bc675a64eacafa1298268de1101"></a><!-- doxytag: member="TCLAP::VisitorListIterator" ref="a30300bc675a64eacafa1298268de1101" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef std::list<<a class="el" href="classTCLAP_1_1Visitor.html">Visitor</a>*>::iterator
|
|
<a class="el" href="namespaceTCLAP.html#a30300bc675a64eacafa1298268de1101">TCLAP::VisitorListIterator</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Typedef of a <a class="el" href="classTCLAP_1_1Visitor.html"
|
|
title="A base class that defines the interface for visitors.">Visitor</a> list iterator.
|
|
</p>
|
|
|
|
<p>Definition at line <a class="el" href="Arg_8h_source.html#l00406">406</a> of file <a class="el"
|
|
href="Arg_8h_source.html">Arg.h</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>
|
|
<h2>Function Documentation</h2>
|
|
<a class="anchor" id="add5aef761d6b2640f418a050b68a500e"></a><!-- doxytag: member="TCLAP::ClearContainer" ref="add5aef761d6b2640f418a050b68a500e" args="(C &c)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename C > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void TCLAP::ClearContainer</td>
|
|
<td>(</td>
|
|
<td class="paramtype">C & </td>
|
|
<td class="paramname"><em>c</em></td>
|
|
<td> ) </td>
|
|
<td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="CmdLine_8h_source.html#l00058">58</a> of file <a class="el"
|
|
href="CmdLine_8h_source.html">CmdLine.h</a>.
|
|
</p>
|
|
|
|
<p>Referenced by <a class="el" href="CmdLine_8h_source.html#l00345">TCLAP::CmdLine::~CmdLine()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5a9391091b2232ce2647aecd42ef82be"></a><!-- doxytag: member="TCLAP::DelPtr" ref="a5a9391091b2232ce2647aecd42ef82be" args="(T ptr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void TCLAP::DelPtr</td>
|
|
<td>(</td>
|
|
<td class="paramtype">T </td>
|
|
<td class="paramname"><em>ptr</em></td>
|
|
<td> ) </td>
|
|
<td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="CmdLine_8h_source.html#l00053">53</a> of file <a class="el"
|
|
href="CmdLine_8h_source.html">CmdLine.h</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adf4c56655c8414e1dd70d56ceda8ce3f"></a><!-- doxytag: member="TCLAP::ExtractValue" ref="adf4c56655c8414e1dd70d56ceda8ce3f" args="(T &destVal, const std::string &strVal, StringLike sl)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void TCLAP::ExtractValue</td>
|
|
<td>(</td>
|
|
<td class="paramtype">T & </td>
|
|
<td class="paramname"><em>destVal</em>,</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>strVal</em>,</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">StringLike </td>
|
|
<td class="paramname"><em>sl</em></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>Definition at line <a class="el" href="Arg_8h_source.html#l00452">452</a> of file <a class="el"
|
|
href="Arg_8h_source.html">Arg.h</a>.
|
|
</p>
|
|
|
|
<p>References <a class="el" href="StandardTraits_8h_source.html#l00200">SetString()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a80473f9a24db31df0206504c2cdf0a8d"></a><!-- doxytag: member="TCLAP::ExtractValue" ref="a80473f9a24db31df0206504c2cdf0a8d" args="(T &destVal, const std::string &strVal, ValueLike vl)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void TCLAP::ExtractValue</td>
|
|
<td>(</td>
|
|
<td class="paramtype">T & </td>
|
|
<td class="paramname"><em>destVal</em>,</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>strVal</em>,</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ValueLike </td>
|
|
<td class="paramname"><em>vl</em></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>Definition at line <a class="el" href="Arg_8h_source.html#l00415">415</a> of file <a class="el"
|
|
href="Arg_8h_source.html">Arg.h</a>.
|
|
</p>
|
|
|
|
<p>Referenced by <a class="el" href="ValueArg_8h_source.html#l00400">TCLAP::ValueArg< T >::_extractValue()</a>,
|
|
and <a class="el" href="MultiArg_8h_source.html#l00398">TCLAP::MultiArg< T >::_extractValue()</a>.
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a06cca5c0de2e5803a67c63cde60a2dfb"></a><!-- doxytag: member="TCLAP::SetString" ref="a06cca5c0de2e5803a67c63cde60a2dfb" args="(T &dst, const std::string &src)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void TCLAP::SetString</td>
|
|
<td>(</td>
|
|
<td class="paramtype">T & </td>
|
|
<td class="paramname"><em>dst</em>,</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>src</em></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>Definition at line <a class="el" href="StandardTraits_8h_source.html#l00200">200</a> of file <a
|
|
class="el" href="StandardTraits_8h_source.html">StandardTraits.h</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="Arg_8h_source.html#l00452">ExtractValue()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</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>
|