Built docs
This commit is contained in:
@@ -281,11 +281,11 @@ Public Member Functions</h2></td></tr>
|
||||
<p><br />
|
||||
IMPORTANT: This parameter is the abbreviation! Not the long form! </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00632">632</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00633"></a><span class="lineno"> 633</span> {</div>
|
||||
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span>  parameterAbreviations.erase(abbrevation);</div>
|
||||
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00651">651</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00652"></a><span class="lineno"> 652</span> {</div>
|
||||
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span>  parameterAbreviations.erase(abbrevation);</div>
|
||||
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -306,11 +306,11 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p>Will delete all abbreviations. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00638">638</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00639"></a><span class="lineno"> 639</span> {</div>
|
||||
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span>  parameterAbreviations.clear();</div>
|
||||
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00657">657</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00658"></a><span class="lineno"> 658</span> {</div>
|
||||
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span>  parameterAbreviations.clear();</div>
|
||||
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00661"></a><span class="lineno"> 661</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -332,11 +332,11 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p>Will the constraint of a specific parameter. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00593">593</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00594"></a><span class="lineno"> 594</span> {</div>
|
||||
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span>  parameterConstraints.erase(parameter);</div>
|
||||
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00612">612</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00613"></a><span class="lineno"> 613</span> {</div>
|
||||
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span>  parameterConstraints.erase(parameter);</div>
|
||||
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -357,11 +357,11 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p>Will delete all constraints. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00651">651</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00652"></a><span class="lineno"> 652</span> {</div>
|
||||
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span>  parameterConstraints.clear();</div>
|
||||
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00670">670</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00671"></a><span class="lineno"> 671</span> {</div>
|
||||
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span>  parameterConstraints.clear();</div>
|
||||
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00674"></a><span class="lineno"> 674</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -451,102 +451,121 @@ Public Member Functions</h2></td></tr>
|
||||
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span>  <span class="keywordtype">bool</span> required = <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span>  <span class="keywordtype">bool</span> typeIsForced = <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span>  std::string defaultVal;</div>
|
||||
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  };</div>
|
||||
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span>  std::unordered_map<std::string, ParamDocEntry> paramInfos;</div>
|
||||
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span>  </div>
|
||||
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  <span class="comment">// Collect descriptions</span></div>
|
||||
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>& it : parameterDescriptions)</div>
|
||||
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  {</div>
|
||||
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>  <span class="comment">// Do we already have that param in the paramInfo set?</span></div>
|
||||
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  <span class="keywordflow">if</span> (paramInfos.find(it.first) == paramInfos.end())</div>
|
||||
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  <span class="comment">// No? Create it.</span></div>
|
||||
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  paramInfos[it.first] = ParamDocEntry();</div>
|
||||
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  </div>
|
||||
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span>  paramInfos[it.first].description = it.second;</div>
|
||||
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span>  }</div>
|
||||
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span>  </div>
|
||||
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>  <span class="comment">// Collect abbreviations</span></div>
|
||||
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span>  <span class="comment">// first value is abbreviation, second is long form</span></div>
|
||||
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>& it : parameterAbreviations)</div>
|
||||
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  {</div>
|
||||
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span>  <span class="comment">// Do we already have that param in the paramInfo set?</span></div>
|
||||
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span>  <span class="keywordflow">if</span> (paramInfos.find(it.second) == paramInfos.end())</div>
|
||||
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span>  <span class="comment">// No? Create it.</span></div>
|
||||
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span>  paramInfos[it.second] = ParamDocEntry();</div>
|
||||
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span>  </div>
|
||||
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span>  paramInfos[it.second].abbreviation = it.first;</div>
|
||||
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>  }</div>
|
||||
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>  </div>
|
||||
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span>  <span class="comment">// Collect constraints</span></div>
|
||||
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>& it : parameterConstraints)</div>
|
||||
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span>  {</div>
|
||||
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span>  <span class="comment">// Do we already have that param in the paramInfo set?</span></div>
|
||||
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>  <span class="keywordflow">if</span> (paramInfos.find(it.first) == paramInfos.end())</div>
|
||||
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span>  <span class="comment">// No? Create it.</span></div>
|
||||
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span>  paramInfos[it.first] = ParamDocEntry();</div>
|
||||
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span>  </div>
|
||||
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  ParamDocEntry& cached = paramInfos[it.first];</div>
|
||||
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  cached.required = it.second.required;</div>
|
||||
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  cached.typeIsForced = it.second.constrainType;</div>
|
||||
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  cached.type = <a class="code" href="namespaceHazelnp.html#a7fb1e5ad9e2ecb6c0025beb19f11621b">DataTypeToString</a>(it.second.requiredType);</div>
|
||||
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  </div>
|
||||
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span>  std::stringstream defaultValueSs;</div>
|
||||
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> std::string& s : it.second.defaultValue)</div>
|
||||
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  {</div>
|
||||
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  defaultValueSs << <span class="charliteral">'\''</span> << s << <span class="charliteral">'\''</span>;</div>
|
||||
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  </div>
|
||||
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  <span class="comment">// Add a space if we are not at the last entry</span></div>
|
||||
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  <span class="keywordflow">if</span> ((<span class="keywordtype">void</span>*)&s != (<span class="keywordtype">void</span>*)&it.second.defaultValue.back())</div>
|
||||
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span>  defaultValueSs << <span class="stringliteral">" "</span>;</div>
|
||||
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  }</div>
|
||||
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span>  cached.defaultVal = defaultValueSs.str();</div>
|
||||
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  }</div>
|
||||
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span>  </div>
|
||||
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span>  <span class="comment">// Now generate the documentatino body</span></div>
|
||||
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span>  <span class="keywordflow">if</span> (paramInfos.size() > 0)</div>
|
||||
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span>  {</div>
|
||||
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span>  ss << std::endl </div>
|
||||
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span>  << <span class="stringliteral">"==== AVAILABLE PARAMETERS ===="</span> </div>
|
||||
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  << std::endl << std::endl;</div>
|
||||
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span>  </div>
|
||||
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span>  std::size_t counter = 0;</div>
|
||||
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>& it : paramInfos)</div>
|
||||
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span>  {</div>
|
||||
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  <span class="keyword">const</span> ParamDocEntry& pde = it.second;</div>
|
||||
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span>  </div>
|
||||
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span>  <span class="comment">// Put name</span></div>
|
||||
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span>  ss << it.first << <span class="stringliteral">" "</span>;</div>
|
||||
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  std::string incompatibilities;</div>
|
||||
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span>  };</div>
|
||||
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span>  std::unordered_map<std::string, ParamDocEntry> paramInfos;</div>
|
||||
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  </div>
|
||||
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span>  <span class="comment">// Collect descriptions</span></div>
|
||||
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>& it : parameterDescriptions)</div>
|
||||
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>  {</div>
|
||||
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  <span class="comment">// Do we already have that param in the paramInfo set?</span></div>
|
||||
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  <span class="keywordflow">if</span> (paramInfos.find(it.first) == paramInfos.end())</div>
|
||||
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  <span class="comment">// No? Create it.</span></div>
|
||||
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  paramInfos[it.first] = ParamDocEntry();</div>
|
||||
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span>  </div>
|
||||
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span>  paramInfos[it.first].description = it.second;</div>
|
||||
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span>  }</div>
|
||||
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>  </div>
|
||||
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span>  <span class="comment">// Collect abbreviations</span></div>
|
||||
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span>  <span class="comment">// first value is abbreviation, second is long form</span></div>
|
||||
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>& it : parameterAbreviations)</div>
|
||||
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span>  {</div>
|
||||
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span>  <span class="comment">// Do we already have that param in the paramInfo set?</span></div>
|
||||
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span>  <span class="keywordflow">if</span> (paramInfos.find(it.second) == paramInfos.end())</div>
|
||||
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span>  <span class="comment">// No? Create it.</span></div>
|
||||
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span>  paramInfos[it.second] = ParamDocEntry();</div>
|
||||
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span>  </div>
|
||||
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>  paramInfos[it.second].abbreviation = it.first;</div>
|
||||
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>  }</div>
|
||||
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span>  </div>
|
||||
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span>  <span class="comment">// Collect constraints</span></div>
|
||||
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>& it : parameterConstraints)</div>
|
||||
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span>  {</div>
|
||||
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>  <span class="comment">// Do we already have that param in the paramInfo set?</span></div>
|
||||
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span>  <span class="keywordflow">if</span> (paramInfos.find(it.first) == paramInfos.end())</div>
|
||||
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span>  <span class="comment">// No? Create it.</span></div>
|
||||
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span>  paramInfos[it.first] = ParamDocEntry();</div>
|
||||
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  </div>
|
||||
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  ParamDocEntry& cached = paramInfos[it.first];</div>
|
||||
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  cached.required = it.second.required;</div>
|
||||
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  cached.typeIsForced = it.second.constrainType;</div>
|
||||
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  cached.type = <a class="code" href="namespaceHazelnp.html#a7fb1e5ad9e2ecb6c0025beb19f11621b">DataTypeToString</a>(it.second.requiredType);</div>
|
||||
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span>  </div>
|
||||
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span>  <span class="comment">// Build default-value string</span></div>
|
||||
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  std::stringstream vec2str_ss;</div>
|
||||
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> std::string& s : it.second.defaultValue)</div>
|
||||
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  {</div>
|
||||
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  vec2str_ss << <span class="charliteral">'\''</span> << s << <span class="charliteral">'\''</span>;</div>
|
||||
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  </div>
|
||||
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span>  <span class="comment">// Add a space if we are not at the last entry</span></div>
|
||||
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  <span class="keywordflow">if</span> ((<span class="keywordtype">void</span>*)&s != (<span class="keywordtype">void</span>*)&it.second.defaultValue.back())</div>
|
||||
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span>  vec2str_ss << <span class="stringliteral">" "</span>;</div>
|
||||
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  }</div>
|
||||
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span>  cached.defaultVal = vec2str_ss.str();</div>
|
||||
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span>  </div>
|
||||
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span>  </div>
|
||||
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span>  <span class="comment">// Build incompatibilities string</span></div>
|
||||
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span>  vec2str_ss.str(<span class="stringliteral">""</span>);</div>
|
||||
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> std::string& s : it.second.incompatibleParameters)</div>
|
||||
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  {</div>
|
||||
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span>  vec2str_ss << s;</div>
|
||||
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span>  </div>
|
||||
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>  <span class="comment">// Add a comma-space if we are not at the last entry</span></div>
|
||||
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span>  <span class="keywordflow">if</span> ((<span class="keywordtype">void</span>*)&s != (<span class="keywordtype">void</span>*)&it.second.incompatibleParameters.back())</div>
|
||||
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  vec2str_ss << <span class="stringliteral">", "</span>;</div>
|
||||
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span>  }</div>
|
||||
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span>  cached.incompatibilities = vec2str_ss.str();</div>
|
||||
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span>  }</div>
|
||||
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span>  </div>
|
||||
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span>  <span class="comment">// Put abbreviation</span></div>
|
||||
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span>  <span class="keywordflow">if</span> (pde.abbreviation.length() > 0)</div>
|
||||
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span>  ss << pde.abbreviation << <span class="stringliteral">" "</span>;</div>
|
||||
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span>  </div>
|
||||
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span>  <span class="comment">// Put type</span></div>
|
||||
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span>  <span class="keywordflow">if</span> (pde.typeIsForced)</div>
|
||||
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span>  ss << pde.type << <span class="stringliteral">" "</span>;</div>
|
||||
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span>  </div>
|
||||
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span>  <span class="comment">// Put default value</span></div>
|
||||
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span>  <span class="keywordflow">if</span> (pde.defaultVal.length() > 0)</div>
|
||||
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span>  ss << <span class="stringliteral">"default=["</span> << pde.defaultVal << <span class="stringliteral">"] "</span>;</div>
|
||||
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span>  <span class="comment">// Now generate the documentation body</span></div>
|
||||
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span>  <span class="keywordflow">if</span> (paramInfos.size() > 0)</div>
|
||||
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span>  {</div>
|
||||
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span>  ss << std::endl </div>
|
||||
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span>  << <span class="stringliteral">"==== AVAILABLE PARAMETERS ===="</span> </div>
|
||||
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span>  << std::endl << std::endl;</div>
|
||||
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span>  </div>
|
||||
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span>  std::size_t counter = 0;</div>
|
||||
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>& it : paramInfos)</div>
|
||||
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span>  {</div>
|
||||
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span>  <span class="keyword">const</span> ParamDocEntry& pde = it.second;</div>
|
||||
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span>  </div>
|
||||
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span>  <span class="comment">// Put required tag, but only if no default value</span></div>
|
||||
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span>  <span class="keywordflow">if</span> ((pde.required) && (pde.defaultVal.length() == 0))</div>
|
||||
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span>  ss << <span class="stringliteral">"[[REQUIRED]] "</span>;</div>
|
||||
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span>  </div>
|
||||
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span>  <span class="comment">// Put brief description</span></div>
|
||||
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span>  <span class="keywordflow">if</span> (pde.description.length() > 0)</div>
|
||||
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span>  ss << pde.description;</div>
|
||||
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span>  </div>
|
||||
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span>  <span class="comment">// Omit linebreaks when we're on the last element</span></div>
|
||||
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span>  <span class="keywordflow">if</span> (counter < paramInfos.size()-1)</div>
|
||||
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span>  ss << std::endl << std::endl;</div>
|
||||
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span>  </div>
|
||||
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span>  counter++;</div>
|
||||
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span>  }</div>
|
||||
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span>  }</div>
|
||||
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span>  </div>
|
||||
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span>  <span class="keywordflow">return</span> ss.str();</div>
|
||||
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span> }</div>
|
||||
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span>  <span class="comment">// Put name</span></div>
|
||||
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span>  ss << it.first << <span class="stringliteral">" "</span>;</div>
|
||||
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span>  </div>
|
||||
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span>  <span class="comment">// Put abbreviation</span></div>
|
||||
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span>  <span class="keywordflow">if</span> (pde.abbreviation.length() > 0)</div>
|
||||
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span>  ss << pde.abbreviation << <span class="stringliteral">" "</span>;</div>
|
||||
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span>  </div>
|
||||
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span>  <span class="comment">// Put type</span></div>
|
||||
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span>  <span class="keywordflow">if</span> (pde.typeIsForced)</div>
|
||||
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span>  ss << pde.type << <span class="stringliteral">" "</span>;</div>
|
||||
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span>  </div>
|
||||
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span>  <span class="comment">// Put default value</span></div>
|
||||
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span>  <span class="keywordflow">if</span> (pde.defaultVal.length() > 0)</div>
|
||||
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span>  ss << <span class="stringliteral">"default=["</span> << pde.defaultVal << <span class="stringliteral">"] "</span>;</div>
|
||||
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span>  </div>
|
||||
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span>  <span class="comment">// Put incompatibilities</span></div>
|
||||
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span>  <span class="keywordflow">if</span> (pde.incompatibilities.length() > 0)</div>
|
||||
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span>  ss << <span class="stringliteral">"incompatibilities=["</span> << pde.incompatibilities << <span class="stringliteral">"] "</span>;</div>
|
||||
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span>  </div>
|
||||
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span>  <span class="comment">// Put required tag, but only if no default value</span></div>
|
||||
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span>  <span class="keywordflow">if</span> ((pde.required) && (pde.defaultVal.length() == 0))</div>
|
||||
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span>  ss << <span class="stringliteral">"[[REQUIRED]] "</span>;</div>
|
||||
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span>  </div>
|
||||
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span>  <span class="comment">// Put brief description</span></div>
|
||||
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span>  <span class="keywordflow">if</span> (pde.description.length() > 0)</div>
|
||||
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span>  ss << pde.description;</div>
|
||||
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span>  </div>
|
||||
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span>  <span class="comment">// Omit linebreaks when we're on the last element</span></div>
|
||||
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span>  <span class="keywordflow">if</span> (counter < paramInfos.size()-1)</div>
|
||||
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span>  ss << std::endl << std::endl;</div>
|
||||
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span>  </div>
|
||||
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span>  counter++;</div>
|
||||
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span>  }</div>
|
||||
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span>  }</div>
|
||||
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span>  </div>
|
||||
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span>  <span class="keywordflow">return</span> ss.str();</div>
|
||||
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -569,13 +588,13 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Will return the long form of an abbreviation (like –force for -f) <br />
|
||||
Returns "" if no match is found. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00619">619</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00620"></a><span class="lineno"> 620</span> {</div>
|
||||
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span>  <span class="keywordflow">if</span> (!<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#a58b81709e631cee5f3db3f3f48611fe9">HasAbbreviation</a>(abbrev))</div>
|
||||
<div class="line"><a name="l00622"></a><span class="lineno"> 622</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceHazelnp_1_1Placeholders.html#a90536f0cd5261b18da736e954c6b8b79">Placeholders::g_emptyString</a>;</div>
|
||||
<div class="line"><a name="l00623"></a><span class="lineno"> 623</span>  </div>
|
||||
<div class="line"><a name="l00624"></a><span class="lineno"> 624</span>  <span class="keywordflow">return</span> parameterAbreviations.find(abbrev)->second;</div>
|
||||
<div class="line"><a name="l00625"></a><span class="lineno"> 625</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00638">638</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00639"></a><span class="lineno"> 639</span> {</div>
|
||||
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span>  <span class="keywordflow">if</span> (!<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#a58b81709e631cee5f3db3f3f48611fe9">HasAbbreviation</a>(abbrev))</div>
|
||||
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceHazelnp_1_1Placeholders.html#a90536f0cd5261b18da736e954c6b8b79">Placeholders::g_emptyString</a>;</div>
|
||||
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span>  </div>
|
||||
<div class="line"><a name="l00643"></a><span class="lineno"> 643</span>  <span class="keywordflow">return</span> parameterAbreviations.find(abbrev)->second;</div>
|
||||
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -645,10 +664,10 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p>Will return the constraint information for a specific parameter. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00588">588</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00589"></a><span class="lineno"> 589</span> {</div>
|
||||
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span>  <span class="keywordflow">return</span> parameterConstraints.find(parameter)->second;</div>
|
||||
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00607">607</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00608"></a><span class="lineno"> 608</span> {</div>
|
||||
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span>  <span class="keywordflow">return</span> parameterConstraints.find(parameter)->second;</div>
|
||||
<div class="line"><a name="l00610"></a><span class="lineno"> 610</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -726,10 +745,10 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p>Will return argv[0], the name of the executable. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00599">599</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00600"></a><span class="lineno"> 600</span> {</div>
|
||||
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span>  <span class="keywordflow">return</span> executableName;</div>
|
||||
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00618">618</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00619"></a><span class="lineno"> 619</span> {</div>
|
||||
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span>  <span class="keywordflow">return</span> executableName;</div>
|
||||
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -751,10 +770,10 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p>Will check wether or not an abbreviation is registered. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00627">627</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00628"></a><span class="lineno"> 628</span> {</div>
|
||||
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span>  <span class="keywordflow">return</span> parameterAbreviations.find(abbrev) != parameterAbreviations.end();</div>
|
||||
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00646">646</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00647"></a><span class="lineno"> 647</span> {</div>
|
||||
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span>  <span class="keywordflow">return</span> parameterAbreviations.find(abbrev) != parameterAbreviations.end();</div>
|
||||
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -826,14 +845,14 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p>Will return the value given a key. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00604">604</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00605"></a><span class="lineno"> 605</span> {</div>
|
||||
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span>  <span class="comment">// Throw exception if param is unknown</span></div>
|
||||
<div class="line"><a name="l00607"></a><span class="lineno"> 607</span>  <span class="keywordflow">if</span> (!<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#a3a7fa36fe69ee8bf3b400983a21ecd24">HasParam</a>(key))</div>
|
||||
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span>  <span class="keywordflow">throw</span> <a class="code" href="classHazelnp_1_1HazelnuppInvalidKeyException.html">HazelnuppInvalidKeyException</a>();</div>
|
||||
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span>  </div>
|
||||
<div class="line"><a name="l00610"></a><span class="lineno"> 610</span>  <span class="keywordflow">return</span> *parameters.find(key)->second->GetValue();</div>
|
||||
<div class="line"><a name="l00611"></a><span class="lineno"> 611</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00623">623</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00624"></a><span class="lineno"> 624</span> {</div>
|
||||
<div class="line"><a name="l00625"></a><span class="lineno"> 625</span>  <span class="comment">// Throw exception if param is unknown</span></div>
|
||||
<div class="line"><a name="l00626"></a><span class="lineno"> 626</span>  <span class="keywordflow">if</span> (!<a class="code" href="classHazelnp_1_1CmdArgsInterface.html#a3a7fa36fe69ee8bf3b400983a21ecd24">HasParam</a>(key))</div>
|
||||
<div class="line"><a name="l00627"></a><span class="lineno"> 627</span>  <span class="keywordflow">throw</span> <a class="code" href="classHazelnp_1_1HazelnuppInvalidKeyException.html">HazelnuppInvalidKeyException</a>();</div>
|
||||
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span>  </div>
|
||||
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span>  <span class="keywordflow">return</span> *parameters.find(key)->second->GetValue();</div>
|
||||
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -994,11 +1013,11 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p>Will register an abbreviation (like -f for –force) </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00613">613</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00614"></a><span class="lineno"> 614</span> {</div>
|
||||
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span>  parameterAbreviations.insert(std::pair<std::string, std::string>(abbrev, target));</div>
|
||||
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00632">632</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00633"></a><span class="lineno"> 633</span> {</div>
|
||||
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span>  parameterAbreviations.insert(std::pair<std::string, std::string>(abbrev, target));</div>
|
||||
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -1031,12 +1050,12 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Will register a constraint for a parameter. </p>
|
||||
<p>IMPORTANT: Any parameter can only have ONE constraint. Applying a new one will overwrite the old one! Construct the <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> struct yourself to combine Require, TypeSafety and Incompatibilities! You can also use the <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> constructor! </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00644">644</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00645"></a><span class="lineno"> 645</span> {</div>
|
||||
<div class="line"><a name="l00646"></a><span class="lineno"> 646</span>  <span class="comment">// Magic syntax, wooo</span></div>
|
||||
<div class="line"><a name="l00647"></a><span class="lineno"> 647</span>  (parameterConstraints[key] = constraint).key = key;</div>
|
||||
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00663">663</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00664"></a><span class="lineno"> 664</span> {</div>
|
||||
<div class="line"><a name="l00665"></a><span class="lineno"> 665</span>  <span class="comment">// Magic syntax, wooo</span></div>
|
||||
<div class="line"><a name="l00666"></a><span class="lineno"> 666</span>  (parameterConstraints[key] = constraint).key = key;</div>
|
||||
<div class="line"><a name="l00667"></a><span class="lineno"> 667</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00668"></a><span class="lineno"> 668</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -1148,11 +1167,11 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p>Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsing, or not. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00657">657</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00658"></a><span class="lineno"> 658</span> {</div>
|
||||
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span>  this->crashOnFail = crashOnFail;</div>
|
||||
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00661"></a><span class="lineno"> 661</span> }</div>
|
||||
<p class="definition">Definition at line <a class="el" href="CmdArgsInterface_8cpp_source.html#l00676">676</a> of file <a class="el" href="CmdArgsInterface_8cpp_source.html">CmdArgsInterface.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><a name="l00677"></a><span class="lineno"> 677</span> {</div>
|
||||
<div class="line"><a name="l00678"></a><span class="lineno"> 678</span>  this->crashOnFail = crashOnFail;</div>
|
||||
<div class="line"><a name="l00679"></a><span class="lineno"> 679</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00680"></a><span class="lineno"> 680</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -1162,7 +1181,7 @@ Public Member Functions</h2></td></tr>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<div class="ttc" id="aclassHazelnp_1_1HazelnuppConstraintIncompatibleParameters_html"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html">Hazelnp::HazelnuppConstraintIncompatibleParameters</a></div><div class="ttdoc">Gets thrown when a parameter constrained to be incompatible with other parameters gets supplied along...</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00101">HazelnuppException.h:101</a></div></div>
|
||||
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_a58b81709e631cee5f3db3f3f48611fe9"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#a58b81709e631cee5f3db3f3f48611fe9">Hazelnp::CmdArgsInterface::HasAbbreviation</a></div><div class="ttdeci">bool HasAbbreviation(const std::string &abbrev) const</div><div class="ttdoc">Will check wether or not an abbreviation is registered.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00627">CmdArgsInterface.cpp:627</a></div></div>
|
||||
<div class="ttc" id="aclassHazelnp_1_1CmdArgsInterface_html_a58b81709e631cee5f3db3f3f48611fe9"><div class="ttname"><a href="classHazelnp_1_1CmdArgsInterface.html#a58b81709e631cee5f3db3f3f48611fe9">Hazelnp::CmdArgsInterface::HasAbbreviation</a></div><div class="ttdeci">bool HasAbbreviation(const std::string &abbrev) const</div><div class="ttdoc">Will check wether or not an abbreviation is registered.</div><div class="ttdef"><b>Definition:</b> <a href="CmdArgsInterface_8cpp_source.html#l00646">CmdArgsInterface.cpp:646</a></div></div>
|
||||
<div class="ttc" id="aclassHazelnp_1_1HazelnuppInvalidKeyException_html"><div class="ttname"><a href="classHazelnp_1_1HazelnuppInvalidKeyException.html">Hazelnp::HazelnuppInvalidKeyException</a></div><div class="ttdoc">Gets thrown when an non-existent key gets dereferenced.</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00029">HazelnuppException.h:29</a></div></div>
|
||||
<div class="ttc" id="aclassHazelnp_1_1HazelnuppException_html_aa86c415a0f2b4ea5f11892145d1ea83e"><div class="ttname"><a href="classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e">Hazelnp::HazelnuppException::What</a></div><div class="ttdeci">const std::string & What() const</div><div class="ttdoc">Will return an error message.</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00018">HazelnuppException.h:18</a></div></div>
|
||||
<div class="ttc" id="aclassHazelnp_1_1HazelnuppConstraintException_html"><div class="ttname"><a href="classHazelnp_1_1HazelnuppConstraintException.html">Hazelnp::HazelnuppConstraintException</a></div><div class="ttdoc">Gets thrown something bad happens because of parameter constraints.</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00047">HazelnuppException.h:47</a></div></div>
|
||||
@@ -1179,7 +1198,7 @@ Public Member Functions</h2></td></tr>
|
||||
<div class="ttc" id="anamespaceHazelnp_html_a7fb1e5ad9e2ecb6c0025beb19f11621b"><div class="ttname"><a href="namespaceHazelnp.html#a7fb1e5ad9e2ecb6c0025beb19f11621b">Hazelnp::DataTypeToString</a></div><div class="ttdeci">static std::string DataTypeToString(DATA_TYPE type)</div><div class="ttdef"><b>Definition:</b> <a href="DataType_8h_source.html#l00017">DataType.h:17</a></div></div>
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Sun Sep 5 2021 12:11:51 for Leonetienne/Hazelnupp by  <a href="http://www.doxygen.org/index.html">
|
||||
Generated on Sun Sep 5 2021 12:24:40 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