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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tclap: Constraint.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">tclap
 <span id="projectnumber">1.2.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_fa089243daa3a76cbe67852bbc5b9b99.html">tclap</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Constraint.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="Constraint_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// -*- Mode: c++; c-basic-offset: 4; tab-width: 4; -*-</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>  </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/******************************************************************************</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * file: Constraint.h</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * Copyright (c) 2005, Michael E. Smoot</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Copyright (c) 2017, Google LLC</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * See the file COPYING in the top directory of this distribution for</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * more information.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * THE SOFTWARE IS PROVIDED _AS IS_, WITHOUT WARRANTY OF ANY KIND, EXPRESS</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> *****************************************************************************/</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef TCLAP_CONSTRAINT_H</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define TCLAP_CONSTRAINT_H</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <list></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <iostream></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <iomanip></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <algorithm></span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <stdexcept></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span><a class="code" href="namespaceTCLAP.html">TCLAP</a> {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">template</span><<span class="keyword">class</span> T></div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classTCLAP_1_1Constraint.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="classTCLAP_1_1Constraint.html">Constraint</a></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classTCLAP_1_1Constraint.html#ae16dd80aa217fb56c0862af5478afe01"> 49</a></span>  <span class="keyword">virtual</span> std::string <a class="code" href="classTCLAP_1_1Constraint.html#ae16dd80aa217fb56c0862af5478afe01">description</a>() <span class="keyword">const</span> =0;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classTCLAP_1_1Constraint.html#a39f707895311da682439810a0bec4a5f"> 54</a></span>  <span class="keyword">virtual</span> std::string <a class="code" href="classTCLAP_1_1Constraint.html#a39f707895311da682439810a0bec4a5f">shortID</a>() <span class="keyword">const</span> =0;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classTCLAP_1_1Constraint.html#a773c3e16d0150523c1c92b7b24868c34"> 61</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classTCLAP_1_1Constraint.html#a773c3e16d0150523c1c92b7b24868c34">check</a>(<span class="keyword">const</span> T& value) <span class="keyword">const</span> =0;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classTCLAP_1_1Constraint.html#ae96bbe5301e9517b68b1597b36098224"> 68</a></span>  <span class="keyword">virtual</span> <a class="code" href="classTCLAP_1_1Constraint.html#ae96bbe5301e9517b68b1597b36098224">~Constraint</a>() { ; }</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classTCLAP_1_1Constraint.html#a9614770a97eeb5de3c62231ae2b45346"> 70</a></span>  <span class="keyword">static</span> std::string <a class="code" href="classTCLAP_1_1Constraint.html#a9614770a97eeb5de3c62231ae2b45346">shortID</a>(<a class="code" href="classTCLAP_1_1Constraint.html">Constraint<T></a> *constraint) {</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">if</span> (!constraint)</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"Cannot create a ValueArg with a NULL constraint"</span>);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">return</span> constraint-><a class="code" href="classTCLAP_1_1Constraint.html#a39f707895311da682439810a0bec4a5f">shortID</a>();</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> };</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> } <span class="comment">//namespace TCLAP</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassTCLAP_1_1Constraint_html"><div class="ttname"><a href="classTCLAP_1_1Constraint.html">TCLAP::Constraint</a></div><div class="ttdoc">The interface that defines the interaction between the Arg and Constraint.</div><div class="ttdef"><b>Definition:</b> <a href="Constraint_8h_source.html#l00042">Constraint.h:43</a></div></div>
<div class="ttc" id="aclassTCLAP_1_1Constraint_html_a39f707895311da682439810a0bec4a5f"><div class="ttname"><a href="classTCLAP_1_1Constraint.html#a39f707895311da682439810a0bec4a5f">TCLAP::Constraint::shortID</a></div><div class="ttdeci">virtual std::string shortID() const =0</div><div class="ttdoc">Returns the short ID for the Constraint.</div></div>
<div class="ttc" id="aclassTCLAP_1_1Constraint_html_a773c3e16d0150523c1c92b7b24868c34"><div class="ttname"><a href="classTCLAP_1_1Constraint.html#a773c3e16d0150523c1c92b7b24868c34">TCLAP::Constraint::check</a></div><div class="ttdeci">virtual bool check(const T &value) const =0</div><div class="ttdoc">The method used to verify that the value parsed from the command line meets the constraint.</div></div>
<div class="ttc" id="aclassTCLAP_1_1Constraint_html_a9614770a97eeb5de3c62231ae2b45346"><div class="ttname"><a href="classTCLAP_1_1Constraint.html#a9614770a97eeb5de3c62231ae2b45346">TCLAP::Constraint::shortID</a></div><div class="ttdeci">static std::string shortID(Constraint< T > *constraint)</div><div class="ttdef"><b>Definition:</b> <a href="Constraint_8h_source.html#l00070">Constraint.h:70</a></div></div>
<div class="ttc" id="aclassTCLAP_1_1Constraint_html_ae16dd80aa217fb56c0862af5478afe01"><div class="ttname"><a href="classTCLAP_1_1Constraint.html#ae16dd80aa217fb56c0862af5478afe01">TCLAP::Constraint::description</a></div><div class="ttdeci">virtual std::string description() const =0</div><div class="ttdoc">Returns a description of the Constraint.</div></div>
<div class="ttc" id="aclassTCLAP_1_1Constraint_html_ae96bbe5301e9517b68b1597b36098224"><div class="ttname"><a href="classTCLAP_1_1Constraint.html#ae96bbe5301e9517b68b1597b36098224">TCLAP::Constraint::~Constraint</a></div><div class="ttdeci">virtual ~Constraint()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> <a href="Constraint_8h_source.html#l00068">Constraint.h:68</a></div></div>
<div class="ttc" id="anamespaceTCLAP_html"><div class="ttname"><a href="namespaceTCLAP.html">TCLAP</a></div><div class="ttdef"><b>Definition:</b> <a href="Arg_8h_source.html#l00048">Arg.h:48</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
