2021-06-03 13:43:05 +02:00
<!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 > |
2021-06-05 12:40:24 +02:00
< a href = "#friends" > Friends</ a > |
2021-06-03 13:43:05 +02:00
< 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" >
2021-09-05 12:12:03 +02:00
< area shape = "rect" title = " " alt = "" coords = "5,289,196,316" />
2021-06-05 12:40:24 +02:00
< area shape = "rect" title = " " alt = "" coords = "7,185,194,212" />
2021-06-03 13:43:05 +02:00
< 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 >
2021-09-05 12:57:10 +02:00
< tr class = "memitem:ac23b54cad8636b3f64a27b51161b8749" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint</ a >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html#ac23b54cad8636b3f64a27b51161b8749" > AddRequire</ a > (const std::initializer_list< 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:ac23b54cad8636b3f64a27b51161b8749" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Daisychain-method. < a href = "structHazelnp_1_1ParamConstraint.html#ac23b54cad8636b3f64a27b51161b8749" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:ac23b54cad8636b3f64a27b51161b8749" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ae057d0d8186c0a7936405096a58be981" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint</ a >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html#ae057d0d8186c0a7936405096a58be981" > AddTypeSafety</ a > (< a class = "el" href = "namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f" > DATA_TYPE</ a > < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a" > requiredType</ a > , bool < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac" > constrainType</ a > =true)</ td ></ tr >
< tr class = "memdesc:ae057d0d8186c0a7936405096a58be981" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Daisychain-method. < a href = "structHazelnp_1_1ParamConstraint.html#ae057d0d8186c0a7936405096a58be981" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:ae057d0d8186c0a7936405096a58be981" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2021-09-05 13:00:28 +02:00
< tr class = "memitem:ae335d099a2735b77239ad7eec5136991" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint</ a >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html#ae335d099a2735b77239ad7eec5136991" > AddIncompatibilities</ a > (const std::string & < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c" > incompatibleParameters</ a > )</ td ></ tr >
< tr class = "memdesc:ae335d099a2735b77239ad7eec5136991" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Daisychain-method. < a href = "structHazelnp_1_1ParamConstraint.html#ae335d099a2735b77239ad7eec5136991" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:ae335d099a2735b77239ad7eec5136991" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a207eead7df641c7741082687db654e55" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint</ a >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html#a207eead7df641c7741082687db654e55" > AddIncompatibilities</ a > (const std::initializer_list< std::string > & < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c" > incompatibleParameters</ a > )</ td ></ tr >
< tr class = "memdesc:a207eead7df641c7741082687db654e55" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Daisychain-method. < a href = "structHazelnp_1_1ParamConstraint.html#a207eead7df641c7741082687db654e55" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a207eead7df641c7741082687db654e55" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2021-09-05 12:12:03 +02:00
< tr class = "memitem:aea39497a14939fa887c236ee1e755cb3" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html#aea39497a14939fa887c236ee1e755cb3" > ParamConstraint</ a > (bool < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac" > constrainType</ a > , < a class = "el" href = "namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f" > DATA_TYPE</ a > < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a" > requiredType</ a > , const std::initializer_list< 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 > , const std::initializer_list< std::string > & < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c" > incompatibleParameters</ a > )</ td ></ tr >
< tr class = "memdesc:aea39497a14939fa887c236ee1e755cb3" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Whole constructor. < a href = "structHazelnp_1_1ParamConstraint.html#aea39497a14939fa887c236ee1e755cb3" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:aea39497a14939fa887c236ee1e755cb3" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2021-06-03 13:43:05 +02:00
</ 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 >
2021-09-05 12:12:03 +02:00
< tr class = "memitem:a8a7e5d7ddffc3cfbb54ac6823dd7eded" >< 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#a8a7e5d7ddffc3cfbb54ac6823dd7eded" > Require</ a > (const std::initializer_list< 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:a8a7e5d7ddffc3cfbb54ac6823dd7eded" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Constructs a require constraint. < a href = "structHazelnp_1_1ParamConstraint.html#a8a7e5d7ddffc3cfbb54ac6823dd7eded" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a8a7e5d7ddffc3cfbb54ac6823dd7eded" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2021-06-06 15:32:19 +02:00
< 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 >
2021-09-05 12:12:03 +02:00
< tr class = "memitem:a20fa41460106b5327a51114f8a187871" >< 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#a20fa41460106b5327a51114f8a187871" > Incompatibility</ a > (const std::initializer_list< std::string > & < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c" > incompatibleParameters</ a > )</ td ></ tr >
< tr class = "memdesc:a20fa41460106b5327a51114f8a187871" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Constructs an incompatibility constraint. < a href = "structHazelnp_1_1ParamConstraint.html#a20fa41460106b5327a51114f8a187871" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a20fa41460106b5327a51114f8a187871" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a6bb383f8945fb99cbd2370fd9a4bc6fc" >< 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#a6bb383f8945fb99cbd2370fd9a4bc6fc" > Incompatibility</ a > (const std::string & < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c" > incompatibleParameters</ a > )</ td ></ tr >
< tr class = "memdesc:a6bb383f8945fb99cbd2370fd9a4bc6fc" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Constructs an incompatibility constraint. < a href = "structHazelnp_1_1ParamConstraint.html#a6bb383f8945fb99cbd2370fd9a4bc6fc" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a6bb383f8945fb99cbd2370fd9a4bc6fc" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2021-06-03 13:43:05 +02:00
</ 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 >
2021-06-06 15:32:19 +02:00
< 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 >
2021-06-03 13:43:05 +02:00
< 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 >
2021-09-05 12:12:03 +02:00
< tr class = "memitem:acf45734665238b51483f77701039108c" >< 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#acf45734665238b51483f77701039108c" > incompatibleParameters</ a ></ td ></ tr >
< tr class = "memdesc:acf45734665238b51483f77701039108c" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Parameters that are incompatible with this parameter. < a href = "structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:acf45734665238b51483f77701039108c" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2021-06-05 12:40:24 +02:00
</ table >< table class = "memberdecls" >
< tr class = "heading" >< td colspan = "2" >< h2 class = "groupheader" >< a name = "friends" ></ a >
Friends</ h2 ></ td ></ tr >
2021-06-08 14:02:49 +02:00
< tr class = "memitem:a01773a2aa9845fd639f63468586b67b0" >< td class = "memItemLeft" align = "right" valign = "top" > class  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html#a01773a2aa9845fd639f63468586b67b0" > CmdArgsInterface</ a ></ td ></ tr >
< tr class = "separator:a01773a2aa9845fd639f63468586b67b0" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2021-06-03 13:43:05 +02:00
</ 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 >
2021-09-05 12:12:03 +02:00
< a id = "aea39497a14939fa887c236ee1e755cb3" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#aea39497a14939fa887c236ee1e755cb3" > ◆ </ a ></ span > ParamConstraint() < span class = "overload" > [2/2]</ span ></ h2 >
2021-06-03 13:43:05 +02:00
< 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 >
2021-06-06 15:32:19 +02:00
< td class = "paramname" >< em > requiredType</ em > , </ td >
2021-06-03 13:43:05 +02:00
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
2021-09-05 12:12:03 +02:00
< td class = "paramtype" > const std::initializer_list< std::string > &  </ td >
2021-06-03 13:43:05 +02:00
< td class = "paramname" >< em > defaultValue</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > bool  </ td >
2021-09-05 12:12:03 +02:00
< td class = "paramname" >< em > required</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > const std::initializer_list< std::string > &  </ td >
< td class = "paramname" >< em > incompatibleParameters</ em >   </ td >
2021-06-03 13:43:05 +02:00
</ 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 >
2021-09-05 13:00:28 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00100" > 100</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
< div class = "fragment" >< div class = "line" >< a name = "l00101" ></ a >< span class = "lineno" > 101</ span >   :</ div >
< div class = "line" >< a name = "l00102" ></ a >< span class = "lineno" > 102</ 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 = "l00103" ></ a >< span class = "lineno" > 103</ 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 = "l00104" ></ a >< span class = "lineno" > 104</ 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 = "l00105" ></ a >< span class = "lineno" > 105</ 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 = "l00106" ></ a >< span class = "lineno" > 106</ span >   < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c" > incompatibleParameters</ a > {< a class = "code" href = "structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c" > incompatibleParameters</ a > }</ div >
< div class = "line" >< a name = "l00107" ></ a >< span class = "lineno" > 107</ span >   {</ div >
< div class = "line" >< a name = "l00108" ></ a >< span class = "lineno" > 108</ span >   < span class = "keywordflow" > return</ span > ;</ div >
< div class = "line" >< a name = "l00109" ></ a >< span class = "lineno" > 109</ span >   }</ div >
2021-06-03 13:43:05 +02:00
</ div > <!-- fragment -->
</ div >
</ div >
< h2 class = "groupheader" > Member Function Documentation</ h2 >
2021-09-05 13:00:28 +02:00
< a id = "a207eead7df641c7741082687db654e55" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a207eead7df641c7741082687db654e55" > ◆ </ a ></ span > AddIncompatibilities() < span class = "overload" > [1/2]</ span ></ h2 >
2021-09-05 12:57:10 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2021-09-05 13:00:28 +02:00
< td class = "memname" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint</ a > Hazelnp::ParamConstraint::AddIncompatibilities </ td >
< td > (</ td >
< td class = "paramtype" > const std::initializer_list< std::string > &  </ td >
< td class = "paramname" >< em > incompatibleParameters</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ td >
< td class = "mlabels-right" >
< span class = "mlabels" >< span class = "mlabel" > inline</ span ></ span > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Daisychain-method. </ p >
< p > Will add a the "incompatiblity" aspect. < br />
This means, that the following parameters are NOT compatible with this one and will throw an error if passed together. </ p >
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00091" > 91</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
< div class = "fragment" >< div class = "line" >< a name = "l00092" ></ a >< span class = "lineno" > 92</ span >   {</ div >
< div class = "line" >< a name = "l00093" ></ a >< span class = "lineno" > 93</ span >   < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe" > ParamConstraint</ a > pc = *< span class = "keyword" > this</ span > ;</ div >
< div class = "line" >< a name = "l00094" ></ a >< span class = "lineno" > 94</ span >   pc.incompatibleParameters = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c" > incompatibleParameters</ a > ;</ div >
< div class = "line" >< a name = "l00095" ></ a >< span class = "lineno" > 95</ span >   </ div >
< div class = "line" >< a name = "l00096" ></ a >< span class = "lineno" > 96</ span >   < span class = "keywordflow" > return</ span > pc;</ div >
< div class = "line" >< a name = "l00097" ></ a >< span class = "lineno" > 97</ span >   }</ div >
</ div > <!-- fragment -->
</ div >
</ div >
< a id = "ae335d099a2735b77239ad7eec5136991" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ae335d099a2735b77239ad7eec5136991" > ◆ </ a ></ span > AddIncompatibilities() < 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" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint</ a > Hazelnp::ParamConstraint::AddIncompatibilities </ td >
2021-09-05 12:57:10 +02:00
< td > (</ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > incompatibleParameters</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ td >
< td class = "mlabels-right" >
< span class = "mlabels" >< span class = "mlabel" > inline</ span ></ span > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Daisychain-method. </ p >
< p > Will add a the "incompatiblity" aspect. < br />
This means, that the following parameters are NOT compatible with this one and will throw an error if passed together. Syntactical-sugar proxy method that will convert the lonely string to an initializer list for you :3 </ p >
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00081" > 81</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
< div class = "fragment" >< div class = "line" >< a name = "l00082" ></ a >< span class = "lineno" > 82</ span >   {</ div >
< div class = "line" >< a name = "l00083" ></ a >< span class = "lineno" > 83</ span >   < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe" > ParamConstraint</ a > pc = *< span class = "keyword" > this</ span > ;</ div >
< div class = "line" >< a name = "l00084" ></ a >< span class = "lineno" > 84</ span >   pc.incompatibleParameters = { < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c" > incompatibleParameters</ a > };</ div >
< div class = "line" >< a name = "l00085" ></ a >< span class = "lineno" > 85</ span >   </ div >
< div class = "line" >< a name = "l00086" ></ a >< span class = "lineno" > 86</ span >   < span class = "keywordflow" > return</ span > pc;</ div >
< div class = "line" >< a name = "l00087" ></ a >< span class = "lineno" > 87</ span >   }</ div >
</ div > <!-- fragment -->
</ div >
</ div >
< a id = "ac23b54cad8636b3f64a27b51161b8749" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ac23b54cad8636b3f64a27b51161b8749" > ◆ </ a ></ span > AddRequire()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint</ a > Hazelnp::ParamConstraint::AddRequire </ td >
< td > (</ td >
< td class = "paramtype" > const std::initializer_list< 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 > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Daisychain-method. </ p >
< p > Will add a the "required-argument" aspect. < br />
Think of the default value like of a list ofparameters. Like {"--width", "800"} </ p >
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00027" > 27</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
< div class = "fragment" >< div class = "line" >< a name = "l00027" ></ a >< span class = "lineno" > 27</ span >   {}, < span class = "keywordtype" > bool</ span > < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c" > required</ a > = < span class = "keyword" > true</ span > )</ div >
< div class = "line" >< a name = "l00028" ></ a >< span class = "lineno" > 28</ span >   {</ div >
< div class = "line" >< a name = "l00029" ></ a >< span class = "lineno" > 29</ span >   < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe" > ParamConstraint</ a > pc = *< span class = "keyword" > this</ span > ;</ div >
< div class = "line" >< a name = "l00030" ></ a >< span class = "lineno" > 30</ span >   pc.defaultValue = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7" > defaultValue</ a > ;</ div >
< div class = "line" >< a name = "l00031" ></ a >< span class = "lineno" > 31</ span >   pc.required = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c" > required</ a > ;</ div >
< div class = "line" >< a name = "l00032" ></ a >< span class = "lineno" > 32</ span >   </ div >
< div class = "line" >< a name = "l00033" ></ a >< span class = "lineno" > 33</ span >   < span class = "keywordflow" > return</ span > pc;</ div >
< div class = "line" >< a name = "l00034" ></ a >< span class = "lineno" > 34</ span >   }</ div >
</ div > <!-- fragment -->
</ div >
</ div >
< a id = "ae057d0d8186c0a7936405096a58be981" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ae057d0d8186c0a7936405096a58be981" > ◆ </ a ></ span > AddTypeSafety()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" >< a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint</ a > Hazelnp::ParamConstraint::AddTypeSafety </ td >
< td > (</ td >
< td class = "paramtype" >< a class = "el" href = "namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f" > DATA_TYPE</ a >   </ 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 > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Daisychain-method. </ p >
< p > Will add a the "type-safety" aspect. < br />
Constructs a type-safety constraint </ p >
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00048" > 48</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
< div class = "fragment" >< div class = "line" >< a name = "l00049" ></ a >< span class = "lineno" > 49</ span >   {</ div >
< div class = "line" >< a name = "l00050" ></ a >< span class = "lineno" > 50</ span >   < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe" > ParamConstraint</ a > pc = *< span class = "keyword" > this</ span > ;</ div >
< div class = "line" >< a name = "l00051" ></ a >< span class = "lineno" > 51</ span >   pc.constrainType = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac" > constrainType</ a > ;</ div >
< div class = "line" >< a name = "l00052" ></ a >< span class = "lineno" > 52</ span >   pc.requiredType = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a" > requiredType</ a > ;</ div >
< div class = "line" >< a name = "l00053" ></ a >< span class = "lineno" > 53</ span >   </ div >
< div class = "line" >< a name = "l00054" ></ a >< span class = "lineno" > 54</ span >   < span class = "keywordflow" > return</ span > pc;</ div >
< div class = "line" >< a name = "l00055" ></ a >< span class = "lineno" > 55</ span >   }</ div >
</ div > <!-- fragment -->
</ div >
</ div >
2021-09-05 12:12:03 +02:00
< a id = "a20fa41460106b5327a51114f8a187871" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a20fa41460106b5327a51114f8a187871" > ◆ </ a ></ span > Incompatibility() < 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" > static < a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint</ a > Hazelnp::ParamConstraint::Incompatibility </ td >
< td > (</ td >
< td class = "paramtype" > const std::initializer_list< std::string > &  </ td >
< td class = "paramname" >< em > incompatibleParameters</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ td >
< td class = "mlabels-right" >
< span class = "mlabels" >< span class = "mlabel" > inline</ span >< span class = "mlabel" > static</ span ></ span > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Constructs an incompatibility constraint. </ p >
< p > This means, that the following parameters are NOT compatible with this one and will throw an error if passed together </ p >
2021-09-05 12:57:10 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00059" > 59</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
< div class = "fragment" >< div class = "line" >< a name = "l00060" ></ a >< span class = "lineno" > 60</ span >   {</ div >
< div class = "line" >< a name = "l00061" ></ a >< span class = "lineno" > 61</ span >   < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe" > ParamConstraint</ a > pc;</ div >
< div class = "line" >< a name = "l00062" ></ a >< span class = "lineno" > 62</ span >   pc.incompatibleParameters = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c" > incompatibleParameters</ a > ;</ div >
< div class = "line" >< a name = "l00063" ></ a >< span class = "lineno" > 63</ span >   </ div >
< div class = "line" >< a name = "l00064" ></ a >< span class = "lineno" > 64</ span >   < span class = "keywordflow" > return</ span > pc;</ div >
< div class = "line" >< a name = "l00065" ></ a >< span class = "lineno" > 65</ span >   }</ div >
2021-09-05 12:12:03 +02:00
</ div > <!-- fragment -->
</ div >
</ div >
< a id = "a6bb383f8945fb99cbd2370fd9a4bc6fc" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a6bb383f8945fb99cbd2370fd9a4bc6fc" > ◆ </ a ></ span > Incompatibility() < 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" > static < a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint</ a > Hazelnp::ParamConstraint::Incompatibility </ td >
< td > (</ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > incompatibleParameters</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ td >
< td class = "mlabels-right" >
< span class = "mlabels" >< span class = "mlabel" > inline</ span >< span class = "mlabel" > static</ span ></ span > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Constructs an incompatibility constraint. </ p >
< p > This means, that the following parameters are NOT compatible with this one and will throw an error if passed together. Syntactical-sugar proxy method that will convert the lonely string to an initializer list for you :3 </ p >
2021-09-05 12:57:10 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00070" > 70</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
< div class = "fragment" >< div class = "line" >< a name = "l00071" ></ a >< span class = "lineno" > 71</ span >   {</ div >
< div class = "line" >< a name = "l00072" ></ a >< span class = "lineno" > 72</ span >   < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe" > ParamConstraint</ a > pc;</ div >
< div class = "line" >< a name = "l00073" ></ a >< span class = "lineno" > 73</ span >   pc.incompatibleParameters = { < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c" > incompatibleParameters</ a > };</ div >
< div class = "line" >< a name = "l00074" ></ a >< span class = "lineno" > 74</ span >   </ div >
< div class = "line" >< a name = "l00075" ></ a >< span class = "lineno" > 75</ span >   < span class = "keywordflow" > return</ span > pc;</ div >
< div class = "line" >< a name = "l00076" ></ a >< span class = "lineno" > 76</ span >   }</ div >
2021-09-05 12:12:03 +02:00
</ div > <!-- fragment -->
</ div >
</ div >
< a id = "a8a7e5d7ddffc3cfbb54ac6823dd7eded" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a8a7e5d7ddffc3cfbb54ac6823dd7eded" > ◆ </ a ></ span > Require()</ h2 >
2021-06-03 13:43:05 +02:00
< 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 >
2021-09-05 12:12:03 +02:00
< td class = "paramtype" > const std::initializer_list< std::string > &  </ td >
2021-06-03 13:43:05 +02:00
< 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 >
2021-09-05 12:12:03 +02:00
< 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 >
2021-06-03 13:43:05 +02:00
< 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 >
2021-06-05 12:40:24 +02:00
< 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 >
2021-06-03 13:43:05 +02:00
</ div > <!-- fragment -->
</ div >
</ div >
2021-06-06 15:32:19 +02:00
< a id = "a7df61dbc8dbaff4bc596fdf2c0532d5b" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a7df61dbc8dbaff4bc596fdf2c0532d5b" > ◆ </ a ></ span > TypeSafety()</ h2 >
2021-06-03 13:43:05 +02:00
< 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 >
2021-06-06 15:32:19 +02:00
< td class = "paramname" >< em > requiredType</ em > , </ td >
2021-06-03 13:43:05 +02:00
</ 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 >
2021-09-05 12:57:10 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00037" > 37</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
< div class = "fragment" >< div class = "line" >< a name = "l00038" ></ a >< span class = "lineno" > 38</ span >   {</ div >
< div class = "line" >< a name = "l00039" ></ a >< span class = "lineno" > 39</ span >   < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe" > ParamConstraint</ a > pc;</ div >
< div class = "line" >< a name = "l00040" ></ a >< span class = "lineno" > 40</ span >   pc.constrainType = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac" > constrainType</ a > ;</ div >
< div class = "line" >< a name = "l00041" ></ a >< span class = "lineno" > 41</ span >   pc.requiredType = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a" > requiredType</ a > ;</ div >
< div class = "line" >< a name = "l00042" ></ a >< span class = "lineno" > 42</ span >   </ div >
< div class = "line" >< a name = "l00043" ></ a >< span class = "lineno" > 43</ span >   < span class = "keywordflow" > return</ span > pc;</ div >
< div class = "line" >< a name = "l00044" ></ a >< span class = "lineno" > 44</ span >   }</ div >
2021-06-03 13:43:05 +02:00
</ div > <!-- fragment -->
2021-06-05 12:40:24 +02:00
</ div >
</ div >
< h2 class = "groupheader" > Friends And Related Function Documentation</ h2 >
2021-06-08 14:02:49 +02:00
< a id = "a01773a2aa9845fd639f63468586b67b0" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a01773a2aa9845fd639f63468586b67b0" > ◆ </ a ></ span > CmdArgsInterface</ h2 >
2021-06-05 12:40:24 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2021-06-08 14:02:49 +02:00
< td class = "memname" > friend class < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html" > CmdArgsInterface</ a ></ td >
2021-06-05 12:40:24 +02:00
</ tr >
</ table >
</ td >
< td class = "mlabels-right" >
< span class = "mlabels" >< span class = "mlabel" > friend</ span ></ span > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
2021-09-05 13:00:28 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00135" > 135</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
2021-06-05 12:40:24 +02:00
2021-06-03 13:43:05 +02:00
</ 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 >
2021-09-05 13:00:28 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00113" > 113</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
2021-06-03 13:43:05 +02:00
</ 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 >
2021-09-05 13:00:28 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00121" > 121</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
2021-09-05 12:12:03 +02:00
</ div >
</ div >
< a id = "acf45734665238b51483f77701039108c" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#acf45734665238b51483f77701039108c" > ◆ </ a ></ span > incompatibleParameters</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::vector< std::string> Hazelnp::ParamConstraint::incompatibleParameters</ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Parameters that are incompatible with this parameter. </ p >
2021-09-05 13:00:28 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00128" > 128</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
2021-06-03 13:43:05 +02:00
</ 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 >
2021-09-05 13:00:28 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00125" > 125</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
2021-06-03 13:43:05 +02:00
</ div >
</ div >
2021-06-06 15:32:19 +02:00
< a id = "a203b6fd1b9788a529aa0f15fe94fd24a" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a203b6fd1b9788a529aa0f15fe94fd24a" > ◆ </ a ></ span > requiredType</ h2 >
2021-06-03 13:43:05 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2021-06-06 15:32:19 +02:00
< 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 >
2021-06-03 13:43:05 +02:00
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Constrain the parameter to this value. Requires < code > constrainType</ code > to be set to true. </ p >
2021-09-05 13:00:28 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00116" > 116</ a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h</ a > .</ p >
2021-06-03 13:43:05 +02:00
</ 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 -->
2021-09-05 13:00:28 +02:00
< div class = "ttc" id = "astructHazelnp_1_1ParamConstraint_html_a203b6fd1b9788a529aa0f15fe94fd24a" >< div class = "ttname" >< a href = "structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a" > Hazelnp::ParamConstraint::requiredType</ a ></ div >< div class = "ttdeci" > DATA_TYPE requiredType</ div >< div class = "ttdoc" > Constrain the parameter to this value. Requires constrainType to be set to true.</ div >< div class = "ttdef" >< b > Definition:</ b > < a href = "ParamConstraint_8h_source.html#l00116" > ParamConstraint.h:116</ a ></ div ></ div >
< div class = "ttc" id = "astructHazelnp_1_1ParamConstraint_html_a88a4a4c215723259c71853992d09acac" >< div class = "ttname" >< a href = "structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac" > Hazelnp::ParamConstraint::constrainType</ a ></ div >< div class = "ttdeci" > bool constrainType</ div >< div class = "ttdoc" > Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...</ div >< div class = "ttdef" >< b > Definition:</ b > < a href = "ParamConstraint_8h_source.html#l00113" > ParamConstraint.h:113</ a ></ div ></ div >
2021-06-03 13:43:05 +02:00
< 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 >
2021-09-05 13:00:28 +02:00
< div class = "ttc" id = "astructHazelnp_1_1ParamConstraint_html_acf45734665238b51483f77701039108c" >< div class = "ttname" >< a href = "structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c" > Hazelnp::ParamConstraint::incompatibleParameters</ a ></ div >< div class = "ttdeci" > std::vector< std::string > incompatibleParameters</ div >< div class = "ttdoc" > Parameters that are incompatible with this parameter.</ div >< div class = "ttdef" >< b > Definition:</ b > < a href = "ParamConstraint_8h_source.html#l00128" > ParamConstraint.h:128</ a ></ div ></ div >
< div class = "ttc" id = "astructHazelnp_1_1ParamConstraint_html_a8ccf3ebecc2d9d0105e181814af2943c" >< div class = "ttname" >< a href = "structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c" > Hazelnp::ParamConstraint::required</ a ></ div >< div class = "ttdeci" > bool required</ div >< div class = "ttdoc" > If set to true, and no default value set, an error will be produced if this parameter is not supplied...</ div >< div class = "ttdef" >< b > Definition:</ b > < a href = "ParamConstraint_8h_source.html#l00125" > ParamConstraint.h:125</ a ></ div ></ div >
< div class = "ttc" id = "astructHazelnp_1_1ParamConstraint_html_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#l00121" > ParamConstraint.h:121</ a ></ div ></ div >
2021-06-03 13:43:05 +02:00
<!-- start footer part -->
< hr class = "footer" />< address class = "footer" >< small >
2021-09-05 13:00:28 +02:00
Generated on Sun Sep 5 2021 13:00:17 for Leonetienne/Hazelnupp by   < a href = "http://www.doxygen.org/index.html" >
2021-06-03 13:43:05 +02:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" />
</ a > 1.8.17
</ small ></ address >
</ body >
</ html >