248 lines
42 KiB
HTML
248 lines
42 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"> 6</span> <span class="keyword">namespace </span><a class="code" href="namespaceHazelnp.html">Hazelnp</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"><a class="line" href="structHazelnp_1_1ParamConstraint.html"> 8</a></span>  <span class="keyword">struct </span><a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  {</div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  <span class="keyword">public</span>:<span class="comment"></span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> //! Empty constructor</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> //! Constructs a require constraint. </span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> //! Think of the default value like of a list ofparameters. Like {"--width", "800"}</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a8a7e5d7ddffc3cfbb54ac6823dd7eded"> 16</a></span> <span class="comment"></span> <span class="keyword">static</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8a7e5d7ddffc3cfbb54ac6823dd7eded">Require</a>(<span class="keyword">const</span> std::initializer_list<std::string>& <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a> = {}, <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> = <span class="keyword">true</span>)</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  {</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> pc;</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>;</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>;</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordflow">return</span> pc;</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  }</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> //! Daisychain-method. Will add a the "required-argument" aspect. </span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> //! Think of the default value like of a list ofparameters. Like {"--width", "800"}</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#ac23b54cad8636b3f64a27b51161b8749"> 27</a></span> <span class="comment"></span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac23b54cad8636b3f64a27b51161b8749">AddRequire</a>(<span class="keyword">const</span> std::initializer_list<std::string>& <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a> = {}, <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> = <span class="keyword">true</span>)</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  {</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> pc = *<span class="keyword">this</span>;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">return</span> pc;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  }</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> //! Constructs a type-safety constraint</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a7df61dbc8dbaff4bc596fdf2c0532d5b"> 37</a></span> <span class="comment"></span> <span class="keyword">static</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a7df61dbc8dbaff4bc596fdf2c0532d5b">TypeSafety</a>(<a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>, <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> = <span class="keyword">true</span>)</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  {</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> pc;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>;</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">return</span> pc;</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="comment"></span> </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> //! Daisychain-method. Will add a the "type-safety" aspect. </span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> //! Constructs a type-safety constraint</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#ae057d0d8186c0a7936405096a58be981"> 48</a></span> <span class="comment"></span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ae057d0d8186c0a7936405096a58be981">AddTypeSafety</a>(<a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>, <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> = <span class="keyword">true</span>)</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  {</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> pc = *<span class="keyword">this</span>;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> pc;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> //! Constructs an incompatibility constraint. </span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> //! This means, that the following parameters are NOT compatible with this one and will throw an error if passed together</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a20fa41460106b5327a51114f8a187871"> 59</a></span> <span class="comment"></span> <span class="keyword">static</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a20fa41460106b5327a51114f8a187871">Incompatibility</a>(<span class="keyword">const</span> std::initializer_list<std::string>& <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  {</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> pc;</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>;</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> pc;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> //! Constructs an incompatibility constraint. </span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> //! This means, that the following parameters are NOT compatible with this one and will throw an error if passed together.</span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> //! Syntactical-sugar proxy method that will convert the lonely string to an initializer list for you :3</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a6bb383f8945fb99cbd2370fd9a4bc6fc"> 70</a></span> <span class="comment"></span> <span class="keyword">static</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a6bb383f8945fb99cbd2370fd9a4bc6fc">Incompatibility</a>(<span class="keyword">const</span> std::string& <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> pc;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a> = { <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</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>  <span class="keywordflow">return</span> pc;</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"></span> </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> //! Daisychain-method. Will add a the "incompatiblity" aspect. </span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> //! This means, that the following parameters are NOT compatible with this one and will throw an error if passed together.</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> //! Syntactical-sugar proxy method that will convert the lonely string to an initializer list for you :3</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#ae335d099a2735b77239ad7eec5136991"> 81</a></span> <span class="comment"></span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ae335d099a2735b77239ad7eec5136991">AddIncompatibilities</a>(<span class="keyword">const</span> std::string& <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  {</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> pc = *<span class="keyword">this</span>;</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a> = { <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a> };</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> pc;</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> //! Daisychain-method. Will add a the "incompatiblity" aspect. </span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> //! This means, that the following parameters are NOT compatible with this one and will throw an error if passed together.</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a207eead7df641c7741082687db654e55"> 91</a></span> <span class="comment"></span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a207eead7df641c7741082687db654e55">AddIncompatibilities</a>(<span class="keyword">const</span> std::initializer_list<std::string>& <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  {</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> pc = *<span class="keyword">this</span>;</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>;</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">return</span> pc;</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  }</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> //! Whole constructor</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#aea39497a14939fa887c236ee1e755cb3"> 100</a></span> <span class="comment"></span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#aea39497a14939fa887c236ee1e755cb3">ParamConstraint</a>(<span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>, <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>, <span class="keyword">const</span> std::initializer_list<std::string>& <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>, <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>, <span class="keyword">const</span> std::initializer_list<std::string>& <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  :</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> },</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a> },</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a> },</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> },</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>{<a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>}</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  {</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  }</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> //! Should this parameter be forced to be of a certain type? </span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> //! Remember to set `constrainTo` to the wanted type</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac"> 113</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> //! Constrain the parameter to this value. Requires `constrainType` to be set to true.</span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a"> 116</a></span> <span class="comment"></span> <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a> = <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a>;</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> //! The default value for this parameter. </span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> //! Gets applied if this parameter was not given. </span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> //! Think of this like a list of parameters. Like {"--width", "800"}</span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7"> 121</a></span> <span class="comment"></span> std::vector<std::string> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>;</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> //! If set to true, and no default value set,</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> //! an error will be produced if this parameter is not supplied by the user.</span></div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c"> 125</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> //! Parameters that are incompatible with this parameter</span></div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c"> 128</a></span> <span class="comment"></span> std::vector<std::string> <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>;</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  </div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keyword">private</span>:<span class="comment"></span></div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> //! The parameter this constraint is for.</span></div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> //! This value is automatically set by Hazelnupp.</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"></span> std::string key;</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  </div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a01773a2aa9845fd639f63468586b67b0"> 135</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classHazelnp_1_1CmdArgsInterface.html">CmdArgsInterface</a>;</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  };</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> }</div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="anamespaceHazelnp_html"><div class="ttname"><a href="namespaceHazelnp.html">Hazelnp</a></div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8h_source.html#l00009">CmdArgsInterface.h:9</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a8a7e5d7ddffc3cfbb54ac6823dd7eded"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a8a7e5d7ddffc3cfbb54ac6823dd7eded">Hazelnp::ParamConstraint::Require</a></div><div class="ttdeci">static ParamConstraint Require(const std::initializer_list< 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#l00016">ParamConstraint.h:16</a></div></div>
|
|
<div class="ttc" id="aDataType_8h_html"><div class="ttname"><a href="DataType_8h.html">DataType.h</a></div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html">Hazelnp::CmdArgsInterface</a></div><div class="ttdoc">The main class to interface with.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8h_source.html#l00013">CmdArgsInterface.h:13</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a6bb383f8945fb99cbd2370fd9a4bc6fc"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a6bb383f8945fb99cbd2370fd9a4bc6fc">Hazelnp::ParamConstraint::Incompatibility</a></div><div class="ttdeci">static ParamConstraint Incompatibility(const std::string &incompatibleParameters)</div><div class="ttdoc">Constructs an incompatibility constraint.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00070">ParamConstraint.h:70</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a20fa41460106b5327a51114f8a187871"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a20fa41460106b5327a51114f8a187871">Hazelnp::ParamConstraint::Incompatibility</a></div><div class="ttdeci">static ParamConstraint Incompatibility(const std::initializer_list< std::string > &incompatibleParameters)</div><div class="ttdoc">Constructs an incompatibility constraint.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00059">ParamConstraint.h:59</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_aea39497a14939fa887c236ee1e755cb3"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#aea39497a14939fa887c236ee1e755cb3">Hazelnp::ParamConstraint::ParamConstraint</a></div><div class="ttdeci">ParamConstraint(bool constrainType, DATA_TYPE requiredType, const std::initializer_list< std::string > &defaultValue, bool required, const std::initializer_list< std::string > &incompatibleParameters)</div><div class="ttdoc">Whole constructor.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00100">ParamConstraint.h:100</a></div></div>
|
|
<div class="ttc" id="anamespaceHazelnp_html_a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb"><div class="ttname"><a href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb">Hazelnp::DATA_TYPE::VOID</a></div><div class="ttdeci">@ VOID</div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a203b6fd1b9788a529aa0f15fe94fd24a"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">Hazelnp::ParamConstraint::requiredType</a></div><div class="ttdeci">DATA_TYPE requiredType</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#l00116">ParamConstraint.h:116</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_ae335d099a2735b77239ad7eec5136991"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#ae335d099a2735b77239ad7eec5136991">Hazelnp::ParamConstraint::AddIncompatibilities</a></div><div class="ttdeci">ParamConstraint AddIncompatibilities(const std::string &incompatibleParameters)</div><div class="ttdoc">Daisychain-method.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00081">ParamConstraint.h:81</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html">Hazelnp::ParamConstraint</a></div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00008">ParamConstraint.h:8</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a88a4a4c215723259c71853992d09acac"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">Hazelnp::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#l00113">ParamConstraint.h:113</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_ac23b54cad8636b3f64a27b51161b8749"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#ac23b54cad8636b3f64a27b51161b8749">Hazelnp::ParamConstraint::AddRequire</a></div><div class="ttdeci">ParamConstraint AddRequire(const std::initializer_list< std::string > &defaultValue={}, bool required=true)</div><div class="ttdoc">Daisychain-method.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00027">ParamConstraint.h:27</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_afa9e1b4378c9fa1b4a7b5b792c062cbe"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">Hazelnp::ParamConstraint::ParamConstraint</a></div><div class="ttdeci">ParamConstraint()=default</div><div class="ttdoc">Empty constructor.</div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_acf45734665238b51483f77701039108c"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">Hazelnp::ParamConstraint::incompatibleParameters</a></div><div class="ttdeci">std::vector< std::string > incompatibleParameters</div><div class="ttdoc">Parameters that are incompatible with this parameter.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00128">ParamConstraint.h:128</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a207eead7df641c7741082687db654e55"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a207eead7df641c7741082687db654e55">Hazelnp::ParamConstraint::AddIncompatibilities</a></div><div class="ttdeci">ParamConstraint AddIncompatibilities(const std::initializer_list< std::string > &incompatibleParameters)</div><div class="ttdoc">Daisychain-method.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00091">ParamConstraint.h:91</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a8ccf3ebecc2d9d0105e181814af2943c"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">Hazelnp::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#l00125">ParamConstraint.h:125</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a7df61dbc8dbaff4bc596fdf2c0532d5b"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a7df61dbc8dbaff4bc596fdf2c0532d5b">Hazelnp::ParamConstraint::TypeSafety</a></div><div class="ttdeci">static ParamConstraint TypeSafety(DATA_TYPE requiredType, 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#l00037">ParamConstraint.h:37</a></div></div>
|
|
<div class="ttc" id="anamespaceHazelnp_html_a07b61ac22ce9cd97eceebdf9487f803f"><div class="ttname"><a href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">Hazelnp::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#l00008">DataType.h:8</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a1d3a627b3a23fe0db3a368e51dbcd5a7"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">Hazelnp::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#l00121">ParamConstraint.h:121</a></div></div>
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_ae057d0d8186c0a7936405096a58be981"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#ae057d0d8186c0a7936405096a58be981">Hazelnp::ParamConstraint::AddTypeSafety</a></div><div class="ttdeci">ParamConstraint AddTypeSafety(DATA_TYPE requiredType, bool constrainType=true)</div><div class="ttdoc">Daisychain-method.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00048">ParamConstraint.h:48</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sun Sep 5 2021 13:00:16 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>
|