448 lines
29 KiB
HTML
448 lines
29 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Leonetienne/Hazelnupp: Hazelnp::ParamConstraint Struct Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/x-mathjax-config">
|
|
MathJax.Hub.Config({
|
|
extensions: ["tex2jax.js"],
|
|
jax: ["input/TeX","output/HTML-CSS"],
|
|
});
|
|
</script>
|
|
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="nupp_small.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Leonetienne/Hazelnupp
|
|
</div>
|
|
<div id="projectbrief">Simple, easy to use, command line parameter interface</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceHazelnp.html">Hazelnp</a></li><li class="navelem"><a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="structHazelnp_1_1ParamConstraint-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Hazelnp::ParamConstraint Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for Hazelnp::ParamConstraint:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="structHazelnp_1_1ParamConstraint__coll__graph.png" border="0" usemap="#Hazelnp_1_1ParamConstraint_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="Hazelnp_1_1ParamConstraint_coll__map" id="Hazelnp_1_1ParamConstraint_coll__map">
|
|
<area shape="rect" title=" " alt="" coords="5,275,196,301"/>
|
|
<area shape="rect" title=" " alt="" coords="7,185,194,212"/>
|
|
<area shape="rect" title="STL class." alt="" coords="57,96,144,123"/>
|
|
<area shape="rect" title="STL class." alt="" coords="31,5,170,47"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:afa9e1b4378c9fa1b4a7b5b792c062cbe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> ()=default</td></tr>
|
|
<tr class="memdesc:afa9e1b4378c9fa1b4a7b5b792c062cbe"><td class="mdescLeft"> </td><td class="mdescRight">Empty constructor. <a href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">More...</a><br /></td></tr>
|
|
<tr class="separator:afa9e1b4378c9fa1b4a7b5b792c062cbe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af261299848888fb106f5ba3b4c5a72ba"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#af261299848888fb106f5ba3b4c5a72ba">ParamConstraint</a> (bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>, <a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="el" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>, const std::vector< std::string > &<a class="el" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>, bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>)</td></tr>
|
|
<tr class="memdesc:af261299848888fb106f5ba3b4c5a72ba"><td class="mdescLeft"> </td><td class="mdescRight">Whole constructor. <a href="structHazelnp_1_1ParamConstraint.html#af261299848888fb106f5ba3b4c5a72ba">More...</a><br /></td></tr>
|
|
<tr class="separator:af261299848888fb106f5ba3b4c5a72ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a926e12fcb2fd0d031452c4bcc950bd6c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a926e12fcb2fd0d031452c4bcc950bd6c">Require</a> (const std::vector< std::string > &<a class="el" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>={}, bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>=true)</td></tr>
|
|
<tr class="memdesc:a926e12fcb2fd0d031452c4bcc950bd6c"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a require constraint. <a href="structHazelnp_1_1ParamConstraint.html#a926e12fcb2fd0d031452c4bcc950bd6c">More...</a><br /></td></tr>
|
|
<tr class="separator:a926e12fcb2fd0d031452c4bcc950bd6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7df61dbc8dbaff4bc596fdf2c0532d5b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a7df61dbc8dbaff4bc596fdf2c0532d5b">TypeSafety</a> (<a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="el" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>, bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>=true)</td></tr>
|
|
<tr class="memdesc:a7df61dbc8dbaff4bc596fdf2c0532d5b"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a type-safety constraint. <a href="structHazelnp_1_1ParamConstraint.html#a7df61dbc8dbaff4bc596fdf2c0532d5b">More...</a><br /></td></tr>
|
|
<tr class="separator:a7df61dbc8dbaff4bc596fdf2c0532d5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a88a4a4c215723259c71853992d09acac"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> = false</td></tr>
|
|
<tr class="memdesc:a88a4a4c215723259c71853992d09acac"><td class="mdescLeft"> </td><td class="mdescRight">Should this parameter be forced to be of a certain type? <br />
|
|
Remember to set <code>constrainTo</code> to the wanted type. <a href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">More...</a><br /></td></tr>
|
|
<tr class="separator:a88a4a4c215723259c71853992d09acac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a203b6fd1b9788a529aa0f15fe94fd24a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a> = <a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a></td></tr>
|
|
<tr class="memdesc:a203b6fd1b9788a529aa0f15fe94fd24a"><td class="mdescLeft"> </td><td class="mdescRight">Constrain the parameter to this value. Requires <code>constrainType</code> to be set to true. <a href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">More...</a><br /></td></tr>
|
|
<tr class="separator:a203b6fd1b9788a529aa0f15fe94fd24a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d3a627b3a23fe0db3a368e51dbcd5a7"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a></td></tr>
|
|
<tr class="memdesc:a1d3a627b3a23fe0db3a368e51dbcd5a7"><td class="mdescLeft"> </td><td class="mdescRight">The default value for this parameter. <a href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">More...</a><br /></td></tr>
|
|
<tr class="separator:a1d3a627b3a23fe0db3a368e51dbcd5a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ccf3ebecc2d9d0105e181814af2943c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> = false</td></tr>
|
|
<tr class="memdesc:a8ccf3ebecc2d9d0105e181814af2943c"><td class="mdescLeft"> </td><td class="mdescRight">If set to true, and no default value set, an error will be produced if this parameter is not supplied by the user. <a href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">More...</a><br /></td></tr>
|
|
<tr class="separator:a8ccf3ebecc2d9d0105e181814af2943c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a0356cbb5056c61cac4a065a59002cb76"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a0356cbb5056c61cac4a065a59002cb76">Hazelnupp</a></td></tr>
|
|
<tr class="separator:a0356cbb5056c61cac4a065a59002cb76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock">
|
|
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00008">8</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="afa9e1b4378c9fa1b4a7b5b792c062cbe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa9e1b4378c9fa1b4a7b5b792c062cbe">◆ </a></span>ParamConstraint() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Hazelnp::ParamConstraint::ParamConstraint </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Empty constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af261299848888fb106f5ba3b4c5a72ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af261299848888fb106f5ba3b4c5a72ba">◆ </a></span>ParamConstraint() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Hazelnp::ParamConstraint::ParamConstraint </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>constrainType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> </td>
|
|
<td class="paramname"><em>requiredType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< std::string > & </td>
|
|
<td class="paramname"><em>defaultValue</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>required</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Whole constructor. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00036">36</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
|
|
<div class="fragment"><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="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> },</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a> },</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</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="l00041"></a><span class="lineno"> 41</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="l00042"></a><span class="lineno"> 42</span>  {</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a926e12fcb2fd0d031452c4bcc950bd6c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a926e12fcb2fd0d031452c4bcc950bd6c">◆ </a></span>Require()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> Hazelnp::ParamConstraint::Require </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< std::string > & </td>
|
|
<td class="paramname"><em>defaultValue</em> = <code>{}</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>required</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs a require constraint. </p>
|
|
<p><br />
|
|
Think of the default value like of a list ofparameters. Like {"--width", "800"} </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00016">16</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  {}, <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#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc;</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  pc.defaultValue = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>;</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  pc.required = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>;</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordflow">return</span> pc;</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a7df61dbc8dbaff4bc596fdf2c0532d5b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7df61dbc8dbaff4bc596fdf2c0532d5b">◆ </a></span>TypeSafety()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> Hazelnp::ParamConstraint::TypeSafety </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> </td>
|
|
<td class="paramname"><em>requiredType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>constrainType</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs a type-safety constraint. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00026">26</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  {</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc;</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  pc.constrainType = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  pc.requiredType = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </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><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Function Documentation</h2>
|
|
<a id="a0356cbb5056c61cac4a065a59002cb76"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0356cbb5056c61cac4a065a59002cb76">◆ </a></span>Hazelnupp</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">friend class <a class="el" href="classHazelnp_1_1Hazelnupp.html">Hazelnupp</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00067">67</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a88a4a4c215723259c71853992d09acac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a88a4a4c215723259c71853992d09acac">◆ </a></span>constrainType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Hazelnp::ParamConstraint::constrainType = false</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Should this parameter be forced to be of a certain type? <br />
|
|
Remember to set <code>constrainTo</code> to the wanted type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00048">48</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1d3a627b3a23fe0db3a368e51dbcd5a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d3a627b3a23fe0db3a368e51dbcd5a7">◆ </a></span>defaultValue</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<std::string> Hazelnp::ParamConstraint::defaultValue</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The default value for this parameter. </p>
|
|
<p><br />
|
|
Gets applied if this parameter was not given. <br />
|
|
Think of this like a list of parameters. Like {"--width", "800"} </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00056">56</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8ccf3ebecc2d9d0105e181814af2943c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8ccf3ebecc2d9d0105e181814af2943c">◆ </a></span>required</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Hazelnp::ParamConstraint::required = false</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>If set to true, and no default value set, an error will be produced if this parameter is not supplied by the user. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00060">60</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a203b6fd1b9788a529aa0f15fe94fd24a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a203b6fd1b9788a529aa0f15fe94fd24a">◆ </a></span>requiredType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> Hazelnp::ParamConstraint::requiredType = <a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constrain the parameter to this value. Requires <code>constrainType</code> to be set to true. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00051">51</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>Hazelnupp/<a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a203b6fd1b9788a529aa0f15fe94fd24a"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">Hazelnp::ParamConstraint::requiredType</a></div><div class="ttdeci">DATA_TYPE requiredType</div><div class="ttdoc">Constrain the parameter to this value. Requires constrainType to be set to true.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00051">ParamConstraint.h:51</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#l00048">ParamConstraint.h:48</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_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#l00060">ParamConstraint.h:60</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#l00056">ParamConstraint.h:56</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sun Jun 6 2021 15:32:08 for Leonetienne/Hazelnupp by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|