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 13:00:28 +02:00
parent 5fe12e07fd
commit ef90b96a3b
110 changed files with 262 additions and 209 deletions
Download Patch File Download Diff File Expand all files Collapse all files

107
docs/ParamConstraint_8h_source.html
View File

@@ -158,7 +158,7 @@ $(function() {
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="comment"> //! Daisychain-method. Will add a the &quot;incompatiblity&quot; aspect. </span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<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>&#160;<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#a48e9c8e4fafb5985876d78239dcdc0e1"> 81</a></span>&#160;<span class="comment"></span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a48e9c8e4fafb5985876d78239dcdc0e1">AddIncompatibility</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#ae335d099a2735b77239ad7eec5136991"> 81</a></span>&#160;<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&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</div>
<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">ParamConstraint</a> pc = *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a> = { <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a> };</div>
@@ -166,45 +166,55 @@ $(function() {
<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 class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="comment"> //! Whole constructor</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#aea39497a14939fa887c236ee1e755cb3"> 90</a></span>&#160;<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&lt;std::string&gt;&amp; <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&lt;std::string&gt;&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</div>
<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 class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="comment"> //! Should this parameter be forced to be of a certain type? </span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<span class="comment"> //! Remember to set `constrainTo` to the wanted type</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac"> 103</a></span>&#160;<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="l00104"></a><span class="lineno"> 104</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="comment"> //! Constrain the parameter to this value. Requires `constrainType` to be set to true.</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a"> 106</a></span>&#160;<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="l00107"></a><span class="lineno"> 107</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="comment"> //! The default value for this parameter. </span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="comment"> //! Gets applied if this parameter was not given. </span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment"> //! Think of this like a list of parameters. Like {&quot;--width&quot;, &quot;800&quot;}</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7"> 111</a></span>&#160;<span class="comment"></span> std::vector&lt;std::string&gt; <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="comment"> //! If set to true, and no default value set,</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="comment"> //! an error will be produced if this parameter is not supplied by the user.</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c"> 115</a></span>&#160;<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="l00116"></a><span class="lineno"> 116</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="comment"> //! Parameters that are incompatible with this parameter</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c"> 118</a></span>&#160;<span class="comment"></span> std::vector&lt;std::string&gt; <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keyword">private</span>:<span class="comment"></span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="comment"> //! The parameter this constraint is for.</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="comment"> //! This value is automatically set by Hazelnupp.</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;<span class="comment"></span> std::string key;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; </div>
<div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a01773a2aa9845fd639f63468586b67b0"> 125</a></span>&#160; <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="l00126"></a><span class="lineno"> 126</span>&#160; };</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;}</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="comment"> //! Daisychain-method. Will add a the &quot;incompatiblity&quot; aspect. </span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<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>&#160;<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&lt;std::string&gt;&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; {</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <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>&#160; 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>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordflow">return</span> pc;</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="comment"></span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<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>&#160;<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&lt;std::string&gt;&amp; <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&lt;std::string&gt;&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; :</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</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="l00103"></a><span class="lineno"> 103</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="l00104"></a><span class="lineno"> 104</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="l00105"></a><span class="lineno"> 105</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="l00106"></a><span class="lineno"> 106</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="l00107"></a><span class="lineno"> 107</span>&#160; {</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; }</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<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>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="comment"> //! The default value for this parameter. </span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<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>&#160;<span class="comment"> //! Think of this like a list of parameters. Like {&quot;--width&quot;, &quot;800&quot;}</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7"> 121</a></span>&#160;<span class="comment"></span> std::vector&lt;std::string&gt; <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<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>&#160;<span class="comment"></span> std::vector&lt;std::string&gt; <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>;</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keyword">private</span>:<span class="comment"></span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="comment"> //! The parameter this constraint is for.</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="comment"> //! This value is automatically set by Hazelnupp.</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="comment"></span> std::string key;</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
<div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a01773a2aa9845fd639f63468586b67b0"> 135</a></span>&#160; <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>&#160; };</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;}</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&lt; std::string &gt; &amp;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>
@@ -212,23 +222,24 @@ $(function() {
<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 &amp;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&lt; std::string &gt; &amp;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_a48e9c8e4fafb5985876d78239dcdc0e1"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a48e9c8e4fafb5985876d78239dcdc0e1">Hazelnp::ParamConstraint::AddIncompatibility</a></div><div class="ttdeci">ParamConstraint AddIncompatibility(const std::string &amp;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_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&lt; std::string &gt; &amp;defaultValue, bool required, const std::initializer_list&lt; std::string &gt; &amp;incompatibleParameters)</div><div class="ttdoc">Whole constructor.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00090">ParamConstraint.h:90</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&lt; std::string &gt; &amp;defaultValue, bool required, const std::initializer_list&lt; std::string &gt; &amp;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#l00106">ParamConstraint.h:106</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#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 &amp;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#l00103">ParamConstraint.h:103</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&lt; std::string &gt; &amp;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&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_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#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&lt; std::string &gt; &amp;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&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>
<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#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 12:56:57 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Sep 5 2021 13:00:16 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>