Build doxygen
This commit is contained in:
@@ -83,69 +83,73 @@ $(function() {
|
||||
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include <string></span></div>
|
||||
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <vector></span></div>
|
||||
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
|
||||
<div class="line"><a name="l00006"></a><span class="lineno"><a class="line" href="structParamConstraint.html"> 6</a></span> <span class="keyword">struct </span><a class="code" href="structParamConstraint.html">ParamConstraint</a></div>
|
||||
<div class="line"><a name="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"> 8</span> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  <a class="code" href="structParamConstraint.html#ae0ce64f2f0928d602b6f6117ff34d155">ParamConstraint</a>() = <span class="keywordflow">default</span>;</div>
|
||||
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
||||
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structParamConstraint.html#a40e47d3ad68cadbe785551c4aaad828c"> 14</a></span>  <span class="keyword">static</span> <a class="code" href="structParamConstraint.html">ParamConstraint</a> <a class="code" href="structParamConstraint.html#a40e47d3ad68cadbe785551c4aaad828c">Require</a>(<span class="keyword">const</span> std::string& <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a>, <span class="keyword">const</span> std::vector<std::string>& <a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a> = {}, <span class="keywordtype">bool</span> <a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a> = <span class="keyword">true</span>)</div>
|
||||
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  {</div>
|
||||
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <a class="code" href="structParamConstraint.html">ParamConstraint</a> pc;</div>
|
||||
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  pc.<a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a> = <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a>;</div>
|
||||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  pc.<a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a> = <a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a>;</div>
|
||||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  pc.<a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a> = <a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a>;</div>
|
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordflow">return</span> pc;</div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  }</div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structParamConstraint.html#a3ecbccdce5be2529712e0866725c7cd5"> 25</a></span>  <span class="keyword">static</span> <a class="code" href="structParamConstraint.html">ParamConstraint</a> <a class="code" href="structParamConstraint.html#a3ecbccdce5be2529712e0866725c7cd5">TypeSafety</a>(<span class="keyword">const</span> std::string& <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a>, <a class="code" href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27b">DATA_TYPE</a> <a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a>, <span class="keywordtype">bool</span> <a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a> = <span class="keyword">true</span>)</div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  {</div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="structParamConstraint.html">ParamConstraint</a> pc;</div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  pc.<a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a> = <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a>;</div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  pc.<a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a> = <a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a>;</div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  pc.<a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a> = <a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a>;</div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">return</span> pc;</div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  }</div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structParamConstraint.html#a93783114c6f374b77479a283c4aadf05"> 36</a></span>  <a class="code" href="structParamConstraint.html#a93783114c6f374b77479a283c4aadf05">ParamConstraint</a>(<span class="keyword">const</span> std::string& <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a>, <span class="keywordtype">bool</span> <a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a>, <a class="code" href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27b">DATA_TYPE</a> <a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a>, <span class="keyword">const</span> std::vector<std::string>& <a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a>, <span class="keywordtype">bool</span> <a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a>)</div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  :</div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a> { <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a> },</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a> { <a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a> },</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a> { <a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a> },</div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a> { <a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a> },</div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a>{ <a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a> }</div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  {</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648"> 48</a></span>  std::string <a class="code" href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">key</a>;</div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2"> 52</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">constrainType</a> = <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
|
||||
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a"> 55</a></span>  <a class="code" href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27b">DATA_TYPE</a> <a class="code" href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">wantedType</a> = <a class="code" href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a>;</div>
|
||||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
||||
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff"> 60</a></span>  std::vector<std::string> <a class="code" href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">defaultValue</a>;</div>
|
||||
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
||||
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d"> 64</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">required</a> = <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> };</div>
|
||||
<div 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>:</div>
|
||||
<div class="line"><a name="l00012"></a><span class="lineno"> 12</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>  </div>
|
||||
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#afbcc75c428381ab3a292d3f55945eb32"> 16</a></span>  <span class="keyword">static</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#afbcc75c428381ab3a292d3f55945eb32">Require</a>(<span class="keyword">const</span> std::string& <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>, <span class="keyword">const</span> std::vector<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#aac148076c5e0ab91c666f3343c30bd15">key</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>;</div>
|
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</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="l00021"></a><span class="lineno"> 21</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="l00022"></a><span class="lineno"> 22</span>  </div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordflow">return</span> pc;</div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  }</div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#ab85210bb37bbace962ff08fcccdafaf2"> 27</a></span>  <span class="keyword">static</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ab85210bb37bbace962ff08fcccdafaf2">TypeSafety</a>(<span class="keyword">const</span> std::string& <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>, <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</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="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;</div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>;</div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</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="l00032"></a><span class="lineno"> 32</span>  pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a>;</div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">return</span> pc;</div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  }</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#ab2a897c3044ae2d1a05952a804a3675b"> 38</a></span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html#ab2a897c3044ae2d1a05952a804a3675b">ParamConstraint</a>(<span class="keyword">const</span> std::string& <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</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#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a>, <span class="keyword">const</span> std::vector<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>)</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  :</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a> },</div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</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="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a> },</div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</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="l00044"></a><span class="lineno"> 44</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="l00045"></a><span class="lineno"> 45</span>  {</div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  }</div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15"> 50</a></span>  std::string <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>;</div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
||||
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac"> 54</a></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="l00055"></a><span class="lineno"> 55</span>  </div>
|
||||
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329"> 57</a></span>  <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a> = <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a>;</div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
|
||||
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7"> 62</a></span>  std::vector<std::string> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>;</div>
|
||||
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
||||
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c"> 66</a></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="l00067"></a><span class="lineno"> 67</span>  };</div>
|
||||
<div class="line"><a name="l00068"></a><span class="lineno"> 68</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="DataType_8h_source.html#l00003">DataType.h:3</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="aDataType_8h_html_aa082c000e4eff6ed512714ea0a33d27b"><div class="ttname"><a href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27b">DATA_TYPE</a></div><div class="ttdeci">DATA_TYPE</div><div class="ttdoc">The different data types a paramater can be.</div><div class="ttdef"><b>Definition:</b> <a href="DataType_8h_source.html#l00005">DataType.h:5</a></div></div>
|
||||
<div class="ttc" id="aDataType_8h_html_aa082c000e4eff6ed512714ea0a33d27ba6d0c9fc747131795e6e5d0c5119f12cb"><div class="ttname"><a href="DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a></div><div class="ttdeci">@ VOID</div></div>
|
||||
<div class="ttc" id="astructParamConstraint_html_a5c451d5ade6c548af7de0a978964a09d"><div class="ttname"><a href="structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d">ParamConstraint::required</a></div><div class="ttdeci">bool required</div><div class="ttdoc">If set to true, and no default value set, an error will be produced if this parameter is not supplied...</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00064">ParamConstraint.h:64</a></div></div>
|
||||
<div class="ttc" id="astructParamConstraint_html_a93783114c6f374b77479a283c4aadf05"><div class="ttname"><a href="structParamConstraint.html#a93783114c6f374b77479a283c4aadf05">ParamConstraint::ParamConstraint</a></div><div class="ttdeci">ParamConstraint(const std::string &key, bool constrainType, DATA_TYPE wantedType, const std::vector< std::string > &defaultValue, bool required)</div><div class="ttdoc">Whole constructor.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00036">ParamConstraint.h:36</a></div></div>
|
||||
<div class="ttc" id="astructParamConstraint_html_a3ecbccdce5be2529712e0866725c7cd5"><div class="ttname"><a href="structParamConstraint.html#a3ecbccdce5be2529712e0866725c7cd5">ParamConstraint::TypeSafety</a></div><div class="ttdeci">static ParamConstraint TypeSafety(const std::string &key, DATA_TYPE wantedType, bool constrainType=true)</div><div class="ttdoc">Constructs a type-safety constraint.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00025">ParamConstraint.h:25</a></div></div>
|
||||
<div class="ttc" id="astructParamConstraint_html_af2832fa007abaabc05784d5f978aeeff"><div class="ttname"><a href="structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff">ParamConstraint::defaultValue</a></div><div class="ttdeci">std::vector< std::string > defaultValue</div><div class="ttdoc">The default value for this parameter.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00060">ParamConstraint.h:60</a></div></div>
|
||||
<div class="ttc" id="astructParamConstraint_html_a40e47d3ad68cadbe785551c4aaad828c"><div class="ttname"><a href="structParamConstraint.html#a40e47d3ad68cadbe785551c4aaad828c">ParamConstraint::Require</a></div><div class="ttdeci">static ParamConstraint Require(const std::string &key, const std::vector< std::string > &defaultValue={}, bool required=true)</div><div class="ttdoc">Constructs a require constraint.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00014">ParamConstraint.h:14</a></div></div>
|
||||
<div class="ttc" id="astructParamConstraint_html_aa3bd052bbaebdc795f0922731c666648"><div class="ttname"><a href="structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648">ParamConstraint::key</a></div><div class="ttdeci">std::string key</div><div class="ttdoc">The key of the parameter to constrain.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00048">ParamConstraint.h:48</a></div></div>
|
||||
<div class="ttc" id="astructParamConstraint_html_ab35444d2957439bc52c2056a829145a2"><div class="ttname"><a href="structParamConstraint.html#ab35444d2957439bc52c2056a829145a2">ParamConstraint::constrainType</a></div><div class="ttdeci">bool constrainType</div><div class="ttdoc">Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00052">ParamConstraint.h:52</a></div></div>
|
||||
<div class="ttc" id="astructParamConstraint_html_ae0ce64f2f0928d602b6f6117ff34d155"><div class="ttname"><a href="structParamConstraint.html#ae0ce64f2f0928d602b6f6117ff34d155">ParamConstraint::ParamConstraint</a></div><div class="ttdeci">ParamConstraint()=default</div><div class="ttdoc">Empty constructor.</div></div>
|
||||
<div class="ttc" id="astructParamConstraint_html_ae8875e054a074241f0c0bf3328a0915a"><div class="ttname"><a href="structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a">ParamConstraint::wantedType</a></div><div class="ttdeci">DATA_TYPE wantedType</div><div class="ttdoc">Constrain the parameter to this value. Requires constrainType to be set to true.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00055">ParamConstraint.h:55</a></div></div>
|
||||
<div class="ttc" id="astructParamConstraint_html"><div class="ttname"><a href="structParamConstraint.html">ParamConstraint</a></div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00006">ParamConstraint.h:6</a></div></div>
|
||||
<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_ac07a0c0555431d4b1e0bc6afdba41329"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">Hazelnp::ParamConstraint::wantedType</a></div><div class="ttdeci">DATA_TYPE wantedType</div><div class="ttdoc">Constrain the parameter to this value. Requires constrainType to be set to true.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00057">ParamConstraint.h:57</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#l00054">ParamConstraint.h:54</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_aac148076c5e0ab91c666f3343c30bd15"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">Hazelnp::ParamConstraint::key</a></div><div class="ttdeci">std::string key</div><div class="ttdoc">The key of the parameter to constrain.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00050">ParamConstraint.h:50</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#l00066">ParamConstraint.h:66</a></div></div>
|
||||
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_afbcc75c428381ab3a292d3f55945eb32"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#afbcc75c428381ab3a292d3f55945eb32">Hazelnp::ParamConstraint::Require</a></div><div class="ttdeci">static ParamConstraint Require(const std::string &key, const std::vector< std::string > &defaultValue={}, bool required=true)</div><div class="ttdoc">Constructs a require constraint.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00016">ParamConstraint.h:16</a></div></div>
|
||||
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_ab2a897c3044ae2d1a05952a804a3675b"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#ab2a897c3044ae2d1a05952a804a3675b">Hazelnp::ParamConstraint::ParamConstraint</a></div><div class="ttdeci">ParamConstraint(const std::string &key, bool constrainType, DATA_TYPE wantedType, const std::vector< std::string > &defaultValue, bool required)</div><div class="ttdoc">Whole constructor.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00038">ParamConstraint.h:38</a></div></div>
|
||||
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_ab85210bb37bbace962ff08fcccdafaf2"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#ab85210bb37bbace962ff08fcccdafaf2">Hazelnp::ParamConstraint::TypeSafety</a></div><div class="ttdeci">static ParamConstraint TypeSafety(const std::string &key, DATA_TYPE wantedType, bool constrainType=true)</div><div class="ttdoc">Constructs a type-safety constraint.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00027">ParamConstraint.h:27</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#l00007">DataType.h:7</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#l00062">ParamConstraint.h:62</a></div></div>
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Thu Jun 3 2021 12:21:21 for Leonetienne/Hazelnupp by  <a href="http://www.doxygen.org/index.html">
|
||||
Generated on Thu Jun 3 2021 13:42:54 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>
|
||||
|
Reference in New Issue
Block a user