2021-06-03 13:43:05 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" />
< meta http-equiv = "X-UA-Compatible" content = "IE=9" />
< meta name = "generator" content = "Doxygen 1.8.17" />
< meta name = "viewport" content = "width=device-width, initial-scale=1" />
< title > Leonetienne/Hazelnupp: Hazelnp::Parameter 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_1Parameter.html" > Parameter</ a ></ li > </ ul >
</ div >
</ div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions</ a > |
< a href = "#friends" > Friends</ a > |
< a href = "classHazelnp_1_1Parameter-members.html" > List of all members</ a > </ div >
< div class = "headertitle" >
< div class = "title" > Hazelnp::Parameter Class Reference</ div > </ div >
</ div > <!--header-->
< div class = "contents" >
< p >< code > #include < < a class = "el" href = "Parameter_8h_source.html" > Parameter.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:a0c9faefc26cc9d8c886ef71e39e2f90c" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classHazelnp_1_1Parameter.html#a0c9faefc26cc9d8c886ef71e39e2f90c" > Parameter</ a > (const std::string & key, const < a class = "el" href = "classHazelnp_1_1Value.html" > Value</ a > *value)</ td ></ tr >
< tr class = "separator:a0c9faefc26cc9d8c886ef71e39e2f90c" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a6e2ade42a712f1d3675653329266e42d" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classHazelnp_1_1Parameter.html#a6e2ade42a712f1d3675653329266e42d" > ~Parameter</ a > ()</ td ></ tr >
< tr class = "separator:a6e2ade42a712f1d3675653329266e42d" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a7acd68ce06eec06ab286b1a062f9c8d6" >< td class = "memItemLeft" align = "right" valign = "top" > const std::string &  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classHazelnp_1_1Parameter.html#a7acd68ce06eec06ab286b1a062f9c8d6" > Key</ a > () const</ td ></ tr >
< tr class = "memdesc:a7acd68ce06eec06ab286b1a062f9c8d6" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Will return the key of this parameter. < a href = "classHazelnp_1_1Parameter.html#a7acd68ce06eec06ab286b1a062f9c8d6" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a7acd68ce06eec06ab286b1a062f9c8d6" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a4ab8ba022bde4a0175e5ceb8e3a598af" >< 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_1Parameter.html#a4ab8ba022bde4a0175e5ceb8e3a598af" > GetValue</ a > () const</ td ></ tr >
< tr class = "memdesc:a4ab8ba022bde4a0175e5ceb8e3a598af" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Will return the value of this parameter. < a href = "classHazelnp_1_1Parameter.html#a4ab8ba022bde4a0175e5ceb8e3a598af" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a4ab8ba022bde4a0175e5ceb8e3a598af" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
</ table >< table class = "memberdecls" >
< tr class = "heading" >< td colspan = "2" >< h2 class = "groupheader" >< a name = "friends" ></ a >
Friends</ h2 ></ td ></ tr >
< tr class = "memitem:a11b3529badcbf99b46262772472495c7" >< td class = "memItemLeft" align = "right" valign = "top" > std::ostream &  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classHazelnp_1_1Parameter.html#a11b3529badcbf99b46262772472495c7" > operator<< </ a > (std::ostream & os, const < a class = "el" href = "classHazelnp_1_1Parameter.html" > Parameter</ a > & p)</ td ></ tr >
< tr class = "separator:a11b3529badcbf99b46262772472495c7" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
</ table >
< a name = "details" id = "details" ></ a >< h2 class = "groupheader" > Detailed Description</ h2 >
< div class = "textblock" >
< p class = "definition" > Definition at line < a class = "el" href = "Parameter_8h_source.html#l00008" > 8</ a > of file < a class = "el" href = "Parameter_8h_source.html" > Parameter.h</ a > .</ p >
</ div >< h2 class = "groupheader" > Constructor & Destructor Documentation</ h2 >
< a id = "a0c9faefc26cc9d8c886ef71e39e2f90c" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a0c9faefc26cc9d8c886ef71e39e2f90c" > ◆ </ a ></ span > Parameter()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > Parameter::Parameter </ 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 = "classHazelnp_1_1Value.html" > Value</ a > *  </ td >
< td class = "paramname" >< em > value</ em >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ td >
< td class = "mlabels-right" >
< span class = "mlabels" >< span class = "mlabel" > explicit</ span ></ span > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p class = "definition" > Definition at line < a class = "el" href = "Parameter_8cpp_source.html#l00005" > 5</ a > of file < a class = "el" href = "Parameter_8cpp_source.html" > Parameter.cpp</ a > .</ p >
< div class = "fragment" >< div class = "line" >< a name = "l00006" ></ a >< span class = "lineno" > 6</ span >   :</ div >
< div class = "line" >< a name = "l00007" ></ a >< span class = "lineno" > 7</ span >   key{ key }</ div >
< div class = "line" >< a name = "l00008" ></ a >< span class = "lineno" > 8</ span >   {</ div >
< div class = "line" >< a name = "l00009" ></ a >< span class = "lineno" > 9</ span >   this-> value = value-> < a class = "code" href = "classHazelnp_1_1Value.html#aec9bc16f1630734c79bc69e916622dc6" > Deepcopy</ a > ();</ div >
< div class = "line" >< a name = "l00010" ></ a >< span class = "lineno" > 10</ span >   < span class = "keywordflow" > return</ span > ;</ div >
< div class = "line" >< a name = "l00011" ></ a >< span class = "lineno" > 11</ span >   }</ div >
</ div > <!-- fragment -->
</ div >
</ div >
< a id = "a6e2ade42a712f1d3675653329266e42d" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a6e2ade42a712f1d3675653329266e42d" > ◆ </ a ></ span > ~Parameter()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > Parameter::~Parameter </ 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 = "Parameter_8cpp_source.html#l00013" > 13</ a > of file < a class = "el" href = "Parameter_8cpp_source.html" > Parameter.cpp</ a > .</ p >
< div class = "fragment" >< div class = "line" >< a name = "l00014" ></ a >< span class = "lineno" > 14</ span >   {</ div >
< div class = "line" >< a name = "l00015" ></ a >< span class = "lineno" > 15</ span >   < span class = "keyword" > delete</ span > value;</ div >
< div class = "line" >< a name = "l00016" ></ a >< span class = "lineno" > 16</ span >   value = < span class = "keyword" > nullptr</ span > ;</ div >
< div class = "line" >< a name = "l00017" ></ a >< span class = "lineno" > 17</ span >   </ div >
< div class = "line" >< a name = "l00018" ></ a >< span class = "lineno" > 18</ span >   < span class = "keywordflow" > return</ span > ;</ div >
< div class = "line" >< a name = "l00019" ></ a >< span class = "lineno" > 19</ span >   }</ div >
</ div > <!-- fragment -->
</ div >
</ div >
< h2 class = "groupheader" > Member Function Documentation</ h2 >
< a id = "a4ab8ba022bde4a0175e5ceb8e3a598af" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a4ab8ba022bde4a0175e5ceb8e3a598af" > ◆ </ a ></ span > GetValue()</ 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 > * Parameter::GetValue </ td >
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
< td > const</ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Will return the value of this parameter. </ p >
< p class = "definition" > Definition at line < a class = "el" href = "Parameter_8cpp_source.html#l00026" > 26</ a > of file < a class = "el" href = "Parameter_8cpp_source.html" > Parameter.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" > return</ span > value;</ div >
< div class = "line" >< a name = "l00029" ></ a >< span class = "lineno" > 29</ span >   }</ div >
</ div > <!-- fragment -->
</ div >
</ div >
< a id = "a7acd68ce06eec06ab286b1a062f9c8d6" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a7acd68ce06eec06ab286b1a062f9c8d6" > ◆ </ a ></ span > Key()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > const std::string & Parameter::Key </ td >
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
< td > const</ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Will return the key of this parameter. </ p >
< p class = "definition" > Definition at line < a class = "el" href = "Parameter_8cpp_source.html#l00021" > 21</ a > of file < a class = "el" href = "Parameter_8cpp_source.html" > Parameter.cpp</ a > .</ p >
< div class = "fragment" >< div class = "line" >< a name = "l00022" ></ a >< span class = "lineno" > 22</ span >   {</ div >
< div class = "line" >< a name = "l00023" ></ a >< span class = "lineno" > 23</ span >   < span class = "keywordflow" > return</ span > key;</ div >
< div class = "line" >< a name = "l00024" ></ a >< span class = "lineno" > 24</ span >   }</ div >
</ div > <!-- fragment -->
</ div >
</ div >
< h2 class = "groupheader" > Friends And Related Function Documentation</ h2 >
< a id = "a11b3529badcbf99b46262772472495c7" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a11b3529badcbf99b46262772472495c7" > ◆ </ a ></ span > operator<< </ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > std::ostream& operator<< </ td >
< td > (</ td >
< td class = "paramtype" > std::ostream &  </ td >
< td class = "paramname" >< em > os</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > const < a class = "el" href = "classHazelnp_1_1Parameter.html" > Parameter</ a > &  </ td >
< td class = "paramname" >< em > p</ em >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ td >
< td class = "mlabels-right" >
< span class = "mlabels" >< span class = "mlabel" > friend</ span ></ span > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p class = "definition" > Definition at line < a class = "el" href = "Parameter_8h_source.html#l00020" > 20</ a > of file < a class = "el" href = "Parameter_8h_source.html" > Parameter.h</ 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 >   < span class = "keywordflow" > return</ span > os << < span class = "stringliteral" > " { Key: \"" </ span > << p.key << < span class = "stringliteral" > " \" -> " </ span > << *p.value << < span class = "stringliteral" > " }" </ span > ;</ div >
< div class = "line" >< a name = "l00023" ></ a >< span class = "lineno" > 23</ span >   }</ div >
</ div > <!-- fragment -->
</ div >
</ div >
< hr /> The documentation for this class was generated from the following files:< ul >
< li > Hazelnupp/< a class = "el" href = "Parameter_8h_source.html" > Parameter.h</ a ></ li >
< li > Hazelnupp/< a class = "el" href = "Parameter_8cpp_source.html" > Parameter.cpp</ a ></ li >
</ ul >
</ div > <!-- contents -->
< div class = "ttc" id = "aclassHazelnp_1_1Value_html_aec9bc16f1630734c79bc69e916622dc6" >< div class = "ttname" >< a href = "classHazelnp_1_1Value.html#aec9bc16f1630734c79bc69e916622dc6" > Hazelnp::Value::Deepcopy</ a ></ div >< div class = "ttdeci" > virtual Value * Deepcopy() const =0</ div >< div class = "ttdoc" > Will return a deeopopy of this object.</ div ></ div >
<!-- start footer part -->
< hr class = "footer" />< address class = "footer" >< small >
2021-06-04 13:53:59 +02:00
Generated on Fri Jun 4 2021 13:53:39 for Leonetienne/Hazelnupp by   < a href = "http://www.doxygen.org/index.html" >
2021-06-03 13:43:05 +02:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" />
</ a > 1.8.17
</ small ></ address >
</ body >
</ html >
