forked from CLIUtils/CLI11
/
class_c_l_i_1_1_bound.html
263 lines (257 loc) · 29.5 KB
/
class_c_l_i_1_1_bound.html
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<!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.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CLI11: CLI::Bound Class Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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">CLI11
</div>
<div id="projectbrief">C++11 Command Line Interface Parser</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<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('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>CLI</b></li><li class="navelem"><a class="el" href="class_c_l_i_1_1_bound.html">Bound</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_c_l_i_1_1_bound-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CLI::Bound Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Produce a bounded range (factory). Min and max are inclusive.
<a href="class_c_l_i_1_1_bound.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_validators_8hpp_source.html">Validators.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for CLI::Bound:</div>
<div class="dyncontent">
<div class="center">
<img src="class_c_l_i_1_1_bound.png" usemap="#CLI::Bound_map" alt=""/>
<map id="CLI::Bound_map" name="CLI::Bound_map">
<area href="class_c_l_i_1_1_validator.html" title="Some validators that are provided." alt="CLI::Validator" shape="rect" coords="0,0,88,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad8963dee44fa7484a9d28df994cf722c"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:ad8963dee44fa7484a9d28df994cf722c"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_bound.html#ad8963dee44fa7484a9d28df994cf722c">Bound</a> (T min, T max)</td></tr>
<tr class="separator:ad8963dee44fa7484a9d28df994cf722c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89980a212ef2a8359d14e69b9b57e651"><td class="memTemplParams" colspan="2"><a id="a89980a212ef2a8359d14e69b9b57e651"></a>
template<typename T > </td></tr>
<tr class="memitem:a89980a212ef2a8359d14e69b9b57e651"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_bound.html#a89980a212ef2a8359d14e69b9b57e651">Bound</a> (T max)</td></tr>
<tr class="memdesc:a89980a212ef2a8359d14e69b9b57e651"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_c_l_i_1_1_range.html" title="Produce a range (factory). Min and max are inclusive.">Range</a> of one value is 0 to value. <br /></td></tr>
<tr class="separator:a89980a212ef2a8359d14e69b9b57e651"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_c_l_i_1_1_validator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_c_l_i_1_1_validator')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_c_l_i_1_1_validator.html">CLI::Validator</a></td></tr>
<tr class="memitem:a71df7c1c94c4abceee930eef957f5b76 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="a71df7c1c94c4abceee930eef957f5b76"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a71df7c1c94c4abceee930eef957f5b76">Validator</a> (std::string validator_desc)</td></tr>
<tr class="memdesc:a71df7c1c94c4abceee930eef957f5b76 inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="class_c_l_i_1_1_validator.html" title="Some validators that are provided.">Validator</a> with just the description string. <br /></td></tr>
<tr class="separator:a71df7c1c94c4abceee930eef957f5b76 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aede1b1a51a7f924342a92cbbd3ee41be inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="aede1b1a51a7f924342a92cbbd3ee41be"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#aede1b1a51a7f924342a92cbbd3ee41be">Validator</a> (std::function< std::string(std::string &)> op, std::string validator_desc, std::string validator_name="")</td></tr>
<tr class="memdesc:aede1b1a51a7f924342a92cbbd3ee41be inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Construct <a class="el" href="class_c_l_i_1_1_validator.html" title="Some validators that are provided.">Validator</a> from basic information. <br /></td></tr>
<tr class="separator:aede1b1a51a7f924342a92cbbd3ee41be inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d2212c754276aab6301823b2e6409d4 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="a4d2212c754276aab6301823b2e6409d4"></a>
<a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a4d2212c754276aab6301823b2e6409d4">operation</a> (std::function< std::string(std::string &)> op)</td></tr>
<tr class="memdesc:a4d2212c754276aab6301823b2e6409d4 inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="class_c_l_i_1_1_validator.html" title="Some validators that are provided.">Validator</a> operation function. <br /></td></tr>
<tr class="separator:a4d2212c754276aab6301823b2e6409d4 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97241be1f8ac1c8d2fabdcf2ec761f49 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a97241be1f8ac1c8d2fabdcf2ec761f49">operator()</a> (std::string &str) const</td></tr>
<tr class="separator:a97241be1f8ac1c8d2fabdcf2ec761f49 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e4e7670d82455a43c0d3f8c9cc1db4f inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a3e4e7670d82455a43c0d3f8c9cc1db4f">operator()</a> (const std::string &str) const</td></tr>
<tr class="separator:a3e4e7670d82455a43c0d3f8c9cc1db4f inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d62f88b256ae1587a5c9841f5a42c68 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="a1d62f88b256ae1587a5c9841f5a42c68"></a>
<a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a1d62f88b256ae1587a5c9841f5a42c68">description</a> (std::string validator_desc)</td></tr>
<tr class="memdesc:a1d62f88b256ae1587a5c9841f5a42c68 inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Specify the type string. <br /></td></tr>
<tr class="separator:a1d62f88b256ae1587a5c9841f5a42c68 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb7942915861f00426ba4106c3fa1445 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="acb7942915861f00426ba4106c3fa1445"></a>
<a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#acb7942915861f00426ba4106c3fa1445">description</a> (std::string validator_desc) const</td></tr>
<tr class="memdesc:acb7942915861f00426ba4106c3fa1445 inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Specify the type string. <br /></td></tr>
<tr class="separator:acb7942915861f00426ba4106c3fa1445 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77c9d0a1f496ccaa4a8ef293a41bca78 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="a77c9d0a1f496ccaa4a8ef293a41bca78"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a77c9d0a1f496ccaa4a8ef293a41bca78">get_description</a> () const</td></tr>
<tr class="memdesc:a77c9d0a1f496ccaa4a8ef293a41bca78 inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Generate type description information for the <a class="el" href="class_c_l_i_1_1_validator.html" title="Some validators that are provided.">Validator</a>. <br /></td></tr>
<tr class="separator:a77c9d0a1f496ccaa4a8ef293a41bca78 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e4116061cd19611de38043a08086852 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="a6e4116061cd19611de38043a08086852"></a>
<a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a6e4116061cd19611de38043a08086852">name</a> (std::string validator_name)</td></tr>
<tr class="memdesc:a6e4116061cd19611de38043a08086852 inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Specify the type string. <br /></td></tr>
<tr class="separator:a6e4116061cd19611de38043a08086852 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56272c0571e4b28e5f1387787bee671c inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="a56272c0571e4b28e5f1387787bee671c"></a>
<a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a56272c0571e4b28e5f1387787bee671c">name</a> (std::string validator_name) const</td></tr>
<tr class="memdesc:a56272c0571e4b28e5f1387787bee671c inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Specify the type string. <br /></td></tr>
<tr class="separator:a56272c0571e4b28e5f1387787bee671c inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba763211f1b7c9e9866da767ba731999 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="aba763211f1b7c9e9866da767ba731999"></a>
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#aba763211f1b7c9e9866da767ba731999">get_name</a> () const</td></tr>
<tr class="memdesc:aba763211f1b7c9e9866da767ba731999 inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the <a class="el" href="class_c_l_i_1_1_validator.html" title="Some validators that are provided.">Validator</a>. <br /></td></tr>
<tr class="separator:aba763211f1b7c9e9866da767ba731999 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5e70c77661016b97a19a801b4ec84f5 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="ad5e70c77661016b97a19a801b4ec84f5"></a>
<a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#ad5e70c77661016b97a19a801b4ec84f5">active</a> (bool active_val=true)</td></tr>
<tr class="memdesc:ad5e70c77661016b97a19a801b4ec84f5 inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Specify whether the <a class="el" href="class_c_l_i_1_1_validator.html" title="Some validators that are provided.">Validator</a> is active or not. <br /></td></tr>
<tr class="separator:ad5e70c77661016b97a19a801b4ec84f5 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a98fa76ba029599613e3ab8609e25af4d inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="a98fa76ba029599613e3ab8609e25af4d"></a>
<a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a98fa76ba029599613e3ab8609e25af4d">active</a> (bool active_val=true) const</td></tr>
<tr class="memdesc:a98fa76ba029599613e3ab8609e25af4d inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Specify whether the <a class="el" href="class_c_l_i_1_1_validator.html" title="Some validators that are provided.">Validator</a> is active or not. <br /></td></tr>
<tr class="separator:a98fa76ba029599613e3ab8609e25af4d inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af3cde5a9bffc4943d4388480d439c1d5 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="af3cde5a9bffc4943d4388480d439c1d5"></a>
<a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#af3cde5a9bffc4943d4388480d439c1d5">non_modifying</a> (bool no_modify=true)</td></tr>
<tr class="memdesc:af3cde5a9bffc4943d4388480d439c1d5 inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Specify whether the <a class="el" href="class_c_l_i_1_1_validator.html" title="Some validators that are provided.">Validator</a> can be modifying or not. <br /></td></tr>
<tr class="separator:af3cde5a9bffc4943d4388480d439c1d5 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af34fc894bf48a2b242bbc9f1e49cab75 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="af34fc894bf48a2b242bbc9f1e49cab75"></a>
<a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#af34fc894bf48a2b242bbc9f1e49cab75">application_index</a> (int app_index)</td></tr>
<tr class="memdesc:af34fc894bf48a2b242bbc9f1e49cab75 inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Specify the application index of a validator. <br /></td></tr>
<tr class="separator:af34fc894bf48a2b242bbc9f1e49cab75 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f621b1380d9a1a3694bc509a087d1cd inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="a5f621b1380d9a1a3694bc509a087d1cd"></a>
<a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a5f621b1380d9a1a3694bc509a087d1cd">application_index</a> (int app_index) const</td></tr>
<tr class="memdesc:a5f621b1380d9a1a3694bc509a087d1cd inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Specify the application index of a validator. <br /></td></tr>
<tr class="separator:a5f621b1380d9a1a3694bc509a087d1cd inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa27699959ccccc236af305582d2b3e90 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="aa27699959ccccc236af305582d2b3e90"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#aa27699959ccccc236af305582d2b3e90">get_application_index</a> () const</td></tr>
<tr class="memdesc:aa27699959ccccc236af305582d2b3e90 inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Get the current value of the application index. <br /></td></tr>
<tr class="separator:aa27699959ccccc236af305582d2b3e90 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c08bcd3bca8c446e49e44d2c4e1413f inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="a1c08bcd3bca8c446e49e44d2c4e1413f"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a1c08bcd3bca8c446e49e44d2c4e1413f">get_active</a> () const</td></tr>
<tr class="memdesc:a1c08bcd3bca8c446e49e44d2c4e1413f inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Get a boolean if the validator is active. <br /></td></tr>
<tr class="separator:a1c08bcd3bca8c446e49e44d2c4e1413f inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:addb6df41feafbbbe6347a46151d55762 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="addb6df41feafbbbe6347a46151d55762"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#addb6df41feafbbbe6347a46151d55762">get_modifying</a> () const</td></tr>
<tr class="memdesc:addb6df41feafbbbe6347a46151d55762 inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Get a boolean if the validator is allowed to modify the input returns true if it can modify the input. <br /></td></tr>
<tr class="separator:addb6df41feafbbbe6347a46151d55762 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5f66f889d8e006edbad1a58a7e608a3 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#ae5f66f889d8e006edbad1a58a7e608a3">operator &</a> (const <a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> &other) const</td></tr>
<tr class="separator:ae5f66f889d8e006edbad1a58a7e608a3 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac19919604a6ac47c5a1cbd34920991a4 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#ac19919604a6ac47c5a1cbd34920991a4">operator|</a> (const <a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> &other) const</td></tr>
<tr class="separator:ac19919604a6ac47c5a1cbd34920991a4 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab113af781dbc286b22cdfeedd5204e68 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="ab113af781dbc286b22cdfeedd5204e68"></a>
<a class="el" href="class_c_l_i_1_1_validator.html">Validator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#ab113af781dbc286b22cdfeedd5204e68">operator!</a> () const</td></tr>
<tr class="memdesc:ab113af781dbc286b22cdfeedd5204e68 inherit pub_methods_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Create a validator that fails when a given validator succeeds. <br /></td></tr>
<tr class="separator:ab113af781dbc286b22cdfeedd5204e68 inherit pub_methods_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_class_c_l_i_1_1_validator"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_c_l_i_1_1_validator')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_c_l_i_1_1_validator.html">CLI::Validator</a></td></tr>
<tr class="memitem:a9f00a86d01b79facfc300be76b7463d7 inherit pro_attribs_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="a9f00a86d01b79facfc300be76b7463d7"></a>
std::function< std::string()> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a9f00a86d01b79facfc300be76b7463d7">desc_function_</a> {[]() { return std::string{}; }}</td></tr>
<tr class="memdesc:a9f00a86d01b79facfc300be76b7463d7 inherit pro_attribs_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">This is the description function, if empty the description_ will be used. <br /></td></tr>
<tr class="separator:a9f00a86d01b79facfc300be76b7463d7 inherit pro_attribs_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6c1eedd7839b91d88246539f2305ef3 inherit pro_attribs_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top">std::function< std::string(std::string &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#aa6c1eedd7839b91d88246539f2305ef3">func_</a> {[](std::string &) { return std::string{}; }}</td></tr>
<tr class="separator:aa6c1eedd7839b91d88246539f2305ef3 inherit pro_attribs_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac97b23ee16e15ae0b31253feb39706bf inherit pro_attribs_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="ac97b23ee16e15ae0b31253feb39706bf"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#ac97b23ee16e15ae0b31253feb39706bf">name_</a> {}</td></tr>
<tr class="memdesc:ac97b23ee16e15ae0b31253feb39706bf inherit pro_attribs_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">The name for search purposes of the <a class="el" href="class_c_l_i_1_1_validator.html" title="Some validators that are provided.">Validator</a>. <br /></td></tr>
<tr class="separator:ac97b23ee16e15ae0b31253feb39706bf inherit pro_attribs_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a301ecf2851e4a7cdcad7c9b774598320 inherit pro_attribs_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="a301ecf2851e4a7cdcad7c9b774598320"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a301ecf2851e4a7cdcad7c9b774598320">application_index_</a> = -1</td></tr>
<tr class="memdesc:a301ecf2851e4a7cdcad7c9b774598320 inherit pro_attribs_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="class_c_l_i_1_1_validator.html" title="Some validators that are provided.">Validator</a> will only apply to an indexed value (-1 is all elements) <br /></td></tr>
<tr class="separator:a301ecf2851e4a7cdcad7c9b774598320 inherit pro_attribs_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a558776377513d88bf637b5d775c4e31b inherit pro_attribs_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="a558776377513d88bf637b5d775c4e31b"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a558776377513d88bf637b5d775c4e31b">active_</a> {true}</td></tr>
<tr class="memdesc:a558776377513d88bf637b5d775c4e31b inherit pro_attribs_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">Enable for <a class="el" href="class_c_l_i_1_1_validator.html" title="Some validators that are provided.">Validator</a> to allow it to be disabled if need be. <br /></td></tr>
<tr class="separator:a558776377513d88bf637b5d775c4e31b inherit pro_attribs_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60df532d1d80afc040ec0e8ed2736200 inherit pro_attribs_class_c_l_i_1_1_validator"><td class="memItemLeft" align="right" valign="top"><a id="a60df532d1d80afc040ec0e8ed2736200"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_i_1_1_validator.html#a60df532d1d80afc040ec0e8ed2736200">non_modifying_</a> {false}</td></tr>
<tr class="memdesc:a60df532d1d80afc040ec0e8ed2736200 inherit pro_attribs_class_c_l_i_1_1_validator"><td class="mdescLeft"> </td><td class="mdescRight">specify that a validator should not modify the input <br /></td></tr>
<tr class="separator:a60df532d1d80afc040ec0e8ed2736200 inherit pro_attribs_class_c_l_i_1_1_validator"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Produce a bounded range (factory). Min and max are inclusive. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ad8963dee44fa7484a9d28df994cf722c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8963dee44fa7484a9d28df994cf722c">◆ </a></span>Bound()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CLI::Bound::Bound </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T </td>
<td class="paramname"><em>max</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This bounds a value with min and max inclusive.</p>
<p>Note that the constructor is templated, but the struct is not, so C++17 is not needed to provide nice syntax for Range(a,b). </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/CLI/<a class="el" href="_validators_8hpp_source.html">Validators.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>