2021-06-08 14:02:49 +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::CmdArgsInterface Class 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 = "classHazelnp_1_1CmdArgsInterface.html" > CmdArgsInterface< / a > < / li > < / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "classHazelnp_1_1CmdArgsInterface-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > Hazelnp::CmdArgsInterface Class Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > The main class to interface with.
< a href = "classHazelnp_1_1CmdArgsInterface.html#details" > More...< / a > < / p >
< p > < code > #include < < a class = "el" href = "CmdArgsInterface_8h_source.html" > CmdArgsInterface.h< / a > > < / code > < / p >
< 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:aa1189c249bf0d8a4fbd5fb8f03a30212" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#aa1189c249bf0d8a4fbd5fb8f03a30212" > CmdArgsInterface< / a > ()< / td > < / tr >
< tr class = "separator:aa1189c249bf0d8a4fbd5fb8f03a30212" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ad79ff83ead06900eb7b45d6c563703d9" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#ad79ff83ead06900eb7b45d6c563703d9" > CmdArgsInterface< / a > (const int argc, const char *const *argv)< / td > < / tr >
< tr class = "separator:ad79ff83ead06900eb7b45d6c563703d9" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aadc75b3b6c9662cfbd4a936468d50466" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#aadc75b3b6c9662cfbd4a936468d50466" > ~CmdArgsInterface< / a > ()< / td > < / tr >
< tr class = "separator:aadc75b3b6c9662cfbd4a936468d50466" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a1f4845041e08b3335510de44fafaee19" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a1f4845041e08b3335510de44fafaee19" > Parse< / a > (const int argc, const char *const *argv)< / td > < / tr >
< tr class = "memdesc:a1f4845041e08b3335510de44fafaee19" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will parse command line arguments. < a href = "classHazelnp_1_1CmdArgsInterface.html#a1f4845041e08b3335510de44fafaee19" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a1f4845041e08b3335510de44fafaee19" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:afe83a815b21d37b3d2a6d0ef67137faf" > < td class = "memItemLeft" align = "right" valign = "top" > const std::string &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#afe83a815b21d37b3d2a6d0ef67137faf" > GetExecutableName< / a > () const< / td > < / tr >
< tr class = "memdesc:afe83a815b21d37b3d2a6d0ef67137faf" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will return argv[0], the name of the executable. < a href = "classHazelnp_1_1CmdArgsInterface.html#afe83a815b21d37b3d2a6d0ef67137faf" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:afe83a815b21d37b3d2a6d0ef67137faf" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:af5e43c1067fb6c1074d9be3427c7a415" > < td class = "memItemLeft" align = "right" valign = "top" > const < a class = "el" href = "classHazelnp_1_1Value.html" > Value< / a > &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#af5e43c1067fb6c1074d9be3427c7a415" > operator[]< / a > (const std::string & key) const< / td > < / tr >
< tr class = "memdesc:af5e43c1067fb6c1074d9be3427c7a415" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will return the value given a key. < a href = "classHazelnp_1_1CmdArgsInterface.html#af5e43c1067fb6c1074d9be3427c7a415" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:af5e43c1067fb6c1074d9be3427c7a415" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a3a7fa36fe69ee8bf3b400983a21ecd24" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a3a7fa36fe69ee8bf3b400983a21ecd24" > HasParam< / a > (const std::string & key) const< / td > < / tr >
< tr class = "memdesc:a3a7fa36fe69ee8bf3b400983a21ecd24" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will check wether a parameter exists given a key, or not. < a href = "classHazelnp_1_1CmdArgsInterface.html#a3a7fa36fe69ee8bf3b400983a21ecd24" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a3a7fa36fe69ee8bf3b400983a21ecd24" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aaccf591a74408aeb4363033fe8cb2224" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#aaccf591a74408aeb4363033fe8cb2224" > RegisterAbbreviation< / a > (const std::string & abbrev, const std::string & target)< / td > < / tr >
< tr class = "memdesc:aaccf591a74408aeb4363033fe8cb2224" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will register an abbreviation (like -f for – force) < a href = "classHazelnp_1_1CmdArgsInterface.html#aaccf591a74408aeb4363033fe8cb2224" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:aaccf591a74408aeb4363033fe8cb2224" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a1486bfef870e6502aefc23b11ce6caaf" > < td class = "memItemLeft" align = "right" valign = "top" > const std::string &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a1486bfef870e6502aefc23b11ce6caaf" > GetAbbreviation< / a > (const std::string & abbrev) const< / td > < / tr >
< tr class = "memdesc:a1486bfef870e6502aefc23b11ce6caaf" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will return the long form of an abbreviation (like – force for -f) < br / >
Returns "" if no match is found. < a href = "classHazelnp_1_1CmdArgsInterface.html#a1486bfef870e6502aefc23b11ce6caaf" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a1486bfef870e6502aefc23b11ce6caaf" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a58b81709e631cee5f3db3f3f48611fe9" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a58b81709e631cee5f3db3f3f48611fe9" > HasAbbreviation< / a > (const std::string & abbrev) const< / td > < / tr >
< tr class = "memdesc:a58b81709e631cee5f3db3f3f48611fe9" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will check wether or not an abbreviation is registered. < a href = "classHazelnp_1_1CmdArgsInterface.html#a58b81709e631cee5f3db3f3f48611fe9" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a58b81709e631cee5f3db3f3f48611fe9" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a31f690bd95d5469d38af816183cbe3e7" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a31f690bd95d5469d38af816183cbe3e7" > ClearAbbreviation< / a > (const std::string & abbrevation)< / td > < / tr >
< tr class = "memdesc:a31f690bd95d5469d38af816183cbe3e7" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will delete the abbreviation for a given parameter. < a href = "classHazelnp_1_1CmdArgsInterface.html#a31f690bd95d5469d38af816183cbe3e7" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a31f690bd95d5469d38af816183cbe3e7" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a019e48f48427e7caa76c964bd0f117d0" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a019e48f48427e7caa76c964bd0f117d0" > ClearAbbreviations< / a > ()< / td > < / tr >
< tr class = "memdesc:a019e48f48427e7caa76c964bd0f117d0" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will delete all abbreviations. < a href = "classHazelnp_1_1CmdArgsInterface.html#a019e48f48427e7caa76c964bd0f117d0" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a019e48f48427e7caa76c964bd0f117d0" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aa30222df012f357455f90e3620346bb2" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#aa30222df012f357455f90e3620346bb2" > RegisterConstraint< / a > (const std::string & key, const < a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint< / a > & constraint)< / td > < / tr >
< tr class = "memdesc:aa30222df012f357455f90e3620346bb2" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will register a constraint for a parameter. < a href = "classHazelnp_1_1CmdArgsInterface.html#aa30222df012f357455f90e3620346bb2" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:aa30222df012f357455f90e3620346bb2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:adec82884377a5193f68dcc7b6ef69d8b" > < 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 = "classHazelnp_1_1CmdArgsInterface.html#adec82884377a5193f68dcc7b6ef69d8b" > GetConstraint< / a > (const std::string & parameter) const< / td > < / tr >
< tr class = "memdesc:adec82884377a5193f68dcc7b6ef69d8b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will return the constraint information for a specific parameter. < a href = "classHazelnp_1_1CmdArgsInterface.html#adec82884377a5193f68dcc7b6ef69d8b" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:adec82884377a5193f68dcc7b6ef69d8b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a112d2d5e3fd1cf1507592389c8454984" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a112d2d5e3fd1cf1507592389c8454984" > ClearConstraint< / a > (const std::string & parameter)< / td > < / tr >
< tr class = "memdesc:a112d2d5e3fd1cf1507592389c8454984" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will the constraint of a specific parameter. < a href = "classHazelnp_1_1CmdArgsInterface.html#a112d2d5e3fd1cf1507592389c8454984" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a112d2d5e3fd1cf1507592389c8454984" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ad472671fb12450b8d929418fbbffbe40" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#ad472671fb12450b8d929418fbbffbe40" > ClearConstraints< / a > ()< / td > < / tr >
< tr class = "memdesc:ad472671fb12450b8d929418fbbffbe40" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will delete all constraints. < a href = "classHazelnp_1_1CmdArgsInterface.html#ad472671fb12450b8d929418fbbffbe40" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ad472671fb12450b8d929418fbbffbe40" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a16a3a02f77d240d8cf51cd4ee1797113" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a16a3a02f77d240d8cf51cd4ee1797113" > SetCrashOnFail< / a > (bool crashOnFail)< / td > < / tr >
< tr class = "memdesc:a16a3a02f77d240d8cf51cd4ee1797113" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsing, or not. < a href = "classHazelnp_1_1CmdArgsInterface.html#a16a3a02f77d240d8cf51cd4ee1797113" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a16a3a02f77d240d8cf51cd4ee1797113" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a3e60c7a90c11bdc634d0f5d0dba5064c" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a3e60c7a90c11bdc634d0f5d0dba5064c" > GetCrashOnFail< / a > () const< / td > < / tr >
< tr class = "memdesc:a3e60c7a90c11bdc634d0f5d0dba5064c" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Gets whether the application crashes on an exception whilst parsing, and prints to stderr. < a href = "classHazelnp_1_1CmdArgsInterface.html#a3e60c7a90c11bdc634d0f5d0dba5064c" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a3e60c7a90c11bdc634d0f5d0dba5064c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:abf553ed4acabf9e1db357715bc10533c" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#abf553ed4acabf9e1db357715bc10533c" > SetCatchHelp< / a > (bool catchHelp)< / td > < / tr >
< tr class = "memdesc:abf553ed4acabf9e1db357715bc10533c" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Sets whether the < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html" title = "The main class to interface with." > CmdArgsInterface< / a > should automatically catch the – help parameter, print the parameter documentation to stdout, and exit or not. < a href = "classHazelnp_1_1CmdArgsInterface.html#abf553ed4acabf9e1db357715bc10533c" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:abf553ed4acabf9e1db357715bc10533c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a1026d98c23659b6d3d108b231806a1e3" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a1026d98c23659b6d3d108b231806a1e3" > GetCatchHelp< / a > () const< / td > < / tr >
< tr class = "memdesc:a1026d98c23659b6d3d108b231806a1e3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Retruns whether the < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html" title = "The main class to interface with." > CmdArgsInterface< / a > should automatically catch the – help parameter, print the parameter documentation to stdout, and exit or not. < a href = "classHazelnp_1_1CmdArgsInterface.html#a1026d98c23659b6d3d108b231806a1e3" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a1026d98c23659b6d3d108b231806a1e3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a67ba6cb3176884c85dd56fc9084ab66a" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a67ba6cb3176884c85dd56fc9084ab66a" > SetBriefDescription< / a > (const std::string & description)< / td > < / tr >
< tr class = "memdesc:a67ba6cb3176884c85dd56fc9084ab66a" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Sets a brief description of the application to be automatically added to the documentation. < a href = "classHazelnp_1_1CmdArgsInterface.html#a67ba6cb3176884c85dd56fc9084ab66a" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a67ba6cb3176884c85dd56fc9084ab66a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a1945208a97707b2e3c654424f0760441" > < td class = "memItemLeft" align = "right" valign = "top" > const std::string &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a1945208a97707b2e3c654424f0760441" > GetBriefDescription< / a > ()< / td > < / tr >
< tr class = "memdesc:a1945208a97707b2e3c654424f0760441" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Returns the brief description of the application to be automatically added to the documentation. < a href = "classHazelnp_1_1CmdArgsInterface.html#a1945208a97707b2e3c654424f0760441" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a1945208a97707b2e3c654424f0760441" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a6589d2e818ba32f2a3e5b5a6a5e2bf1e" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a6589d2e818ba32f2a3e5b5a6a5e2bf1e" > RegisterDescription< / a > (const std::string & parameter, const std::string & description)< / td > < / tr >
< tr class = "memdesc:a6589d2e818ba32f2a3e5b5a6a5e2bf1e" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Willl register a short description for a parameter. < a href = "classHazelnp_1_1CmdArgsInterface.html#a6589d2e818ba32f2a3e5b5a6a5e2bf1e" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a6589d2e818ba32f2a3e5b5a6a5e2bf1e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a89bc3f54d7ff0740549dbdf7b7f727e3" > < td class = "memItemLeft" align = "right" valign = "top" > const std::string &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a89bc3f54d7ff0740549dbdf7b7f727e3" > GetDescription< / a > (const std::string & parameter) const< / td > < / tr >
< tr class = "memdesc:a89bc3f54d7ff0740549dbdf7b7f727e3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will return a short description for a parameter, if it exists. < a href = "classHazelnp_1_1CmdArgsInterface.html#a89bc3f54d7ff0740549dbdf7b7f727e3" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a89bc3f54d7ff0740549dbdf7b7f727e3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a5003f826ee31c6365bf4b6e8b2c8d9f1" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a5003f826ee31c6365bf4b6e8b2c8d9f1" > HasDescription< / a > (const std::string & parameter) const< / td > < / tr >
< tr class = "memdesc:a5003f826ee31c6365bf4b6e8b2c8d9f1" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Returns whether or not a given parameter has a registered description. < a href = "classHazelnp_1_1CmdArgsInterface.html#a5003f826ee31c6365bf4b6e8b2c8d9f1" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a5003f826ee31c6365bf4b6e8b2c8d9f1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a62889ce1faa90d0f20be3ae45803baa0" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a62889ce1faa90d0f20be3ae45803baa0" > ClearDescription< / a > (const std::string & parameter)< / td > < / tr >
< tr class = "memdesc:a62889ce1faa90d0f20be3ae45803baa0" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will delete the description of a parameter if it exists. < a href = "classHazelnp_1_1CmdArgsInterface.html#a62889ce1faa90d0f20be3ae45803baa0" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a62889ce1faa90d0f20be3ae45803baa0" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a328dbc265e7ffa9ab526ed8aa755e107" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a328dbc265e7ffa9ab526ed8aa755e107" > ClearDescriptions< / a > ()< / td > < / tr >
< tr class = "memdesc:a328dbc265e7ffa9ab526ed8aa755e107" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will delete all parameter descriptions. < a href = "classHazelnp_1_1CmdArgsInterface.html#a328dbc265e7ffa9ab526ed8aa755e107" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a328dbc265e7ffa9ab526ed8aa755e107" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a9b9bc5c4443799ea847077e9cefb1927" > < td class = "memItemLeft" align = "right" valign = "top" > std::string  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html#a9b9bc5c4443799ea847077e9cefb1927" > GenerateDocumentation< / a > () const< / td > < / tr >
< tr class = "memdesc:a9b9bc5c4443799ea847077e9cefb1927" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Will generate a text-based documentation suited to show the user, for example on – help. < a href = "classHazelnp_1_1CmdArgsInterface.html#a9b9bc5c4443799ea847077e9cefb1927" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a9b9bc5c4443799ea847077e9cefb1927" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > The main class to interface with. < / p >
2021-09-05 12:12:03 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8h_source.html#l00013" > 13< / a > of file < a class = "el" href = "CmdArgsInterface_8h_source.html" > CmdArgsInterface.h< / a > .< / p >
2021-06-08 14:02:49 +02:00
< / div > < h2 class = "groupheader" > Constructor & Destructor Documentation< / h2 >
< a id = "aa1189c249bf0d8a4fbd5fb8f03a30212" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aa1189c249bf0d8a4fbd5fb8f03a30212" > ◆ < / a > < / span > CmdArgsInterface() < span class = "overload" > [1/2]< / span > < / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > CmdArgsInterface::CmdArgsInterface < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00015" > 15< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00016" > < / a > < span class = "lineno" > 16< / span >   {< / div >
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00018" > < / a > < span class = "lineno" > 18< / span >   }< / div >
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "ad79ff83ead06900eb7b45d6c563703d9" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ad79ff83ead06900eb7b45d6c563703d9" > ◆ < / a > < / span > CmdArgsInterface() < span class = "overload" > [2/2]< / span > < / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > CmdArgsInterface::CmdArgsInterface < / td >
< td > (< / td >
< td class = "paramtype" > const int  < / td >
< td class = "paramname" > < em > argc< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const char *const *  < / td >
< td class = "paramname" > < em > argv< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00020" > 20< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < 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 >   < a class = "code" href = "classHazelnp_1_1CmdArgsInterface.html#a1f4845041e08b3335510de44fafaee19" > Parse< / a > (argc, argv);< / div >
< div class = "line" > < a name = "l00023" > < / a > < span class = "lineno" > 23< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > 24< / span >   }< / div >
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "aadc75b3b6c9662cfbd4a936468d50466" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aadc75b3b6c9662cfbd4a936468d50466" > ◆ < / a > < / span > ~CmdArgsInterface()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > CmdArgsInterface::~CmdArgsInterface < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00026" > 26< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00027" > < / a > < span class = "lineno" > 27< / span >   {< / div >
< div class = "line" > < a name = "l00028" > < / a > < span class = "lineno" > 28< / span >   < span class = "keywordflow" > for< / span > (< span class = "keyword" > auto< / span > & it : parameters)< / div >
< div class = "line" > < a name = "l00029" > < / a > < span class = "lineno" > 29< / span >   < span class = "keyword" > delete< / span > it.second;< / div >
< div class = "line" > < a name = "l00030" > < / a > < span class = "lineno" > 30< / span >   < / div >
< div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > 31< / span >   parameters.clear();< / 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 > ;< / div >
< div class = "line" > < a name = "l00034" > < / a > < span class = "lineno" > 34< / span >   }< / div >
< / div > <!-- fragment -->
< / div >
< / div >
< h2 class = "groupheader" > Member Function Documentation< / h2 >
< a id = "a31f690bd95d5469d38af816183cbe3e7" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a31f690bd95d5469d38af816183cbe3e7" > ◆ < / a > < / span > ClearAbbreviation()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void CmdArgsInterface::ClearAbbreviation < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > abbrevation< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will delete the abbreviation for a given parameter. < / p >
< p > < br / >
IMPORTANT: This parameter is the abbreviation! Not the long form! < / p >
2021-09-05 12:24:50 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00651" > 651< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00652" > < / a > < span class = "lineno" > 652< / span >   {< / div >
< div class = "line" > < a name = "l00653" > < / a > < span class = "lineno" > 653< / span >   parameterAbreviations.erase(abbrevation);< / div >
< div class = "line" > < a name = "l00654" > < / a > < span class = "lineno" > 654< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00655" > < / a > < span class = "lineno" > 655< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a019e48f48427e7caa76c964bd0f117d0" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a019e48f48427e7caa76c964bd0f117d0" > ◆ < / a > < / span > ClearAbbreviations()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void CmdArgsInterface::ClearAbbreviations < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will delete all abbreviations. < / p >
2021-09-05 12:24:50 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00657" > 657< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00658" > < / a > < span class = "lineno" > 658< / span >   {< / div >
< div class = "line" > < a name = "l00659" > < / a > < span class = "lineno" > 659< / span >   parameterAbreviations.clear();< / div >
< div class = "line" > < a name = "l00660" > < / a > < span class = "lineno" > 660< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00661" > < / a > < span class = "lineno" > 661< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a112d2d5e3fd1cf1507592389c8454984" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a112d2d5e3fd1cf1507592389c8454984" > ◆ < / a > < / span > ClearConstraint()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void CmdArgsInterface::ClearConstraint < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > parameter< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will the constraint of a specific parameter. < / p >
2021-09-05 12:24:50 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00612" > 612< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00613" > < / a > < span class = "lineno" > 613< / span >   {< / div >
< div class = "line" > < a name = "l00614" > < / a > < span class = "lineno" > 614< / span >   parameterConstraints.erase(parameter);< / div >
< div class = "line" > < a name = "l00615" > < / a > < span class = "lineno" > 615< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00616" > < / a > < span class = "lineno" > 616< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "ad472671fb12450b8d929418fbbffbe40" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ad472671fb12450b8d929418fbbffbe40" > ◆ < / a > < / span > ClearConstraints()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void CmdArgsInterface::ClearConstraints < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will delete all constraints. < / p >
2021-09-05 12:24:50 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00670" > 670< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00671" > < / a > < span class = "lineno" > 671< / span >   {< / div >
< div class = "line" > < a name = "l00672" > < / a > < span class = "lineno" > 672< / span >   parameterConstraints.clear();< / div >
< div class = "line" > < a name = "l00673" > < / a > < span class = "lineno" > 673< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00674" > < / a > < span class = "lineno" > 674< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a62889ce1faa90d0f20be3ae45803baa0" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a62889ce1faa90d0f20be3ae45803baa0" > ◆ < / a > < / span > ClearDescription()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void CmdArgsInterface::ClearDescription < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > parameter< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will delete the description of a parameter if it exists. < / p >
2021-09-05 12:12:03 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00412" > 412< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00413" > < / a > < span class = "lineno" > 413< / span >   {< / div >
< div class = "line" > < a name = "l00414" > < / a > < span class = "lineno" > 414< / span >   < span class = "comment" > // This will just do nothing if the entry does not exist< / span > < / div >
< div class = "line" > < a name = "l00415" > < / a > < span class = "lineno" > 415< / span >   parameterDescriptions.erase(parameter);< / div >
< div class = "line" > < a name = "l00416" > < / a > < span class = "lineno" > 416< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00417" > < / a > < span class = "lineno" > 417< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a328dbc265e7ffa9ab526ed8aa755e107" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a328dbc265e7ffa9ab526ed8aa755e107" > ◆ < / a > < / span > ClearDescriptions()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void Hazelnp::CmdArgsInterface::ClearDescriptions < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will delete all parameter descriptions. < / p >
2021-09-05 12:12:03 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00419" > 419< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00420" > < / a > < span class = "lineno" > 420< / span >   {< / div >
< div class = "line" > < a name = "l00421" > < / a > < span class = "lineno" > 421< / span >   parameterDescriptions.clear();< / div >
< div class = "line" > < a name = "l00422" > < / a > < span class = "lineno" > 422< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00423" > < / a > < span class = "lineno" > 423< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a9b9bc5c4443799ea847077e9cefb1927" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a9b9bc5c4443799ea847077e9cefb1927" > ◆ < / a > < / span > GenerateDocumentation()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::string CmdArgsInterface::GenerateDocumentation < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will generate a text-based documentation suited to show the user, for example on – help. < / p >
2021-09-05 12:12:03 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00425" > 425< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00426" > < / a > < span class = "lineno" > 426< / span >   {< / div >
< div class = "line" > < a name = "l00427" > < / a > < span class = "lineno" > 427< / span >   std::stringstream ss;< / div >
< div class = "line" > < a name = "l00428" > < / a > < span class = "lineno" > 428< / span >   < / div >
< div class = "line" > < a name = "l00429" > < / a > < span class = "lineno" > 429< / span >   < span class = "comment" > // Add brief, if available< / span > < / div >
< div class = "line" > < a name = "l00430" > < / a > < span class = "lineno" > 430< / span >   < span class = "keywordflow" > if< / span > (briefDescription.length() > 0)< / div >
< div class = "line" > < a name = "l00431" > < / a > < span class = "lineno" > 431< / span >   ss < < briefDescription < < std::endl;< / div >
< div class = "line" > < a name = "l00432" > < / a > < span class = "lineno" > 432< / span >   < / div >
< div class = "line" > < a name = "l00433" > < / a > < span class = "lineno" > 433< / span >   < span class = "comment" > // Collect parameter information< / span > < / div >
< div class = "line" > < a name = "l00434" > < / a > < span class = "lineno" > 434< / span >   < span class = "keyword" > struct < / span > ParamDocEntry< / div >
< div class = "line" > < a name = "l00435" > < / a > < span class = "lineno" > 435< / span >   {< / div >
< div class = "line" > < a name = "l00436" > < / a > < span class = "lineno" > 436< / span >   std::string abbreviation;< / div >
< div class = "line" > < a name = "l00437" > < / a > < span class = "lineno" > 437< / span >   std::string description;< / div >
< div class = "line" > < a name = "l00438" > < / a > < span class = "lineno" > 438< / span >   std::string type;< / div >
< div class = "line" > < a name = "l00439" > < / a > < span class = "lineno" > 439< / span >   < span class = "keywordtype" > bool< / span > required = < span class = "keyword" > false< / span > ;< / div >
< div class = "line" > < a name = "l00440" > < / a > < span class = "lineno" > 440< / span >   < span class = "keywordtype" > bool< / span > typeIsForced = < span class = "keyword" > false< / span > ;< / div >
< div class = "line" > < a name = "l00441" > < / a > < span class = "lineno" > 441< / span >   std::string defaultVal;< / div >
2021-09-05 12:24:50 +02:00
< div class = "line" > < a name = "l00442" > < / a > < span class = "lineno" > 442< / span >   std::string incompatibilities;< / div >
< div class = "line" > < a name = "l00443" > < / a > < span class = "lineno" > 443< / span >   };< / div >
< div class = "line" > < a name = "l00444" > < / a > < span class = "lineno" > 444< / span >   std::unordered_map< std::string, ParamDocEntry> paramInfos;< / div >
< div class = "line" > < a name = "l00445" > < / a > < span class = "lineno" > 445< / span >   < / div >
< div class = "line" > < a name = "l00446" > < / a > < span class = "lineno" > 446< / span >   < span class = "comment" > // Collect descriptions< / span > < / div >
< div class = "line" > < a name = "l00447" > < / a > < span class = "lineno" > 447< / span >   < span class = "keywordflow" > for< / span > (< span class = "keyword" > const< / span > < span class = "keyword" > auto< / span > & it : parameterDescriptions)< / div >
< div class = "line" > < a name = "l00448" > < / a > < span class = "lineno" > 448< / span >   {< / div >
< div class = "line" > < a name = "l00449" > < / a > < span class = "lineno" > 449< / span >   < span class = "comment" > // Do we already have that param in the paramInfo set?< / span > < / div >
< div class = "line" > < a name = "l00450" > < / a > < span class = "lineno" > 450< / span >   < span class = "keywordflow" > if< / span > (paramInfos.find(it.first) == paramInfos.end())< / div >
< div class = "line" > < a name = "l00451" > < / a > < span class = "lineno" > 451< / span >   < span class = "comment" > // No? Create it.< / span > < / div >
< div class = "line" > < a name = "l00452" > < / a > < span class = "lineno" > 452< / span >   paramInfos[it.first] = ParamDocEntry();< / div >
< div class = "line" > < a name = "l00453" > < / a > < span class = "lineno" > 453< / span >   < / div >
< div class = "line" > < a name = "l00454" > < / a > < span class = "lineno" > 454< / span >   paramInfos[it.first].description = it.second;< / div >
< div class = "line" > < a name = "l00455" > < / a > < span class = "lineno" > 455< / span >   }< / div >
< div class = "line" > < a name = "l00456" > < / a > < span class = "lineno" > 456< / span >   < / div >
< div class = "line" > < a name = "l00457" > < / a > < span class = "lineno" > 457< / span >   < span class = "comment" > // Collect abbreviations< / span > < / div >
< div class = "line" > < a name = "l00458" > < / a > < span class = "lineno" > 458< / span >   < span class = "comment" > // first value is abbreviation, second is long form< / span > < / div >
< div class = "line" > < a name = "l00459" > < / a > < span class = "lineno" > 459< / span >   < span class = "keywordflow" > for< / span > (< span class = "keyword" > const< / span > < span class = "keyword" > auto< / span > & it : parameterAbreviations)< / div >
< div class = "line" > < a name = "l00460" > < / a > < span class = "lineno" > 460< / span >   {< / div >
< div class = "line" > < a name = "l00461" > < / a > < span class = "lineno" > 461< / span >   < span class = "comment" > // Do we already have that param in the paramInfo set?< / span > < / div >
< div class = "line" > < a name = "l00462" > < / a > < span class = "lineno" > 462< / span >   < span class = "keywordflow" > if< / span > (paramInfos.find(it.second) == paramInfos.end())< / div >
< div class = "line" > < a name = "l00463" > < / a > < span class = "lineno" > 463< / span >   < span class = "comment" > // No? Create it.< / span > < / div >
< div class = "line" > < a name = "l00464" > < / a > < span class = "lineno" > 464< / span >   paramInfos[it.second] = ParamDocEntry();< / div >
< div class = "line" > < a name = "l00465" > < / a > < span class = "lineno" > 465< / span >   < / div >
< div class = "line" > < a name = "l00466" > < / a > < span class = "lineno" > 466< / span >   paramInfos[it.second].abbreviation = it.first;< / div >
< div class = "line" > < a name = "l00467" > < / a > < span class = "lineno" > 467< / span >   }< / div >
< div class = "line" > < a name = "l00468" > < / a > < span class = "lineno" > 468< / span >   < / div >
< div class = "line" > < a name = "l00469" > < / a > < span class = "lineno" > 469< / span >   < span class = "comment" > // Collect constraints< / span > < / div >
< div class = "line" > < a name = "l00470" > < / a > < span class = "lineno" > 470< / span >   < span class = "keywordflow" > for< / span > (< span class = "keyword" > const< / span > < span class = "keyword" > auto< / span > & it : parameterConstraints)< / div >
< div class = "line" > < a name = "l00471" > < / a > < span class = "lineno" > 471< / span >   {< / div >
< div class = "line" > < a name = "l00472" > < / a > < span class = "lineno" > 472< / span >   < span class = "comment" > // Do we already have that param in the paramInfo set?< / span > < / div >
< div class = "line" > < a name = "l00473" > < / a > < span class = "lineno" > 473< / span >   < span class = "keywordflow" > if< / span > (paramInfos.find(it.first) == paramInfos.end())< / div >
< div class = "line" > < a name = "l00474" > < / a > < span class = "lineno" > 474< / span >   < span class = "comment" > // No? Create it.< / span > < / div >
< div class = "line" > < a name = "l00475" > < / a > < span class = "lineno" > 475< / span >   paramInfos[it.first] = ParamDocEntry();< / div >
< div class = "line" > < a name = "l00476" > < / a > < span class = "lineno" > 476< / span >   < / div >
< div class = "line" > < a name = "l00477" > < / a > < span class = "lineno" > 477< / span >   ParamDocEntry& cached = paramInfos[it.first];< / div >
< div class = "line" > < a name = "l00478" > < / a > < span class = "lineno" > 478< / span >   cached.required = it.second.required;< / div >
< div class = "line" > < a name = "l00479" > < / a > < span class = "lineno" > 479< / span >   cached.typeIsForced = it.second.constrainType;< / div >
< div class = "line" > < a name = "l00480" > < / a > < span class = "lineno" > 480< / span >   cached.type = < a class = "code" href = "namespaceHazelnp.html#a7fb1e5ad9e2ecb6c0025beb19f11621b" > DataTypeToString< / a > (it.second.requiredType);< / div >
< div class = "line" > < a name = "l00481" > < / a > < span class = "lineno" > 481< / span >   < / div >
< div class = "line" > < a name = "l00482" > < / a > < span class = "lineno" > 482< / span >   < span class = "comment" > // Build default-value string< / span > < / div >
< div class = "line" > < a name = "l00483" > < / a > < span class = "lineno" > 483< / span >   std::stringstream vec2str_ss;< / div >
< div class = "line" > < a name = "l00484" > < / a > < span class = "lineno" > 484< / span >   < span class = "keywordflow" > for< / span > (< span class = "keyword" > const< / span > std::string& s : it.second.defaultValue)< / div >
< div class = "line" > < a name = "l00485" > < / a > < span class = "lineno" > 485< / span >   {< / div >
< div class = "line" > < a name = "l00486" > < / a > < span class = "lineno" > 486< / span >   vec2str_ss < < < span class = "charliteral" > ' \' ' < / span > < < s < < < span class = "charliteral" > ' \' ' < / span > ;< / div >
< div class = "line" > < a name = "l00487" > < / a > < span class = "lineno" > 487< / span >   < / div >
< div class = "line" > < a name = "l00488" > < / a > < span class = "lineno" > 488< / span >   < span class = "comment" > // Add a space if we are not at the last entry< / span > < / div >
< div class = "line" > < a name = "l00489" > < / a > < span class = "lineno" > 489< / span >   < span class = "keywordflow" > if< / span > ((< span class = "keywordtype" > void< / span > *)& s != (< span class = "keywordtype" > void< / span > *)& it.second.defaultValue.back())< / div >
< div class = "line" > < a name = "l00490" > < / a > < span class = "lineno" > 490< / span >   vec2str_ss < < < span class = "stringliteral" > " " < / span > ;< / div >
< div class = "line" > < a name = "l00491" > < / a > < span class = "lineno" > 491< / span >   }< / div >
< div class = "line" > < a name = "l00492" > < / a > < span class = "lineno" > 492< / span >   cached.defaultVal = vec2str_ss.str();< / div >
< div class = "line" > < a name = "l00493" > < / a > < span class = "lineno" > 493< / span >   < / div >
< div class = "line" > < a name = "l00494" > < / a > < span class = "lineno" > 494< / span >   < / div >
< div class = "line" > < a name = "l00495" > < / a > < span class = "lineno" > 495< / span >   < span class = "comment" > // Build incompatibilities string< / span > < / div >
< div class = "line" > < a name = "l00496" > < / a > < span class = "lineno" > 496< / span >   vec2str_ss.str(< span class = "stringliteral" > " " < / span > );< / div >
< div class = "line" > < a name = "l00497" > < / a > < span class = "lineno" > 497< / span >   < span class = "keywordflow" > for< / span > (< span class = "keyword" > const< / span > std::string& s : it.second.incompatibleParameters)< / div >
< div class = "line" > < a name = "l00498" > < / a > < span class = "lineno" > 498< / span >   {< / div >
< div class = "line" > < a name = "l00499" > < / a > < span class = "lineno" > 499< / span >   vec2str_ss < < s;< / div >
< div class = "line" > < a name = "l00500" > < / a > < span class = "lineno" > 500< / span >   < / div >
< div class = "line" > < a name = "l00501" > < / a > < span class = "lineno" > 501< / span >   < span class = "comment" > // Add a comma-space if we are not at the last entry< / span > < / div >
< div class = "line" > < a name = "l00502" > < / a > < span class = "lineno" > 502< / span >   < span class = "keywordflow" > if< / span > ((< span class = "keywordtype" > void< / span > *)& s != (< span class = "keywordtype" > void< / span > *)& it.second.incompatibleParameters.back())< / div >
< div class = "line" > < a name = "l00503" > < / a > < span class = "lineno" > 503< / span >   vec2str_ss < < < span class = "stringliteral" > " , " < / span > ;< / div >
< div class = "line" > < a name = "l00504" > < / a > < span class = "lineno" > 504< / span >   }< / div >
< div class = "line" > < a name = "l00505" > < / a > < span class = "lineno" > 505< / span >   cached.incompatibilities = vec2str_ss.str();< / div >
< div class = "line" > < a name = "l00506" > < / a > < span class = "lineno" > 506< / span >   }< / div >
2021-09-05 12:12:03 +02:00
< div class = "line" > < a name = "l00507" > < / a > < span class = "lineno" > 507< / span >   < / div >
2021-09-05 12:24:50 +02:00
< div class = "line" > < a name = "l00508" > < / a > < span class = "lineno" > 508< / span >   < span class = "comment" > // Now generate the documentation body< / span > < / div >
< div class = "line" > < a name = "l00509" > < / a > < span class = "lineno" > 509< / span >   < span class = "keywordflow" > if< / span > (paramInfos.size() > 0)< / div >
< div class = "line" > < a name = "l00510" > < / a > < span class = "lineno" > 510< / span >   {< / div >
< div class = "line" > < a name = "l00511" > < / a > < span class = "lineno" > 511< / span >   ss < < std::endl < / div >
< div class = "line" > < a name = "l00512" > < / a > < span class = "lineno" > 512< / span >   < < < span class = "stringliteral" > " ==== AVAILABLE PARAMETERS ====" < / span > < / div >
< div class = "line" > < a name = "l00513" > < / a > < span class = "lineno" > 513< / span >   < < std::endl < < std::endl;< / div >
< div class = "line" > < a name = "l00514" > < / a > < span class = "lineno" > 514< / span >   < / div >
< div class = "line" > < a name = "l00515" > < / a > < span class = "lineno" > 515< / span >   std::size_t counter = 0;< / div >
< div class = "line" > < a name = "l00516" > < / a > < span class = "lineno" > 516< / span >   < span class = "keywordflow" > for< / span > (< span class = "keyword" > const< / span > < span class = "keyword" > auto< / span > & it : paramInfos)< / div >
< div class = "line" > < a name = "l00517" > < / a > < span class = "lineno" > 517< / span >   {< / div >
< div class = "line" > < a name = "l00518" > < / a > < span class = "lineno" > 518< / span >   < span class = "keyword" > const< / span > ParamDocEntry& pde = it.second;< / div >
2021-09-05 12:12:03 +02:00
< div class = "line" > < a name = "l00519" > < / a > < span class = "lineno" > 519< / span >   < / div >
2021-09-05 12:24:50 +02:00
< div class = "line" > < a name = "l00520" > < / a > < span class = "lineno" > 520< / span >   < span class = "comment" > // Put name< / span > < / div >
< div class = "line" > < a name = "l00521" > < / a > < span class = "lineno" > 521< / span >   ss < < it.first < < < span class = "stringliteral" > " " < / span > ;< / div >
< div class = "line" > < a name = "l00522" > < / a > < span class = "lineno" > 522< / span >   < / div >
< div class = "line" > < a name = "l00523" > < / a > < span class = "lineno" > 523< / span >   < span class = "comment" > // Put abbreviation< / span > < / div >
< div class = "line" > < a name = "l00524" > < / a > < span class = "lineno" > 524< / span >   < span class = "keywordflow" > if< / span > (pde.abbreviation.length() > 0)< / div >
< div class = "line" > < a name = "l00525" > < / a > < span class = "lineno" > 525< / span >   ss < < pde.abbreviation < < < span class = "stringliteral" > " " < / span > ;< / div >
< div class = "line" > < a name = "l00526" > < / a > < span class = "lineno" > 526< / span >   < / div >
< div class = "line" > < a name = "l00527" > < / a > < span class = "lineno" > 527< / span >   < span class = "comment" > // Put type< / span > < / div >
< div class = "line" > < a name = "l00528" > < / a > < span class = "lineno" > 528< / span >   < span class = "keywordflow" > if< / span > (pde.typeIsForced)< / div >
< div class = "line" > < a name = "l00529" > < / a > < span class = "lineno" > 529< / span >   ss < < pde.type < < < span class = "stringliteral" > " " < / span > ;< / div >
< div class = "line" > < a name = "l00530" > < / a > < span class = "lineno" > 530< / span >   < / div >
< div class = "line" > < a name = "l00531" > < / a > < span class = "lineno" > 531< / span >   < span class = "comment" > // Put default value< / span > < / div >
< div class = "line" > < a name = "l00532" > < / a > < span class = "lineno" > 532< / span >   < span class = "keywordflow" > if< / span > (pde.defaultVal.length() > 0)< / div >
< div class = "line" > < a name = "l00533" > < / a > < span class = "lineno" > 533< / span >   ss < < < span class = "stringliteral" > " default=[" < / span > < < pde.defaultVal < < < span class = "stringliteral" > " ] " < / span > ;< / div >
< div class = "line" > < a name = "l00534" > < / a > < span class = "lineno" > 534< / span >   < / div >
< div class = "line" > < a name = "l00535" > < / a > < span class = "lineno" > 535< / span >   < span class = "comment" > // Put incompatibilities< / span > < / div >
< div class = "line" > < a name = "l00536" > < / a > < span class = "lineno" > 536< / span >   < span class = "keywordflow" > if< / span > (pde.incompatibilities.length() > 0)< / div >
< div class = "line" > < a name = "l00537" > < / a > < span class = "lineno" > 537< / span >   ss < < < span class = "stringliteral" > " incompatibilities=[" < / span > < < pde.incompatibilities < < < span class = "stringliteral" > " ] " < / span > ;< / div >
< div class = "line" > < a name = "l00538" > < / a > < span class = "lineno" > 538< / span >   < / div >
< div class = "line" > < a name = "l00539" > < / a > < span class = "lineno" > 539< / span >   < span class = "comment" > // Put required tag, but only if no default value< / span > < / div >
< div class = "line" > < a name = "l00540" > < / a > < span class = "lineno" > 540< / span >   < span class = "keywordflow" > if< / span > ((pde.required) & & (pde.defaultVal.length() == 0))< / div >
< div class = "line" > < a name = "l00541" > < / a > < span class = "lineno" > 541< / span >   ss < < < span class = "stringliteral" > " [[REQUIRED]] " < / span > ;< / div >
< div class = "line" > < a name = "l00542" > < / a > < span class = "lineno" > 542< / span >   < / div >
< div class = "line" > < a name = "l00543" > < / a > < span class = "lineno" > 543< / span >   < span class = "comment" > // Put brief description< / span > < / div >
< div class = "line" > < a name = "l00544" > < / a > < span class = "lineno" > 544< / span >   < span class = "keywordflow" > if< / span > (pde.description.length() > 0)< / div >
< div class = "line" > < a name = "l00545" > < / a > < span class = "lineno" > 545< / span >   ss < < pde.description;< / div >
< div class = "line" > < a name = "l00546" > < / a > < span class = "lineno" > 546< / span >   < / div >
< div class = "line" > < a name = "l00547" > < / a > < span class = "lineno" > 547< / span >   < span class = "comment" > // Omit linebreaks when we' re on the last element< / span > < / div >
< div class = "line" > < a name = "l00548" > < / a > < span class = "lineno" > 548< / span >   < span class = "keywordflow" > if< / span > (counter < paramInfos.size()-1)< / div >
< div class = "line" > < a name = "l00549" > < / a > < span class = "lineno" > 549< / span >   ss < < std::endl < < std::endl;< / div >
< div class = "line" > < a name = "l00550" > < / a > < span class = "lineno" > 550< / span >   < / div >
< div class = "line" > < a name = "l00551" > < / a > < span class = "lineno" > 551< / span >   counter++;< / div >
< div class = "line" > < a name = "l00552" > < / a > < span class = "lineno" > 552< / span >   }< / div >
< div class = "line" > < a name = "l00553" > < / a > < span class = "lineno" > 553< / span >   }< / div >
< div class = "line" > < a name = "l00554" > < / a > < span class = "lineno" > 554< / span >   < / div >
< div class = "line" > < a name = "l00555" > < / a > < span class = "lineno" > 555< / span >   < span class = "keywordflow" > return< / span > ss.str();< / div >
< div class = "line" > < a name = "l00556" > < / a > < span class = "lineno" > 556< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a1486bfef870e6502aefc23b11ce6caaf" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a1486bfef870e6502aefc23b11ce6caaf" > ◆ < / a > < / span > GetAbbreviation()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > const std::string & CmdArgsInterface::GetAbbreviation < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > abbrev< / em > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will return the long form of an abbreviation (like – force for -f) < br / >
Returns "" if no match is found. < / p >
2021-09-05 12:24:50 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00638" > 638< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00639" > < / a > < span class = "lineno" > 639< / span >   {< / div >
< div class = "line" > < a name = "l00640" > < / a > < span class = "lineno" > 640< / span >   < span class = "keywordflow" > if< / span > (!< a class = "code" href = "classHazelnp_1_1CmdArgsInterface.html#a58b81709e631cee5f3db3f3f48611fe9" > HasAbbreviation< / a > (abbrev))< / div >
< div class = "line" > < a name = "l00641" > < / a > < span class = "lineno" > 641< / span >   < span class = "keywordflow" > return< / span > < a class = "code" href = "namespaceHazelnp_1_1Placeholders.html#a90536f0cd5261b18da736e954c6b8b79" > Placeholders::g_emptyString< / a > ;< / div >
< div class = "line" > < a name = "l00642" > < / a > < span class = "lineno" > 642< / span >   < / div >
< div class = "line" > < a name = "l00643" > < / a > < span class = "lineno" > 643< / span >   < span class = "keywordflow" > return< / span > parameterAbreviations.find(abbrev)-> second;< / div >
< div class = "line" > < a name = "l00644" > < / a > < span class = "lineno" > 644< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a1945208a97707b2e3c654424f0760441" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a1945208a97707b2e3c654424f0760441" > ◆ < / a > < / span > GetBriefDescription()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > const std::string & CmdArgsInterface::GetBriefDescription < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Returns the brief description of the application to be automatically added to the documentation. < / p >
2021-09-05 12:12:03 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00385" > 385< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00386" > < / a > < span class = "lineno" > 386< / span >   {< / div >
< div class = "line" > < a name = "l00387" > < / a > < span class = "lineno" > 387< / span >   < span class = "keywordflow" > return< / span > briefDescription;< / div >
< div class = "line" > < a name = "l00388" > < / a > < span class = "lineno" > 388< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a1026d98c23659b6d3d108b231806a1e3" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a1026d98c23659b6d3d108b231806a1e3" > ◆ < / a > < / span > GetCatchHelp()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool CmdArgsInterface::GetCatchHelp < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Retruns whether the < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html" title = "The main class to interface with." > CmdArgsInterface< / a > should automatically catch the – help parameter, print the parameter documentation to stdout, and exit or not. < / p >
2021-09-05 12:12:03 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00374" > 374< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00375" > < / a > < span class = "lineno" > 375< / span >   {< / div >
< div class = "line" > < a name = "l00376" > < / a > < span class = "lineno" > 376< / span >   < span class = "keywordflow" > return< / span > catchHelp;< / div >
< div class = "line" > < a name = "l00377" > < / a > < span class = "lineno" > 377< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "adec82884377a5193f68dcc7b6ef69d8b" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#adec82884377a5193f68dcc7b6ef69d8b" > ◆ < / a > < / span > GetConstraint()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint< / a > CmdArgsInterface::GetConstraint < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > parameter< / em > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will return the constraint information for a specific parameter. < / p >
2021-09-05 12:24:50 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00607" > 607< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00608" > < / a > < span class = "lineno" > 608< / span >   {< / div >
< div class = "line" > < a name = "l00609" > < / a > < span class = "lineno" > 609< / span >   < span class = "keywordflow" > return< / span > parameterConstraints.find(parameter)-> second;< / div >
< div class = "line" > < a name = "l00610" > < / a > < span class = "lineno" > 610< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a3e60c7a90c11bdc634d0f5d0dba5064c" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a3e60c7a90c11bdc634d0f5d0dba5064c" > ◆ < / a > < / span > GetCrashOnFail()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool CmdArgsInterface::GetCrashOnFail < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Gets whether the application crashes on an exception whilst parsing, and prints to stderr. < / p >
2021-09-05 12:12:03 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00363" > 363< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00364" > < / a > < span class = "lineno" > 364< / span >   {< / div >
< div class = "line" > < a name = "l00365" > < / a > < span class = "lineno" > 365< / span >   < span class = "keywordflow" > return< / span > crashOnFail;< / div >
< div class = "line" > < a name = "l00366" > < / a > < span class = "lineno" > 366< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a89bc3f54d7ff0740549dbdf7b7f727e3" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a89bc3f54d7ff0740549dbdf7b7f727e3" > ◆ < / a > < / span > GetDescription()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > const std::string & Hazelnp::CmdArgsInterface::GetDescription < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > parameter< / em > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will return a short description for a parameter, if it exists. < / p >
< p > < br / >
Empty string if it does not exist. < / p >
2021-09-05 12:12:03 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00396" > 396< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00397" > < / a > < span class = "lineno" > 397< / span >   {< / div >
< div class = "line" > < a name = "l00398" > < / a > < span class = "lineno" > 398< / span >   < span class = "comment" > // Do we already have a description for this parameter?< / span > < / div >
< div class = "line" > < a name = "l00399" > < / a > < span class = "lineno" > 399< / span >   < span class = "keywordflow" > if< / span > (!< a class = "code" href = "classHazelnp_1_1CmdArgsInterface.html#a5003f826ee31c6365bf4b6e8b2c8d9f1" > HasDescription< / a > (parameter))< / div >
< div class = "line" > < a name = "l00400" > < / a > < span class = "lineno" > 400< / span >   < span class = "comment" > // No? Then return " " < / span > < / div >
< div class = "line" > < a name = "l00401" > < / a > < span class = "lineno" > 401< / span >   < span class = "keywordflow" > return< / span > < a class = "code" href = "namespaceHazelnp_1_1Placeholders.html#a90536f0cd5261b18da736e954c6b8b79" > Placeholders::g_emptyString< / a > ;< / div >
< div class = "line" > < a name = "l00402" > < / a > < span class = "lineno" > 402< / span >   < / div >
< div class = "line" > < a name = "l00403" > < / a > < span class = "lineno" > 403< / span >   < span class = "comment" > // We do? Then return it< / span > < / div >
< div class = "line" > < a name = "l00404" > < / a > < span class = "lineno" > 404< / span >   < span class = "keywordflow" > return< / span > parameterDescriptions.find(parameter)-> second;< / div >
< div class = "line" > < a name = "l00405" > < / a > < span class = "lineno" > 405< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "afe83a815b21d37b3d2a6d0ef67137faf" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#afe83a815b21d37b3d2a6d0ef67137faf" > ◆ < / a > < / span > GetExecutableName()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > const std::string & CmdArgsInterface::GetExecutableName < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will return argv[0], the name of the executable. < / p >
2021-09-05 12:24:50 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00618" > 618< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00619" > < / a > < span class = "lineno" > 619< / span >   {< / div >
< div class = "line" > < a name = "l00620" > < / a > < span class = "lineno" > 620< / span >   < span class = "keywordflow" > return< / span > executableName;< / div >
< div class = "line" > < a name = "l00621" > < / a > < span class = "lineno" > 621< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a58b81709e631cee5f3db3f3f48611fe9" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a58b81709e631cee5f3db3f3f48611fe9" > ◆ < / a > < / span > HasAbbreviation()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool CmdArgsInterface::HasAbbreviation < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > abbrev< / em > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will check wether or not an abbreviation is registered. < / p >
2021-09-05 12:24:50 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00646" > 646< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00647" > < / a > < span class = "lineno" > 647< / span >   {< / div >
< div class = "line" > < a name = "l00648" > < / a > < span class = "lineno" > 648< / span >   < span class = "keywordflow" > return< / span > parameterAbreviations.find(abbrev) != parameterAbreviations.end();< / div >
< div class = "line" > < a name = "l00649" > < / a > < span class = "lineno" > 649< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a5003f826ee31c6365bf4b6e8b2c8d9f1" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a5003f826ee31c6365bf4b6e8b2c8d9f1" > ◆ < / a > < / span > HasDescription()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool CmdArgsInterface::HasDescription < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > parameter< / em > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Returns whether or not a given parameter has a registered description. < / p >
2021-09-05 12:12:03 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00407" > 407< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00408" > < / a > < span class = "lineno" > 408< / span >   {< / div >
< div class = "line" > < a name = "l00409" > < / a > < span class = "lineno" > 409< / span >   < span class = "keywordflow" > return< / span > parameterDescriptions.find(parameter) != parameterDescriptions.end();< / div >
< div class = "line" > < a name = "l00410" > < / a > < span class = "lineno" > 410< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a3a7fa36fe69ee8bf3b400983a21ecd24" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a3a7fa36fe69ee8bf3b400983a21ecd24" > ◆ < / a > < / span > HasParam()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool CmdArgsInterface::HasParam < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > key< / em > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will check wether a parameter exists given a key, or not. < / p >
2021-09-05 12:12:03 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00199" > 199< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00200" > < / a > < span class = "lineno" > 200< / span >   {< / div >
< div class = "line" > < a name = "l00201" > < / a > < span class = "lineno" > 201< / span >   < span class = "keywordflow" > return< / span > parameters.find(key) != parameters.end();< / div >
< div class = "line" > < a name = "l00202" > < / a > < span class = "lineno" > 202< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "af5e43c1067fb6c1074d9be3427c7a415" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#af5e43c1067fb6c1074d9be3427c7a415" > ◆ < / a > < / span > operator[]()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > const < a class = "el" href = "classHazelnp_1_1Value.html" > Value< / a > & CmdArgsInterface::operator[] < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > key< / em > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will return the value given a key. < / p >
2021-09-05 12:24:50 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00623" > 623< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00624" > < / a > < span class = "lineno" > 624< / span >   {< / div >
< div class = "line" > < a name = "l00625" > < / a > < span class = "lineno" > 625< / span >   < span class = "comment" > // Throw exception if param is unknown< / span > < / div >
< div class = "line" > < a name = "l00626" > < / a > < span class = "lineno" > 626< / span >   < span class = "keywordflow" > if< / span > (!< a class = "code" href = "classHazelnp_1_1CmdArgsInterface.html#a3a7fa36fe69ee8bf3b400983a21ecd24" > HasParam< / a > (key))< / div >
< div class = "line" > < a name = "l00627" > < / a > < span class = "lineno" > 627< / span >   < span class = "keywordflow" > throw< / span > < a class = "code" href = "classHazelnp_1_1HazelnuppInvalidKeyException.html" > HazelnuppInvalidKeyException< / a > ();< / div >
< div class = "line" > < a name = "l00628" > < / a > < span class = "lineno" > 628< / span >   < / div >
< div class = "line" > < a name = "l00629" > < / a > < span class = "lineno" > 629< / span >   < span class = "keywordflow" > return< / span > *parameters.find(key)-> second-> GetValue();< / div >
< div class = "line" > < a name = "l00630" > < / a > < span class = "lineno" > 630< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a1f4845041e08b3335510de44fafaee19" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a1f4845041e08b3335510de44fafaee19" > ◆ < / a > < / span > Parse()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void CmdArgsInterface::Parse < / td >
< td > (< / td >
< td class = "paramtype" > const int  < / td >
< td class = "paramname" > < em > argc< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const char *const *  < / td >
< td class = "paramname" > < em > argv< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will parse command line arguments. < / p >
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00036" > 36< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00037" > < / a > < span class = "lineno" > 37< / span >   {< / div >
< div class = "line" > < a name = "l00038" > < / a > < span class = "lineno" > 38< / span >   < span class = "keywordflow" > try< / span > < / div >
< div class = "line" > < a name = "l00039" > < / a > < span class = "lineno" > 39< / span >   {< / div >
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > 40< / span >   < span class = "comment" > // Populate raw arguments< / span > < / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   PopulateRawArgs(argc, argv);< / 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 = "comment" > // Expand abbreviations< / span > < / div >
< div class = "line" > < a name = "l00044" > < / a > < span class = "lineno" > 44< / span >   ExpandAbbreviations();< / 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 >   executableName = std::string(rawArgs[0]);< / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > 47< / span >   < / div >
2021-09-05 12:12:03 +02:00
< div class = "line" > < a name = "l00048" > < / a > < span class = "lineno" > 48< / span >   < span class = "comment" > // Read and parse all parameters< / span > < / div >
< div class = "line" > < a name = "l00049" > < / a > < span class = "lineno" > 49< / span >   std::size_t i = 1;< / div >
< div class = "line" > < a name = "l00050" > < / a > < span class = "lineno" > 50< / span >   < span class = "keywordflow" > while< / span > (i < rawArgs.size())< / div >
< div class = "line" > < a name = "l00051" > < / a > < span class = "lineno" > 51< / span >   {< / div >
< div class = "line" > < a name = "l00052" > < / a > < span class = "lineno" > 52< / span >   < span class = "keywordflow" > if< / span > ((rawArgs[i].length() > 2) & & (rawArgs[i].substr(0, 2) == < span class = "stringliteral" > " --" < / span > ))< / 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 >   < a class = "code" href = "classHazelnp_1_1Parameter.html" > Parameter< / a > * param = < span class = "keyword" > nullptr< / span > ;< / div >
< div class = "line" > < a name = "l00055" > < / a > < span class = "lineno" > 55< / span >   i = ParseNextParameter(i, param);< / div >
< div class = "line" > < a name = "l00056" > < / a > < span class = "lineno" > 56< / span >   < / div >
< div class = "line" > < a name = "l00057" > < / a > < span class = "lineno" > 57< / span >   parameters.insert(std::pair< std::string, Parameter*> (param-> < a class = "code" href = "classHazelnp_1_1Parameter.html#a7acd68ce06eec06ab286b1a062f9c8d6" > Key< / a > (), param));< / div >
< div class = "line" > < a name = "l00058" > < / a > < span class = "lineno" > 58< / span >   }< / div >
< div class = "line" > < a name = "l00059" > < / a > < span class = "lineno" > 59< / span >   < span class = "keywordflow" > else< / span > < / div >
< div class = "line" > < a name = "l00060" > < / a > < span class = "lineno" > 60< / span >   i++;< / div >
< div class = "line" > < a name = "l00061" > < / a > < span class = "lineno" > 61< / span >   }< / div >
< div class = "line" > < a name = "l00062" > < / a > < span class = "lineno" > 62< / span >   < / div >
< div class = "line" > < a name = "l00063" > < / a > < span class = "lineno" > 63< / span >   < span class = "comment" > // Apply constraints such as default values, and required parameters.< / span > < / div >
< div class = "line" > < a name = "l00064" > < / a > < span class = "lineno" > 64< / span >   < span class = "comment" > // Types have already been enforced.< / span > < / div >
< div class = "line" > < a name = "l00065" > < / a > < span class = "lineno" > 65< / span >   < span class = "comment" > // Dont apply constraints when we are just printind the param docs< / span > < / div >
< div class = "line" > < a name = "l00066" > < / a > < span class = "lineno" > 66< / span >   < span class = "keywordflow" > if< / span > ((!catchHelp) || (!< a class = "code" href = "classHazelnp_1_1CmdArgsInterface.html#a3a7fa36fe69ee8bf3b400983a21ecd24" > HasParam< / a > (< span class = "stringliteral" > " --help" < / span > )))< / div >
< div class = "line" > < a name = "l00067" > < / a > < span class = "lineno" > 67< / span >   ApplyConstraints();< / div >
< div class = "line" > < a name = "l00068" > < / a > < span class = "lineno" > 68< / span >   }< / div >
< div class = "line" > < a name = "l00069" > < / a > < span class = "lineno" > 69< / span >   < span class = "keywordflow" > catch< / span > (< span class = "keyword" > const< / span > < a class = "code" href = "classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html" > HazelnuppConstraintIncompatibleParameters< / a > & exc)< / div >
< div class = "line" > < a name = "l00070" > < / a > < span class = "lineno" > 70< / span >   {< / div >
< div class = "line" > < a name = "l00071" > < / a > < span class = "lineno" > 71< / span >   < span class = "keywordflow" > if< / span > (crashOnFail)< / div >
< div class = "line" > < a name = "l00072" > < / a > < span class = "lineno" > 72< / span >   {< / div >
< div class = "line" > < a name = "l00073" > < / a > < span class = "lineno" > 73< / span >   std::cout < < < a class = "code" href = "classHazelnp_1_1CmdArgsInterface.html#a9b9bc5c4443799ea847077e9cefb1927" > GenerateDocumentation< / a > () < < std::endl < < std::endl;< / div >
< div class = "line" > < a name = "l00074" > < / a > < span class = "lineno" > 74< / span >   std::cerr < < < span class = "stringliteral" > " Parameter error: " < / span > < < exc.< a class = "code" href = "classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e" > What< / a > () < < std::endl;< / div >
< div class = "line" > < a name = "l00075" > < / a > < span class = "lineno" > 75< / span >   quick_exit(-1000);< / div >
< div class = "line" > < a name = "l00076" > < / a > < span class = "lineno" > 76< / span >   }< / div >
< div class = "line" > < a name = "l00077" > < / a > < span class = "lineno" > 77< / span >   < span class = "keywordflow" > else< / span > < / div >
< div class = "line" > < a name = "l00078" > < / a > < span class = "lineno" > 78< / span >   < span class = "keywordflow" > throw< / span > exc; < span class = "comment" > // yeet< / span > < / div >
< div class = "line" > < a name = "l00079" > < / a > < span class = "lineno" > 79< / span >   }< / div >
< div class = "line" > < a name = "l00080" > < / a > < span class = "lineno" > 80< / span >   < span class = "keywordflow" > catch< / span > (< span class = "keyword" > const< / span > < a class = "code" href = "classHazelnp_1_1HazelnuppConstraintMissingValue.html" > HazelnuppConstraintMissingValue< / a > & exc)< / div >
< div class = "line" > < a name = "l00081" > < / a > < span class = "lineno" > 81< / span >   {< / div >
< div class = "line" > < a name = "l00082" > < / a > < span class = "lineno" > 82< / span >   < span class = "keywordflow" > if< / span > (crashOnFail)< / div >
< div class = "line" > < a name = "l00083" > < / a > < span class = "lineno" > 83< / span >   {< / div >
< div class = "line" > < a name = "l00084" > < / a > < span class = "lineno" > 84< / span >   std::cout < < < a class = "code" href = "classHazelnp_1_1CmdArgsInterface.html#a9b9bc5c4443799ea847077e9cefb1927" > GenerateDocumentation< / a > () < < std::endl < < std::endl;< / div >
< div class = "line" > < a name = "l00085" > < / a > < span class = "lineno" > 85< / span >   std::cerr < < < span class = "stringliteral" > " Parameter error: " < / span > < < exc.< a class = "code" href = "classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e" > What< / a > () < < std::endl;< / div >
< div class = "line" > < a name = "l00086" > < / a > < span class = "lineno" > 86< / span >   quick_exit(-1001);< / div >
< div class = "line" > < a name = "l00087" > < / a > < span class = "lineno" > 87< / span >   }< / div >
< div class = "line" > < a name = "l00088" > < / a > < span class = "lineno" > 88< / span >   < span class = "keywordflow" > else< / span > < / div >
< div class = "line" > < a name = "l00089" > < / a > < span class = "lineno" > 89< / span >   < span class = "keywordflow" > throw< / span > exc; < span class = "comment" > // yeet< / span > < / div >
< div class = "line" > < a name = "l00090" > < / a > < span class = "lineno" > 90< / span >   }< / div >
< div class = "line" > < a name = "l00091" > < / a > < span class = "lineno" > 91< / span >   < span class = "keywordflow" > catch< / span > (< span class = "keyword" > const< / span > < a class = "code" href = "classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html" > HazelnuppConstraintTypeMissmatch< / a > & exc)< / div >
< 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 >   < span class = "keywordflow" > if< / span > (crashOnFail)< / div >
< div class = "line" > < a name = "l00094" > < / a > < span class = "lineno" > 94< / span >   {< / div >
< div class = "line" > < a name = "l00095" > < / a > < span class = "lineno" > 95< / span >   std::cout < < < a class = "code" href = "classHazelnp_1_1CmdArgsInterface.html#a9b9bc5c4443799ea847077e9cefb1927" > GenerateDocumentation< / a > () < < std::endl < < std::endl;< / div >
< div class = "line" > < a name = "l00096" > < / a > < span class = "lineno" > 96< / span >   std::cerr < < < span class = "stringliteral" > " Parameter error: " < / span > < < exc.< a class = "code" href = "classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e" > What< / a > () < < std::endl;< / div >
< div class = "line" > < a name = "l00097" > < / a > < span class = "lineno" > 97< / span >   quick_exit(-1002);< / div >
< div class = "line" > < a name = "l00098" > < / a > < span class = "lineno" > 98< / span >   }< / div >
< div class = "line" > < a name = "l00099" > < / a > < span class = "lineno" > 99< / span >   < span class = "keywordflow" > else< / span > < / div >
< div class = "line" > < a name = "l00100" > < / a > < span class = "lineno" > 100< / span >   < span class = "keywordflow" > throw< / span > exc; < span class = "comment" > // yeet< / span > < / div >
< 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 >   < span class = "keywordflow" > catch< / span > (< span class = "keyword" > const< / span > < a class = "code" href = "classHazelnp_1_1HazelnuppConstraintException.html" > HazelnuppConstraintException< / a > & exc)< / div >
< div class = "line" > < a name = "l00103" > < / a > < span class = "lineno" > 103< / span >   {< / div >
< div class = "line" > < a name = "l00104" > < / a > < span class = "lineno" > 104< / span >   < span class = "keywordflow" > if< / span > (crashOnFail)< / div >
< div class = "line" > < a name = "l00105" > < / a > < span class = "lineno" > 105< / span >   {< / div >
< div class = "line" > < a name = "l00106" > < / a > < span class = "lineno" > 106< / span >   std::cout < < < a class = "code" href = "classHazelnp_1_1CmdArgsInterface.html#a9b9bc5c4443799ea847077e9cefb1927" > GenerateDocumentation< / a > () < < std::endl < < std::endl;< / div >
< div class = "line" > < a name = "l00107" > < / a > < span class = "lineno" > 107< / span >   std::cerr < < < span class = "stringliteral" > " Parameter error: " < / span > < < exc.< a class = "code" href = "classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e" > What< / a > () < < std::endl;< / div >
< div class = "line" > < a name = "l00108" > < / a > < span class = "lineno" > 108< / span >   quick_exit(-1003);< / div >
< div class = "line" > < a name = "l00109" > < / a > < span class = "lineno" > 109< / span >   }< / div >
< div class = "line" > < a name = "l00110" > < / a > < span class = "lineno" > 110< / span >   < span class = "keywordflow" > else< / span > < / div >
< div class = "line" > < a name = "l00111" > < / a > < span class = "lineno" > 111< / span >   < span class = "keywordflow" > throw< / span > exc; < span class = "comment" > // yeet< / span > < / div >
< div class = "line" > < a name = "l00112" > < / a > < span class = "lineno" > 112< / span >   }< / div >
< div class = "line" > < a name = "l00113" > < / a > < span class = "lineno" > 113< / span >   < span class = "keywordflow" > catch< / span > (< span class = "keyword" > const< / span > < a class = "code" href = "classHazelnp_1_1HazelnuppException.html" > HazelnuppException< / a > & exc)< / div >
< div class = "line" > < a name = "l00114" > < / a > < span class = "lineno" > 114< / span >   {< / div >
< div class = "line" > < a name = "l00115" > < / a > < span class = "lineno" > 115< / span >   < span class = "keywordflow" > if< / span > (crashOnFail)< / div >
< div class = "line" > < a name = "l00116" > < / a > < span class = "lineno" > 116< / span >   {< / div >
< div class = "line" > < a name = "l00117" > < / a > < span class = "lineno" > 117< / span >   std::cout < < < a class = "code" href = "classHazelnp_1_1CmdArgsInterface.html#a9b9bc5c4443799ea847077e9cefb1927" > GenerateDocumentation< / a > () < < std::endl < < std::endl;< / div >
< div class = "line" > < a name = "l00118" > < / a > < span class = "lineno" > 118< / span >   std::cerr < < < span class = "stringliteral" > " Parameter error: " < / span > < < exc.< a class = "code" href = "classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e" > What< / a > () < < std::endl;< / div >
< div class = "line" > < a name = "l00119" > < / a > < span class = "lineno" > 119< / span >   quick_exit(-1004);< / div >
< div class = "line" > < a name = "l00120" > < / a > < span class = "lineno" > 120< / span >   }< / div >
< div class = "line" > < a name = "l00121" > < / a > < span class = "lineno" > 121< / span >   < span class = "keywordflow" > else< / span > < / div >
< div class = "line" > < a name = "l00122" > < / a > < span class = "lineno" > 122< / span >   < span class = "keywordflow" > throw< / span > exc; < span class = "comment" > // yeet< / span > < / div >
< div class = "line" > < a name = "l00123" > < / a > < span class = "lineno" > 123< / span >   }< / div >
< div class = "line" > < a name = "l00124" > < / a > < span class = "lineno" > 124< / span >   < / div >
< div class = "line" > < a name = "l00125" > < / a > < span class = "lineno" > 125< / span >   < span class = "comment" > // Catch --help parameter< / span > < / div >
< div class = "line" > < a name = "l00126" > < / a > < span class = "lineno" > 126< / span >   < span class = "keywordflow" > if< / span > ((catchHelp) & & (< a class = "code" href = "classHazelnp_1_1CmdArgsInterface.html#a3a7fa36fe69ee8bf3b400983a21ecd24" > HasParam< / a > (< span class = "stringliteral" > " --help" < / span > )))< / div >
< div class = "line" > < a name = "l00127" > < / a > < span class = "lineno" > 127< / span >   {< / div >
< div class = "line" > < a name = "l00128" > < / a > < span class = "lineno" > 128< / span >   std::cout < < < a class = "code" href = "classHazelnp_1_1CmdArgsInterface.html#a9b9bc5c4443799ea847077e9cefb1927" > GenerateDocumentation< / a > () < < std::endl;< / div >
< div class = "line" > < a name = "l00129" > < / a > < span class = "lineno" > 129< / span >   quick_exit(0);< / div >
< div class = "line" > < a name = "l00130" > < / a > < span class = "lineno" > 130< / span >   }< / div >
< div class = "line" > < a name = "l00131" > < / a > < span class = "lineno" > 131< / span >   < / div >
< div class = "line" > < a name = "l00132" > < / a > < span class = "lineno" > 132< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00133" > < / a > < span class = "lineno" > 133< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "aaccf591a74408aeb4363033fe8cb2224" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aaccf591a74408aeb4363033fe8cb2224" > ◆ < / a > < / span > RegisterAbbreviation()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void CmdArgsInterface::RegisterAbbreviation < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > abbrev< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > target< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will register an abbreviation (like -f for – force) < / p >
2021-09-05 12:24:50 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00632" > 632< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00633" > < / a > < span class = "lineno" > 633< / span >   {< / div >
< div class = "line" > < a name = "l00634" > < / a > < span class = "lineno" > 634< / span >   parameterAbreviations.insert(std::pair< std::string, std::string> (abbrev, target));< / div >
< div class = "line" > < a name = "l00635" > < / a > < span class = "lineno" > 635< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00636" > < / a > < span class = "lineno" > 636< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "aa30222df012f357455f90e3620346bb2" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aa30222df012f357455f90e3620346bb2" > ◆ < / a > < / span > RegisterConstraint()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void CmdArgsInterface::RegisterConstraint < / 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 < a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint< / a > &   < / td >
< td class = "paramname" > < em > constraint< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Will register a constraint for a parameter. < / p >
2021-09-05 12:12:03 +02:00
< p > IMPORTANT: Any parameter can only have ONE constraint. Applying a new one will overwrite the old one! Construct the < a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint< / a > struct yourself to combine Require, TypeSafety and Incompatibilities! You can also use the < a class = "el" href = "structHazelnp_1_1ParamConstraint.html" > ParamConstraint< / a > constructor! < / p >
2021-09-05 12:24:50 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00663" > 663< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00664" > < / a > < span class = "lineno" > 664< / span >   {< / div >
< div class = "line" > < a name = "l00665" > < / a > < span class = "lineno" > 665< / span >   < span class = "comment" > // Magic syntax, wooo< / span > < / div >
< div class = "line" > < a name = "l00666" > < / a > < span class = "lineno" > 666< / span >   (parameterConstraints[key] = constraint).key = key;< / div >
< div class = "line" > < a name = "l00667" > < / a > < span class = "lineno" > 667< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00668" > < / a > < span class = "lineno" > 668< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a6589d2e818ba32f2a3e5b5a6a5e2bf1e" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a6589d2e818ba32f2a3e5b5a6a5e2bf1e" > ◆ < / a > < / span > RegisterDescription()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void Hazelnp::CmdArgsInterface::RegisterDescription < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > parameter< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > description< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Willl register a short description for a parameter. < / p >
< p > < br / >
Will overwrite existing descriptions for that parameter. < / p >
2021-09-05 12:12:03 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00390" > 390< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00391" > < / a > < span class = "lineno" > 391< / span >   {< / div >
< div class = "line" > < a name = "l00392" > < / a > < span class = "lineno" > 392< / span >   parameterDescriptions[parameter] = description;< / div >
< div class = "line" > < a name = "l00393" > < / a > < span class = "lineno" > 393< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00394" > < / a > < span class = "lineno" > 394< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a67ba6cb3176884c85dd56fc9084ab66a" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a67ba6cb3176884c85dd56fc9084ab66a" > ◆ < / a > < / span > SetBriefDescription()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void CmdArgsInterface::SetBriefDescription < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > description< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Sets a brief description of the application to be automatically added to the documentation. < / p >
2021-09-05 12:12:03 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00379" > 379< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00380" > < / a > < span class = "lineno" > 380< / span >   {< / div >
< div class = "line" > < a name = "l00381" > < / a > < span class = "lineno" > 381< / span >   briefDescription = description;< / div >
< div class = "line" > < a name = "l00382" > < / a > < span class = "lineno" > 382< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00383" > < / a > < span class = "lineno" > 383< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "abf553ed4acabf9e1db357715bc10533c" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#abf553ed4acabf9e1db357715bc10533c" > ◆ < / a > < / span > SetCatchHelp()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void CmdArgsInterface::SetCatchHelp < / td >
< td > (< / td >
< td class = "paramtype" > bool  < / td >
< td class = "paramname" > < em > catchHelp< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Sets whether the < a class = "el" href = "classHazelnp_1_1CmdArgsInterface.html" title = "The main class to interface with." > CmdArgsInterface< / a > should automatically catch the – help parameter, print the parameter documentation to stdout, and exit or not. < / p >
2021-09-05 12:12:03 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00368" > 368< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00369" > < / a > < span class = "lineno" > 369< / span >   {< / div >
< div class = "line" > < a name = "l00370" > < / a > < span class = "lineno" > 370< / span >   this-> catchHelp = catchHelp;< / div >
< div class = "line" > < a name = "l00371" > < / a > < span class = "lineno" > 371< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00372" > < / a > < span class = "lineno" > 372< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< a id = "a16a3a02f77d240d8cf51cd4ee1797113" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a16a3a02f77d240d8cf51cd4ee1797113" > ◆ < / a > < / span > SetCrashOnFail()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void CmdArgsInterface::SetCrashOnFail < / td >
< td > (< / td >
< td class = "paramtype" > bool  < / td >
< td class = "paramname" > < em > crashOnFail< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsing, or not. < / p >
2021-09-05 12:24:50 +02:00
< p class = "definition" > Definition at line < a class = "el" href = "CmdArgsInterface_8cpp_source.html#l00676" > 676< / a > of file < a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > .< / p >
< div class = "fragment" > < div class = "line" > < a name = "l00677" > < / a > < span class = "lineno" > 677< / span >   {< / div >
< div class = "line" > < a name = "l00678" > < / a > < span class = "lineno" > 678< / span >   this-> crashOnFail = crashOnFail;< / div >
< div class = "line" > < a name = "l00679" > < / a > < span class = "lineno" > 679< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00680" > < / a > < span class = "lineno" > 680< / span >   }< / div >
2021-06-08 14:02:49 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
< li > Hazelnupp/< a class = "el" href = "CmdArgsInterface_8h_source.html" > CmdArgsInterface.h< / a > < / li >
< li > Hazelnupp/< a class = "el" href = "CmdArgsInterface_8cpp_source.html" > CmdArgsInterface.cpp< / a > < / li >
< / ul >
< / div > <!-- contents -->
2021-09-05 12:12:03 +02:00
< div class = "ttc" id = "aclassHazelnp_1_1HazelnuppConstraintIncompatibleParameters_html" > < div class = "ttname" > < a href = "classHazelnp_1_1HazelnuppConstraintIncompatibleParameters.html" > Hazelnp::HazelnuppConstraintIncompatibleParameters< / a > < / div > < div class = "ttdoc" > Gets thrown when a parameter constrained to be incompatible with other parameters gets supplied along...< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "HazelnuppException_8h_source.html#l00101" > HazelnuppException.h:101< / a > < / div > < / div >
2021-09-05 12:24:50 +02:00
< div class = "ttc" id = "aclassHazelnp_1_1CmdArgsInterface_html_a58b81709e631cee5f3db3f3f48611fe9" > < div class = "ttname" > < a href = "classHazelnp_1_1CmdArgsInterface.html#a58b81709e631cee5f3db3f3f48611fe9" > Hazelnp::CmdArgsInterface::HasAbbreviation< / a > < / div > < div class = "ttdeci" > bool HasAbbreviation(const std::string & abbrev) const< / div > < div class = "ttdoc" > Will check wether or not an abbreviation is registered.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "CmdArgsInterface_8cpp_source.html#l00646" > CmdArgsInterface.cpp:646< / a > < / div > < / div >
2021-06-08 14:02:49 +02:00
< div class = "ttc" id = "aclassHazelnp_1_1HazelnuppInvalidKeyException_html" > < div class = "ttname" > < a href = "classHazelnp_1_1HazelnuppInvalidKeyException.html" > Hazelnp::HazelnuppInvalidKeyException< / a > < / div > < div class = "ttdoc" > Gets thrown when an non-existent key gets dereferenced.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "HazelnuppException_8h_source.html#l00029" > HazelnuppException.h:29< / a > < / div > < / div >
< div class = "ttc" id = "aclassHazelnp_1_1HazelnuppException_html_aa86c415a0f2b4ea5f11892145d1ea83e" > < div class = "ttname" > < a href = "classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e" > Hazelnp::HazelnuppException::What< / a > < / div > < div class = "ttdeci" > const std::string & What() const< / div > < div class = "ttdoc" > Will return an error message.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "HazelnuppException_8h_source.html#l00018" > HazelnuppException.h:18< / a > < / div > < / div >
2021-09-05 12:12:03 +02:00
< div class = "ttc" id = "aclassHazelnp_1_1HazelnuppConstraintException_html" > < div class = "ttname" > < a href = "classHazelnp_1_1HazelnuppConstraintException.html" > Hazelnp::HazelnuppConstraintException< / a > < / div > < div class = "ttdoc" > Gets thrown something bad happens because of parameter constraints.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "HazelnuppException_8h_source.html#l00047" > HazelnuppException.h:47< / a > < / div > < / div >
< div class = "ttc" id = "aclassHazelnp_1_1CmdArgsInterface_html_a3a7fa36fe69ee8bf3b400983a21ecd24" > < div class = "ttname" > < a href = "classHazelnp_1_1CmdArgsInterface.html#a3a7fa36fe69ee8bf3b400983a21ecd24" > Hazelnp::CmdArgsInterface::HasParam< / a > < / div > < div class = "ttdeci" > bool HasParam(const std::string & key) const< / div > < div class = "ttdoc" > Will check wether a parameter exists given a key, or not.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "CmdArgsInterface_8cpp_source.html#l00199" > CmdArgsInterface.cpp:199< / a > < / div > < / div >
2021-06-08 14:02:49 +02:00
< div class = "ttc" id = "aclassHazelnp_1_1Parameter_html" > < div class = "ttname" > < a href = "classHazelnp_1_1Parameter.html" > Hazelnp::Parameter< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "Parameter_8h_source.html#l00008" > Parameter.h:8< / a > < / div > < / div >
< div class = "ttc" id = "anamespaceHazelnp_1_1Placeholders_html_a90536f0cd5261b18da736e954c6b8b79" > < div class = "ttname" > < a href = "namespaceHazelnp_1_1Placeholders.html#a90536f0cd5261b18da736e954c6b8b79" > Hazelnp::Placeholders::g_emptyString< / a > < / div > < div class = "ttdeci" > static const std::string g_emptyString< / div > < div class = "ttdoc" > The only purpose of this is to provide the ability to return an empty string as an error for std::str...< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "Placeholders_8h_source.html#l00009" > Placeholders.h:9< / a > < / div > < / div >
2021-09-05 12:12:03 +02:00
< div class = "ttc" id = "aclassHazelnp_1_1CmdArgsInterface_html_a5003f826ee31c6365bf4b6e8b2c8d9f1" > < div class = "ttname" > < a href = "classHazelnp_1_1CmdArgsInterface.html#a5003f826ee31c6365bf4b6e8b2c8d9f1" > Hazelnp::CmdArgsInterface::HasDescription< / a > < / div > < div class = "ttdeci" > bool HasDescription(const std::string & parameter) const< / div > < div class = "ttdoc" > Returns whether or not a given parameter has a registered description.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "CmdArgsInterface_8cpp_source.html#l00407" > CmdArgsInterface.cpp:407< / a > < / div > < / div >
< div class = "ttc" id = "aclassHazelnp_1_1HazelnuppException_html" > < div class = "ttname" > < a href = "classHazelnp_1_1HazelnuppException.html" > Hazelnp::HazelnuppException< / a > < / div > < div class = "ttdoc" > Generic hazelnupp exception.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "HazelnuppException_8h_source.html#l00011" > HazelnuppException.h:11< / a > < / div > < / div >
2021-06-08 14:02:49 +02:00
< div class = "ttc" id = "aclassHazelnp_1_1Parameter_html_a7acd68ce06eec06ab286b1a062f9c8d6" > < div class = "ttname" > < a href = "classHazelnp_1_1Parameter.html#a7acd68ce06eec06ab286b1a062f9c8d6" > Hazelnp::Parameter::Key< / a > < / div > < div class = "ttdeci" > const std::string & Key() const< / div > < div class = "ttdoc" > Will return the key of this parameter.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "Parameter_8cpp_source.html#l00021" > Parameter.cpp:21< / a > < / div > < / div >
< div class = "ttc" id = "aclassHazelnp_1_1HazelnuppConstraintMissingValue_html" > < div class = "ttname" > < a href = "classHazelnp_1_1HazelnuppConstraintMissingValue.html" > Hazelnp::HazelnuppConstraintMissingValue< / a > < / div > < div class = "ttdoc" > Gets thrown when a parameter constrained to be required is not provided, and has no default value set...< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "HazelnuppException_8h_source.html#l00080" > HazelnuppException.h:80< / a > < / div > < / div >
< div class = "ttc" id = "aclassHazelnp_1_1HazelnuppConstraintTypeMissmatch_html" > < div class = "ttname" > < a href = "classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html" > Hazelnp::HazelnuppConstraintTypeMissmatch< / a > < / div > < div class = "ttdoc" > Gets thrown when a parameter is of a type that does not match the required type, and is not convertib...< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "HazelnuppException_8h_source.html#l00056" > HazelnuppException.h:56< / a > < / div > < / div >
< div class = "ttc" id = "aclassHazelnp_1_1CmdArgsInterface_html_a1f4845041e08b3335510de44fafaee19" > < div class = "ttname" > < a href = "classHazelnp_1_1CmdArgsInterface.html#a1f4845041e08b3335510de44fafaee19" > Hazelnp::CmdArgsInterface::Parse< / a > < / div > < div class = "ttdeci" > void Parse(const int argc, const char *const *argv)< / div > < div class = "ttdoc" > Will parse command line arguments.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "CmdArgsInterface_8cpp_source.html#l00036" > CmdArgsInterface.cpp:36< / a > < / div > < / div >
2021-09-05 12:12:03 +02:00
< div class = "ttc" id = "aclassHazelnp_1_1CmdArgsInterface_html_a9b9bc5c4443799ea847077e9cefb1927" > < div class = "ttname" > < a href = "classHazelnp_1_1CmdArgsInterface.html#a9b9bc5c4443799ea847077e9cefb1927" > Hazelnp::CmdArgsInterface::GenerateDocumentation< / a > < / div > < div class = "ttdeci" > std::string GenerateDocumentation() const< / div > < div class = "ttdoc" > Will generate a text-based documentation suited to show the user, for example on – < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "CmdArgsInterface_8cpp_source.html#l00425" > CmdArgsInterface.cpp:425< / a > < / div > < / div >
2021-06-08 14:02:49 +02:00
< div class = "ttc" id = "anamespaceHazelnp_html_a7fb1e5ad9e2ecb6c0025beb19f11621b" > < div class = "ttname" > < a href = "namespaceHazelnp.html#a7fb1e5ad9e2ecb6c0025beb19f11621b" > Hazelnp::DataTypeToString< / a > < / div > < div class = "ttdeci" > static std::string DataTypeToString(DATA_TYPE type)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "DataType_8h_source.html#l00017" > DataType.h:17< / a > < / div > < / div >
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
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-08 14:02:49 +02:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
< / a > 1.8.17
< / small > < / address >
< / body >
< / html >
