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 > |
< 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 = "STL class." alt = "" coords = "57,96,144,123" / >
< area shape = "rect" title = " " alt = "" coords = "131,185,318,212" / >
< 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:ab2a897c3044ae2d1a05952a804a3675b" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#ab2a897c3044ae2d1a05952a804a3675b" > ParamConstraint< / a > (const std::string & < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15" > key< / 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#ac07a0c0555431d4b1e0bc6afdba41329" > wantedType< / 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:ab2a897c3044ae2d1a05952a804a3675b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Whole constructor. < a href = "structHazelnp_1_1ParamConstraint.html#ab2a897c3044ae2d1a05952a804a3675b" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ab2a897c3044ae2d1a05952a804a3675b" > < 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:afbcc75c428381ab3a292d3f55945eb32" > < 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#afbcc75c428381ab3a292d3f55945eb32" > Require< / a > (const std::string & < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15" > key< / 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:afbcc75c428381ab3a292d3f55945eb32" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Constructs a require constraint. < a href = "structHazelnp_1_1ParamConstraint.html#afbcc75c428381ab3a292d3f55945eb32" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:afbcc75c428381ab3a292d3f55945eb32" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab85210bb37bbace962ff08fcccdafaf2" > < 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#ab85210bb37bbace962ff08fcccdafaf2" > TypeSafety< / a > (const std::string & < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15" > key< / a > , < a class = "el" href = "namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f" > DATA_TYPE< / a > < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329" > wantedType< / a > , bool < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac" > constrainType< / a > =true)< / td > < / tr >
< tr class = "memdesc:ab85210bb37bbace962ff08fcccdafaf2" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Constructs a type-safety constraint. < a href = "structHazelnp_1_1ParamConstraint.html#ab85210bb37bbace962ff08fcccdafaf2" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ab85210bb37bbace962ff08fcccdafaf2" > < 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:aac148076c5e0ab91c666f3343c30bd15" > < td class = "memItemLeft" align = "right" valign = "top" > std::string  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15" > key< / a > < / td > < / tr >
< tr class = "memdesc:aac148076c5e0ab91c666f3343c30bd15" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > The key of the parameter to constrain. < a href = "structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:aac148076c5e0ab91c666f3343c30bd15" > < td class = "memSeparator" colspan = "2" >   < / 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:ac07a0c0555431d4b1e0bc6afdba41329" > < 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#ac07a0c0555431d4b1e0bc6afdba41329" > wantedType< / a > = < a class = "el" href = "namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb" > DATA_TYPE::VOID< / a > < / td > < / tr >
< tr class = "memdesc:ac07a0c0555431d4b1e0bc6afdba41329" > < 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#ac07a0c0555431d4b1e0bc6afdba41329" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ac07a0c0555431d4b1e0bc6afdba41329" > < 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 >
< 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 = "ab2a897c3044ae2d1a05952a804a3675b" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab2a897c3044ae2d1a05952a804a3675b" > ◆ < / 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" > const std::string &   < / td >
< td class = "paramname" > < em > key< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / 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 > wantedType< / 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#l00038" > 38< / a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00039" > < / a > < span class = "lineno" > 39< / span >   :< / div >
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > 40< / span >   < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15" > key< / a > { < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15" > key< / a > },< / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac" > constrainType< / a > { < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac" > constrainType< / a > },< / div >
< div class = "line" > < a name = "l00042" > < / a > < span class = "lineno" > 42< / span >   < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329" > wantedType< / a > { < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329" > wantedType< / a > },< / div >
< div class = "line" > < a name = "l00043" > < / a > < span class = "lineno" > 43< / span >   < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7" > defaultValue< / a > { < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7" > defaultValue< / a > },< / div >
< div class = "line" > < a name = "l00044" > < / a > < span class = "lineno" > 44< / span >   < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c" > required< / a > { < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c" > required< / a > }< / div >
< div class = "line" > < a name = "l00045" > < / a > < span class = "lineno" > 45< / span >   {< / div >
< div class = "line" > < a name = "l00046" > < / a > < span class = "lineno" > 46< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > 47< / span >   }< / div >
< / div > <!-- fragment -->
< / div >
< / div >
< h2 class = "groupheader" > Member Function Documentation< / h2 >
< a id = "afbcc75c428381ab3a292d3f55945eb32" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#afbcc75c428381ab3a292d3f55945eb32" > ◆ < / 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::string &   < / td >
< td class = "paramname" > < em > key< / 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 > = < 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.key = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15" > key< / a > ;< / div >
< div class = "line" > < a name = "l00020" > < / a > < span class = "lineno" > 20< / span >   pc.defaultValue = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7" > defaultValue< / a > ;< / div >
< div class = "line" > < a name = "l00021" > < / a > < span class = "lineno" > 21< / span >   pc.required = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c" > required< / a > ;< / div >
< div class = "line" > < a name = "l00022" > < / a > < span class = "lineno" > 22< / span >   < / div >
< div class = "line" > < a name = "l00023" > < / a > < span class = "lineno" > 23< / span >   < span class = "keywordflow" > return< / span > pc;< / div >
< div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > 24< / span >   }< / div >
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "ab85210bb37bbace962ff08fcccdafaf2" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab85210bb37bbace962ff08fcccdafaf2" > ◆ < / 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" > const std::string &   < / td >
< td class = "paramname" > < em > key< / 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 > wantedType< / 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#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 = "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;< / div >
< div class = "line" > < a name = "l00030" > < / a > < span class = "lineno" > 30< / span >   pc.key = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15" > key< / a > ;< / div >
< div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > 31< / span >   pc.constrainType = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac" > constrainType< / a > ;< / div >
< div class = "line" > < a name = "l00032" > < / a > < span class = "lineno" > 32< / span >   pc.wantedType = < a class = "code" href = "structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329" > wantedType< / a > ;< / div >
< div class = "line" > < a name = "l00033" > < / a > < span class = "lineno" > 33< / span >   < / div >
< div class = "line" > < a name = "l00034" > < / a > < span class = "lineno" > 34< / span >   < span class = "keywordflow" > return< / span > pc;< / div >
< div class = "line" > < a name = "l00035" > < / a > < span class = "lineno" > 35< / span >   }< / div >
< / div > <!-- fragment -->
< / 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#l00054" > 54< / 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#l00062" > 62< / a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h< / a > .< / p >
< / div >
< / div >
< a id = "aac148076c5e0ab91c666f3343c30bd15" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aac148076c5e0ab91c666f3343c30bd15" > ◆ < / a > < / span > key< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::string Hazelnp::ParamConstraint::key< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > The key of the parameter to constrain. < / p >
< p class = "definition" > Definition at line < a class = "el" href = "ParamConstraint_8h_source.html#l00050" > 50< / 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#l00066" > 66< / a > of file < a class = "el" href = "ParamConstraint_8h_source.html" > ParamConstraint.h< / a > .< / p >
< / div >
< / div >
< a id = "ac07a0c0555431d4b1e0bc6afdba41329" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ac07a0c0555431d4b1e0bc6afdba41329" > ◆ < / a > < / span > wantedType< / 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::wantedType = < 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#l00057" > 57< / 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_ac07a0c0555431d4b1e0bc6afdba41329" > < div class = "ttname" > < a href = "structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329" > Hazelnp::ParamConstraint::wantedType< / a > < / div > < div class = "ttdeci" > DATA_TYPE wantedType< / div > < div class = "ttdoc" > Constrain the parameter to this value. Requires constrainType to be set to true.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "ParamConstraint_8h_source.html#l00057" > ParamConstraint.h:57< / a > < / div > < / div >
< div class = "ttc" id = "astructHazelnp_1_1ParamConstraint_html_a88a4a4c215723259c71853992d09acac" > < div class = "ttname" > < a href = "structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac" > Hazelnp::ParamConstraint::constrainType< / a > < / div > < div class = "ttdeci" > bool constrainType< / div > < div class = "ttdoc" > Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "ParamConstraint_8h_source.html#l00054" > ParamConstraint.h:54< / a > < / div > < / div >
< div class = "ttc" id = "astructHazelnp_1_1ParamConstraint_html_afa9e1b4378c9fa1b4a7b5b792c062cbe" > < div class = "ttname" > < a href = "structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe" > Hazelnp::ParamConstraint::ParamConstraint< / a > < / div > < div class = "ttdeci" > ParamConstraint()=default< / div > < div class = "ttdoc" > Empty constructor.< / div > < / div >
< div class = "ttc" id = "astructHazelnp_1_1ParamConstraint_html_aac148076c5e0ab91c666f3343c30bd15" > < div class = "ttname" > < a href = "structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15" > Hazelnp::ParamConstraint::key< / a > < / div > < div class = "ttdeci" > std::string key< / div > < div class = "ttdoc" > The key of the parameter to constrain.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "ParamConstraint_8h_source.html#l00050" > ParamConstraint.h:50< / a > < / div > < / div >
< div class = "ttc" id = "astructHazelnp_1_1ParamConstraint_html_a8ccf3ebecc2d9d0105e181814af2943c" > < div class = "ttname" > < a href = "structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c" > Hazelnp::ParamConstraint::required< / a > < / div > < div class = "ttdeci" > bool required< / div > < div class = "ttdoc" > If set to true, and no default value set, an error will be produced if this parameter is not supplied...< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "ParamConstraint_8h_source.html#l00066" > ParamConstraint.h:66< / a > < / div > < / div >
< div class = "ttc" id = "astructHazelnp_1_1ParamConstraint_html_a1d3a627b3a23fe0db3a368e51dbcd5a7" > < div class = "ttname" > < a href = "structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7" > Hazelnp::ParamConstraint::defaultValue< / a > < / div > < div class = "ttdeci" > std::vector< std::string > defaultValue< / div > < div class = "ttdoc" > The default value for this parameter.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "ParamConstraint_8h_source.html#l00062" > ParamConstraint.h:62< / a > < / div > < / div >
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2021-06-04 15:57:52 +02:00
Generated on Fri Jun 4 2021 15:57:42 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 >
