154 lines
20 KiB
HTML
154 lines
20 KiB
HTML
<!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.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Leonetienne/Hazelnupp: Hazelnupp/ParamConstraint.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="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>
|
|
<script type="text/x-mathjax-config">
|
|
MathJax.Hub.Config({
|
|
extensions: ["tex2jax.js"],
|
|
jax: ["input/TeX","output/HTML-CSS"],
|
|
});
|
|
</script>
|
|
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.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="projectlogo"><img alt="Logo" src="nupp_small.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Leonetienne/Hazelnupp
|
|
</div>
|
|
<div id="projectbrief">Simple, easy to use, command line parameter interface</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<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"><a class="el" href="dir_0202e1e26df2e040f4dc3d434eecf04c.html">Hazelnupp</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">ParamConstraint.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="ParamConstraint_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="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#include "<a class="code" href="DataType_8h.html">DataType.h</a>"</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"><a class="line" href="structParamConstraint.html"> 6</a></span> <span class="keyword">struct </span><a class="code" href="structParamConstraint.html">ParamConstraint</a></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> {</div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  <a class="code" href="structParamConstraint.html#ae0ce64f2f0928d602b6f6117ff34d155">ParamConstraint</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structParamConstraint.html#a40e47d3ad68cadbe785551c4aaad828c"> 14</a></span>  <span class="keyword">static</span> <a class="code" href="structParamConstraint.html">ParamConstraint</a> <a class="code" href="structParamConstraint.html#a40e47d3ad68cadbe785551c4aaad828c">Require</a>(<span class="keyword">const</span> std::string& <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a>, <span class="keyword">const</span> std::vector<std::string>& <a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a> = {}, <span class="keywordtype">bool</span> <a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a> = <span class="keyword">true</span>)</div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  {</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <a class="code" href="structParamConstraint.html">ParamConstraint</a> pc;</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  pc.<a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a> = <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a>;</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  pc.<a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a> = <a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a>;</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  pc.<a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a> = <a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a>;</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordflow">return</span> pc;</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  }</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structParamConstraint.html#a3ecbccdce5be2529712e0866725c7cd5"> 25</a></span>  <span class="keyword">static</span> <a class="code" href="structParamConstraint.html">ParamConstraint</a> <a class="code" href="structParamConstraint.html#a3ecbccdce5be2529712e0866725c7cd5">TypeSafety</a>(<span class="keyword">const</span> std::string& <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a>, <a class="code" href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27b">DATA_TYPE</a> <a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a>, <span class="keywordtype">bool</span> <a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a> = <span class="keyword">true</span>)</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  {</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="structParamConstraint.html">ParamConstraint</a> pc;</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  pc.<a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a> = <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a>;</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  pc.<a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a> = <a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a>;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  pc.<a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a> = <a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a>;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">return</span> pc;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  }</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structParamConstraint.html#a93783114c6f374b77479a283c4aadf05"> 36</a></span>  <a class="code" href="structParamConstraint.html#a93783114c6f374b77479a283c4aadf05">ParamConstraint</a>(<span class="keyword">const</span> std::string& <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a>, <span class="keywordtype">bool</span> <a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a>, <a class="code" href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27b">DATA_TYPE</a> <a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a>, <span class="keyword">const</span> std::vector<std::string>& <a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a>, <span class="keywordtype">bool</span> <a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a>)</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  :</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a> { <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a> },</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a> { <a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a> },</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a> { <a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a> },</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a> { <a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a> },</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a>{ <a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</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>  <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648"> 48</a></span>  std::string <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a>;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2"> 52</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a"> 55</a></span>  <a class="code" href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27b">DATA_TYPE</a> <a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a> = <a class="code" href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a>;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff"> 60</a></span>  std::vector<std::string> <a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a>;</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d"> 64</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> };</div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aDataType_8h_html"><div class="ttname"><a href="DataType_8h.html">DataType.h</a></div></div>
|
|
<div class="ttc" id="aDataType_8h_html_aa082c000e4eff6ed512714ea0a33d27b"><div class="ttname"><a href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27b">DATA_TYPE</a></div><div class="ttdeci">DATA_TYPE</div><div class="ttdoc">The different data types a paramater can be.</div><div class="ttdef"><b>Definition:</b> <a href="DataType_8h_source.html#l00005">DataType.h:5</a></div></div>
|
|
<div class="ttc" id="aDataType_8h_html_aa082c000e4eff6ed512714ea0a33d27ba6d0c9fc747131795e6e5d0c5119f12cb"><div class="ttname"><a href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a></div><div class="ttdeci">@ VOID</div></div>
|
|
<div class="ttc" id="astructParamConstraint_html_a5c451d5ade6c548af7de0a978964a09d"><div class="ttname"><a href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">ParamConstraint::required</a></div><div class="ttdeci">bool required</div><div class="ttdoc">If set to true, and no default value set, an error will be produced if this parameter is not supplied...</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00064">ParamConstraint.h:64</a></div></div>
|
|
<div class="ttc" id="astructParamConstraint_html_a93783114c6f374b77479a283c4aadf05"><div class="ttname"><a href="structParamConstraint.html#a93783114c6f374b77479a283c4aadf05">ParamConstraint::ParamConstraint</a></div><div class="ttdeci">ParamConstraint(const std::string &key, bool constrainType, DATA_TYPE wantedType, const std::vector< std::string > &defaultValue, bool required)</div><div class="ttdoc">Whole constructor.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00036">ParamConstraint.h:36</a></div></div>
|
|
<div class="ttc" id="astructParamConstraint_html_a3ecbccdce5be2529712e0866725c7cd5"><div class="ttname"><a href="structParamConstraint.html#a3ecbccdce5be2529712e0866725c7cd5">ParamConstraint::TypeSafety</a></div><div class="ttdeci">static ParamConstraint TypeSafety(const std::string &key, DATA_TYPE wantedType, bool constrainType=true)</div><div class="ttdoc">Constructs a type-safety constraint.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00025">ParamConstraint.h:25</a></div></div>
|
|
<div class="ttc" id="astructParamConstraint_html_af2832fa007abaabc05784d5f978aeeff"><div class="ttname"><a href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">ParamConstraint::defaultValue</a></div><div class="ttdeci">std::vector< std::string > defaultValue</div><div class="ttdoc">The default value for this parameter.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00060">ParamConstraint.h:60</a></div></div>
|
|
<div class="ttc" id="astructParamConstraint_html_a40e47d3ad68cadbe785551c4aaad828c"><div class="ttname"><a href="structParamConstraint.html#a40e47d3ad68cadbe785551c4aaad828c">ParamConstraint::Require</a></div><div class="ttdeci">static ParamConstraint Require(const std::string &key, const std::vector< std::string > &defaultValue={}, bool required=true)</div><div class="ttdoc">Constructs a require constraint.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00014">ParamConstraint.h:14</a></div></div>
|
|
<div class="ttc" id="astructParamConstraint_html_aa3bd052bbaebdc795f0922731c666648"><div class="ttname"><a href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">ParamConstraint::key</a></div><div class="ttdeci">std::string key</div><div class="ttdoc">The key of the parameter to constrain.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00048">ParamConstraint.h:48</a></div></div>
|
|
<div class="ttc" id="astructParamConstraint_html_ab35444d2957439bc52c2056a829145a2"><div class="ttname"><a href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">ParamConstraint::constrainType</a></div><div class="ttdeci">bool constrainType</div><div class="ttdoc">Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00052">ParamConstraint.h:52</a></div></div>
|
|
<div class="ttc" id="astructParamConstraint_html_ae0ce64f2f0928d602b6f6117ff34d155"><div class="ttname"><a href="structParamConstraint.html#ae0ce64f2f0928d602b6f6117ff34d155">ParamConstraint::ParamConstraint</a></div><div class="ttdeci">ParamConstraint()=default</div><div class="ttdoc">Empty constructor.</div></div>
|
|
<div class="ttc" id="astructParamConstraint_html_ae8875e054a074241f0c0bf3328a0915a"><div class="ttname"><a href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">ParamConstraint::wantedType</a></div><div class="ttdeci">DATA_TYPE wantedType</div><div class="ttdoc">Constrain the parameter to this value. Requires constrainType to be set to true.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00055">ParamConstraint.h:55</a></div></div>
|
|
<div class="ttc" id="astructParamConstraint_html"><div class="ttname"><a href="structParamConstraint.html">ParamConstraint</a></div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00006">ParamConstraint.h:6</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Thu Jun 3 2021 12:21:21 for Leonetienne/Hazelnupp by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|