summaryrefslogtreecommitdiff
path: root/tclap-1.2.1/docs/html/Arg_8h.html
blob: 4674ec6e00a88e1a1ef25cb912c3ccf2371a1771 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<!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: Arg.h File 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&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Arg.h File Reference</h1><code>#include &lt;string&gt;</code><br/>
<code>#include &lt;vector&gt;</code><br/>
<code>#include &lt;list&gt;</code><br/>
<code>#include &lt;iostream&gt;</code><br/>
<code>#include &lt;iomanip&gt;</code><br/>
<code>#include &lt;cstdio&gt;</code><br/>
<code>#include &lt;sstream&gt;</code><br/>
<code>#include &lt;<a class="el" href="ArgException_8h_source.html">tclap/ArgException.h</a>&gt;</code><br/>
<code>#include &lt;<a class="el" href="Visitor_8h_source.html">tclap/Visitor.h</a>&gt;</code><br/>
<code>#include &lt;<a class="el" href="CmdLineInterface_8h_source.html">tclap/CmdLineInterface.h</a>&gt;</code><br/>
<code>#include &lt;<a class="el" href="ArgTraits_8h_source.html">tclap/ArgTraits.h</a>&gt;</code><br/>
<code>#include &lt;<a class="el" href="StandardTraits_8h_source.html">tclap/StandardTraits.h</a>&gt;</code><br/>

<p><a href="Arg_8h_source.html">Go to the source code of this file.</a></p>
<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 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1Arg.html">TCLAP::Arg</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</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 colspan="2"><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">namespace &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTCLAP.html">TCLAP</a></td></tr>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Arg_8h.html#a91e904e6e4f21f803c49113b934e6966">HAVE_SSTREAM</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Arg_8h.html#a892de6ada8e6a8ed25e303ca564a8447">TCLAP_FLAGSTARTCHAR</a>&nbsp;&nbsp;&nbsp;'-'</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The char that indicates the beginning of a flag.  <a href="#a892de6ada8e6a8ed25e303ca564a8447"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Arg_8h.html#a542fe8477a66451cf2d983fd4c4f1846">TCLAP_FLAGSTARTSTRING</a>&nbsp;&nbsp;&nbsp;&quot;-&quot;</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The sting that indicates the beginning of a flag.  <a href="#a542fe8477a66451cf2d983fd4c4f1846"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Arg_8h.html#ab497be2528843816edec2ec9897dfca2">TCLAP_NAMESTARTSTRING</a>&nbsp;&nbsp;&nbsp;&quot;--&quot;</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The sting that indicates the beginning of a name.  <a href="#ab497be2528843816edec2ec9897dfca2"></a><br/></td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="Arg_8h.html#ab31d9646d48ca9d02918cc36b138e67b">std::istringstream</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Arg_8h.html#ab31d9646d48ca9d02918cc36b138e67b">istringstream</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef std::list&lt; Arg * &gt;<br class="typebreak"/>
::iterator&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTCLAP.html#aa7d6a803e0690c3c8b1db57c145648c5">TCLAP::ArgListIterator</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</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&lt; Arg * &gt;<br class="typebreak"/>
::iterator&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTCLAP.html#a04213af1ffc3178ce5f771d21d5164a2">TCLAP::ArgVectorIterator</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</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&lt; Visitor * &gt;<br class="typebreak"/>
::iterator&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTCLAP.html#a30300bc675a64eacafa1298268de1101">TCLAP::VisitorListIterator</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</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&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceTCLAP.html#a80473f9a24db31df0206504c2cdf0a8d">TCLAP::ExtractValue</a> (T &amp;destVal, const std::string &amp;strVal, ValueLike vl)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceTCLAP.html#adf4c56655c8414e1dd70d56ceda8ce3f">TCLAP::ExtractValue</a> (T &amp;destVal, const std::string &amp;strVal, StringLike sl)</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a91e904e6e4f21f803c49113b934e6966"></a><!-- doxytag: member="Arg.h::HAVE_SSTREAM" ref="a91e904e6e4f21f803c49113b934e6966" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define HAVE_SSTREAM</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="Arg_8h_source.html#l00031">31</a> of file <a class="el" href="Arg_8h_source.html">Arg.h</a>.</p>

</div>
</div>
<a class="anchor" id="a892de6ada8e6a8ed25e303ca564a8447"></a><!-- doxytag: member="Arg.h::TCLAP_FLAGSTARTCHAR" ref="a892de6ada8e6a8ed25e303ca564a8447" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TCLAP_FLAGSTARTCHAR&nbsp;&nbsp;&nbsp;'-'</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The char that indicates the beginning of a flag. </p>
<p>Defaults to '-', but clients can define TCLAP_FLAGSTARTCHAR to override. </p>

<p>Definition at line <a class="el" href="Arg_8h_source.html#l00224">224</a> of file <a class="el" href="Arg_8h_source.html">Arg.h</a>.</p>

<p>Referenced by <a class="el" href="Arg_8h_source.html#l00226">TCLAP::Arg::flagStartChar()</a>.</p>

</div>
</div>
<a class="anchor" id="a542fe8477a66451cf2d983fd4c4f1846"></a><!-- doxytag: member="Arg.h::TCLAP_FLAGSTARTSTRING" ref="a542fe8477a66451cf2d983fd4c4f1846" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TCLAP_FLAGSTARTSTRING&nbsp;&nbsp;&nbsp;&quot;-&quot;</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The sting that indicates the beginning of a flag. </p>
<p>Defaults to "-", but clients can define TCLAP_FLAGSTARTSTRING to override. Should be the same as TCLAP_FLAGSTARTCHAR. </p>

<p>Definition at line <a class="el" href="Arg_8h_source.html#l00234">234</a> of file <a class="el" href="Arg_8h_source.html">Arg.h</a>.</p>

<p>Referenced by <a class="el" href="Arg_8h_source.html#l00236">TCLAP::Arg::flagStartString()</a>.</p>

</div>
</div>
<a class="anchor" id="ab497be2528843816edec2ec9897dfca2"></a><!-- doxytag: member="Arg.h::TCLAP_NAMESTARTSTRING" ref="ab497be2528843816edec2ec9897dfca2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TCLAP_NAMESTARTSTRING&nbsp;&nbsp;&nbsp;&quot;--&quot;</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The sting that indicates the beginning of a name. </p>
<p>Defaults to "--", but clients can define TCLAP_NAMESTARTSTRING to override. </p>

<p>Definition at line <a class="el" href="Arg_8h_source.html#l00243">243</a> of file <a class="el" href="Arg_8h_source.html">Arg.h</a>.</p>

<p>Referenced by <a class="el" href="Arg_8h_source.html#l00245">TCLAP::Arg::nameStartString()</a>.</p>

</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ab31d9646d48ca9d02918cc36b138e67b"></a><!-- doxytag: member="Arg.h::istringstream" ref="ab31d9646d48ca9d02918cc36b138e67b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="Arg_8h.html#ab31d9646d48ca9d02918cc36b138e67b">std::istringstream</a> <a class="el" href="Arg_8h.html#ab31d9646d48ca9d02918cc36b138e67b">istringstream</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="Arg_8h_source.html#l00043">43</a> of file <a class="el" href="Arg_8h_source.html">Arg.h</a>.</p>

</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Sat Apr 16 15:34:24 2011 for tclap by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.0 </small></address>
</body>
</html>