leonetienne/Hazelnupp
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Compiled doxygen

Browse Source
This commit is contained in:
Leonetienne
2021-09-05 12:57:10 +02:00
parent 069d544e02
commit e3fe859b9e
178 changed files with 727 additions and 520 deletions
Download Patch File Download Diff File Expand all files Collapse all files

234
docs/structHazelnp_1_1ParamConstraint.html
View File

@@ -103,6 +103,15 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:afa9e1b4378c9fa1b4a7b5b792c062cbe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> ()=default</td></tr>
<tr class="memdesc:afa9e1b4378c9fa1b4a7b5b792c062cbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Empty constructor. <a href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">More...</a><br /></td></tr>
<tr class="separator:afa9e1b4378c9fa1b4a7b5b792c062cbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac23b54cad8636b3f64a27b51161b8749"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#ac23b54cad8636b3f64a27b51161b8749">AddRequire</a> (const std::initializer_list&lt; std::string &gt; &amp;<a class="el" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>={}, bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>=true)</td></tr>
<tr class="memdesc:ac23b54cad8636b3f64a27b51161b8749"><td class="mdescLeft">&#160;</td><td class="mdescRight">Daisychain-method. <a href="structHazelnp_1_1ParamConstraint.html#ac23b54cad8636b3f64a27b51161b8749">More...</a><br /></td></tr>
<tr class="separator:ac23b54cad8636b3f64a27b51161b8749"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae057d0d8186c0a7936405096a58be981"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#ae057d0d8186c0a7936405096a58be981">AddTypeSafety</a> (<a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="el" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>, bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>=true)</td></tr>
<tr class="memdesc:ae057d0d8186c0a7936405096a58be981"><td class="mdescLeft">&#160;</td><td class="mdescRight">Daisychain-method. <a href="structHazelnp_1_1ParamConstraint.html#ae057d0d8186c0a7936405096a58be981">More...</a><br /></td></tr>
<tr class="separator:ae057d0d8186c0a7936405096a58be981"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48e9c8e4fafb5985876d78239dcdc0e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a48e9c8e4fafb5985876d78239dcdc0e1">AddIncompatibility</a> (const std::string &amp;<a class="el" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</td></tr>
<tr class="memdesc:a48e9c8e4fafb5985876d78239dcdc0e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Daisychain-method. <a href="structHazelnp_1_1ParamConstraint.html#a48e9c8e4fafb5985876d78239dcdc0e1">More...</a><br /></td></tr>
<tr class="separator:a48e9c8e4fafb5985876d78239dcdc0e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea39497a14939fa887c236ee1e755cb3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#aea39497a14939fa887c236ee1e755cb3">ParamConstraint</a> (bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>, <a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="el" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>, const std::initializer_list&lt; std::string &gt; &amp;<a class="el" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>, bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>, const std::initializer_list&lt; std::string &gt; &amp;<a class="el" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</td></tr>
<tr class="memdesc:aea39497a14939fa887c236ee1e755cb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whole constructor. <a href="structHazelnp_1_1ParamConstraint.html#aea39497a14939fa887c236ee1e755cb3">More...</a><br /></td></tr>
<tr class="separator:aea39497a14939fa887c236ee1e755cb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -231,20 +240,157 @@ Friends</h2></td></tr>
<p>Whole constructor. </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00057">57</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; :</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <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="l00060"></a><span class="lineno"> 60</span>&#160; <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="l00061"></a><span class="lineno"> 61</span>&#160; <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="l00062"></a><span class="lineno"> 62</span>&#160; <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="l00063"></a><span class="lineno"> 63</span>&#160; <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="l00064"></a><span class="lineno"> 64</span>&#160; {</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; }</div>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00090">90</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; :</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <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="l00093"></a><span class="lineno"> 93</span>&#160; <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="l00094"></a><span class="lineno"> 94</span>&#160; <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="l00095"></a><span class="lineno"> 95</span>&#160; <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="l00096"></a><span class="lineno"> 96</span>&#160; <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="l00097"></a><span class="lineno"> 97</span>&#160; {</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a48e9c8e4fafb5985876d78239dcdc0e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48e9c8e4fafb5985876d78239dcdc0e1">&#9670;&nbsp;</a></span>AddIncompatibility()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> Hazelnp::ParamConstraint::AddIncompatibility </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>incompatibleParameters</em></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>Daisychain-method. </p>
<p>Will add a the "incompatiblity" aspect. <br />
This means, that the following parameters are NOT compatible with this one and will throw an error if passed together. Syntactical-sugar proxy method that will convert the lonely string to an initializer list for you :3 </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00081">81</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; {</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc = *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; pc.incompatibleParameters = { <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a> };</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
<a id="ac23b54cad8636b3f64a27b51161b8749"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac23b54cad8636b3f64a27b51161b8749">&#9670;&nbsp;</a></span>AddRequire()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> Hazelnp::ParamConstraint::AddRequire </td>
<td>(</td>
<td class="paramtype">const std::initializer_list&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>defaultValue</em> = <code>{}</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>required</em> = <code>true</code>&#160;</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>Daisychain-method. </p>
<p>Will add a the "required-argument" aspect. <br />
Think of the default value like of a list ofparameters. Like {"--width", "800"} </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00027">27</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; {}, <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>&#160; {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc = *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; pc.defaultValue = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; pc.required = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
<a id="ae057d0d8186c0a7936405096a58be981"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae057d0d8186c0a7936405096a58be981">&#9670;&nbsp;</a></span>AddTypeSafety()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> Hazelnp::ParamConstraint::AddTypeSafety </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a>&#160;</td>
<td class="paramname"><em>requiredType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>constrainType</em> = <code>true</code>&#160;</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>Daisychain-method. </p>
<p>Will add a the "type-safety" aspect. <br />
Constructs a type-safety constraint </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00048">48</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc = *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; pc.constrainType = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; pc.requiredType = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a20fa41460106b5327a51114f8a187871"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20fa41460106b5327a51114f8a187871">&#9670;&nbsp;</a></span>Incompatibility() <span class="overload">[1/2]</span></h2>
@@ -272,13 +418,13 @@ Friends</h2></td></tr>
<p>Constructs an incompatibility constraint. </p>
<p>This means, that the following parameters are NOT compatible with this one and will throw an error if passed together </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00037">37</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; pc.incompatibleParameters = <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; }</div>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00059">59</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; {</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; pc.incompatibleParameters = <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
@@ -309,13 +455,13 @@ Friends</h2></td></tr>
<p>Constructs an incompatibility constraint. </p>
<p>This means, that the following parameters are NOT compatible with this one and will throw an error if passed together. Syntactical-sugar proxy method that will convert the lonely string to an initializer list for you :3 </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00048">48</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; pc.incompatibleParameters = { <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a> };</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00070">70</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; {</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; pc.incompatibleParameters = { <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a> };</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
@@ -405,14 +551,14 @@ Friends</h2></td></tr>
<p>Constructs a type-safety constraint. </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00026">26</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; pc.constrainType = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; pc.requiredType = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; }</div>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00037">37</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; pc.constrainType = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; pc.requiredType = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
@@ -437,7 +583,7 @@ Friends</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00092">92</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00125">125</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
</div>
</div>
@@ -457,7 +603,7 @@ Friends</h2></td></tr>
<p>Should this parameter be forced to be of a certain type? <br />
Remember to set <code>constrainTo</code> to the wanted type. </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00070">70</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00103">103</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
</div>
</div>
@@ -478,7 +624,7 @@ Friends</h2></td></tr>
Gets applied if this parameter was not given. <br />
Think of this like a list of parameters. Like {"--width", "800"} </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00078">78</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00111">111</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
</div>
</div>
@@ -496,7 +642,7 @@ Friends</h2></td></tr>
<p>Parameters that are incompatible with this parameter. </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00085">85</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00118">118</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
</div>
</div>
@@ -514,7 +660,7 @@ Friends</h2></td></tr>
<p>If set to true, and no default value set, an error will be produced if this parameter is not supplied by the user. </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00082">82</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00115">115</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
</div>
</div>
@@ -532,7 +678,7 @@ Friends</h2></td></tr>
<p>Constrain the parameter to this value. Requires <code>constrainType</code> to be set to true. </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00073">73</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00106">106</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
</div>
</div>
@@ -540,15 +686,15 @@ Friends</h2></td></tr>
<li>Hazelnupp/<a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a></li>
</ul>
</div><!-- contents -->
<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#l00073">ParamConstraint.h:73</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#l00070">ParamConstraint.h:70</a></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#l00106">ParamConstraint.h:106</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#l00103">ParamConstraint.h:103</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&lt; std::string &gt; 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#l00085">ParamConstraint.h:85</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#l00082">ParamConstraint.h:82</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&lt; std::string &gt; defaultValue</div><div class="ttdoc">The default value for this parameter.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00078">ParamConstraint.h:78</a></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&lt; std::string &gt; 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#l00118">ParamConstraint.h:118</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#l00115">ParamConstraint.h:115</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&lt; std::string &gt; defaultValue</div><div class="ttdoc">The default value for this parameter.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00111">ParamConstraint.h:111</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 5 2021 12:24:40 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Sep 5 2021 12:56:58 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>