blob: 0d7d633caa6d2cb1cfec8ecc06847345f051a286 (
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
171
172
173
174
175
176
|
<!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::Constraint< 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_1Constraint.html">Constraint</a>
</div>
</div>
<div class="contents">
<h1>TCLAP::Constraint< T > Class Template Reference</h1><!-- doxytag: class="TCLAP::Constraint" -->
<p>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="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Constraint_8h_source.html">Constraint.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for TCLAP::Constraint< T >:</div>
<div class="dynsection">
<div class="center">
<img src="classTCLAP_1_1Constraint.gif" usemap="#TCLAP::Constraint< T >_map" alt=""/>
<map id="TCLAP::Constraint< T >_map" name="TCLAP::Constraint< T >_map">
<area href="classTCLAP_1_1ValuesConstraint.html" alt="TCLAP::ValuesConstraint< T >" shape="rect" coords="0,56,185,80"/>
</map>
</div>
</div>
<p><a href="classTCLAP_1_1Constraint-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1Constraint.html#ae16dd80aa217fb56c0862af5478afe01">description</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a description of the <a class="el" href="classTCLAP_1_1Constraint.html" title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a>. <a href="#ae16dd80aa217fb56c0862af5478afe01"></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_1Constraint.html#a39f707895311da682439810a0bec4a5f">shortID</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the short ID for the <a class="el" href="classTCLAP_1_1Constraint.html" title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a>. <a href="#a39f707895311da682439810a0bec4a5f"></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_1Constraint.html#a773c3e16d0150523c1c92b7b24868c34">check</a> (const T &value) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The method used to verify that the value parsed from the command line meets the constraint. <a href="#a773c3e16d0150523c1c92b7b24868c34"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1Constraint.html#ae96bbe5301e9517b68b1597b36098224">~Constraint</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ae96bbe5301e9517b68b1597b36098224"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br/>
class TCLAP::Constraint< T ></h3>
<p>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>. </p>
<p>Definition at line <a class="el" href="Constraint_8h_source.html#l00038">38</a> of file <a class="el" href="Constraint_8h_source.html">Constraint.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae96bbe5301e9517b68b1597b36098224"></a><!-- doxytag: member="TCLAP::Constraint::~Constraint" ref="ae96bbe5301e9517b68b1597b36098224" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTCLAP_1_1Constraint.html">TCLAP::Constraint</a>< T >::~<a class="el" href="classTCLAP_1_1Constraint.html">Constraint</a> </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Silences warnings about <a class="el" href="classTCLAP_1_1Constraint.html" title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a> being a base class with virtual functions but without a virtual destructor. </p>
<p>Definition at line <a class="el" href="Constraint_8h_source.html#l00064">64</a> of file <a class="el" href="Constraint_8h_source.html">Constraint.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a773c3e16d0150523c1c92b7b24868c34"></a><!-- doxytag: member="TCLAP::Constraint::check" ref="a773c3e16d0150523c1c92b7b24868c34" args="(const T &value) const =0" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="classTCLAP_1_1Constraint.html">TCLAP::Constraint</a>< T >::check </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The method used to verify that the value parsed from the command line meets the constraint. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>- The value that will be checked. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classTCLAP_1_1ValuesConstraint.html#ae132b185413cf5dea5cc040f60e7ede6">TCLAP::ValuesConstraint< T ></a>.</p>
</div>
</div>
<a class="anchor" id="ae16dd80aa217fb56c0862af5478afe01"></a><!-- doxytag: member="TCLAP::Constraint::description" ref="ae16dd80aa217fb56c0862af5478afe01" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">virtual std::string <a class="el" href="classTCLAP_1_1Constraint.html">TCLAP::Constraint</a>< T >::description </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a description of the <a class="el" href="classTCLAP_1_1Constraint.html" title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a>. </p>
<p>Implemented in <a class="el" href="classTCLAP_1_1ValuesConstraint.html#a07b08c05a7bfcbe5815895353ffef1d5">TCLAP::ValuesConstraint< T ></a>.</p>
</div>
</div>
<a class="anchor" id="a39f707895311da682439810a0bec4a5f"></a><!-- doxytag: member="TCLAP::Constraint::shortID" ref="a39f707895311da682439810a0bec4a5f" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">virtual std::string <a class="el" href="classTCLAP_1_1Constraint.html">TCLAP::Constraint</a>< T >::shortID </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the short ID for the <a class="el" href="classTCLAP_1_1Constraint.html" title="The interface that defines the interaction between the Arg and Constraint.">Constraint</a>. </p>
<p>Implemented in <a class="el" href="classTCLAP_1_1ValuesConstraint.html#a1bbe12afcb1f185ee7ac808d69e2d345">TCLAP::ValuesConstraint< T ></a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Constraint_8h_source.html">Constraint.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>
|
