128 lines
11 KiB
HTML
128 lines
11 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Leonetienne/Hazelnupp: Hazelnupp/Parameter.h Source File</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="dir_0202e1e26df2e040f4dc3d434eecf04c.html">Hazelnupp</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Parameter.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="Parameter_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#include "<a class="code" href="Value_8h.html">Value.h</a>"</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <ostream></span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="keyword">namespace </span><a class="code" href="namespaceHazelnp.html">Hazelnp</a></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> {</div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="classHazelnp_1_1Parameter.html"> 8</a></span>  <span class="keyword">class </span><a class="code" href="classHazelnp_1_1Parameter.html">Parameter</a></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  {</div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  <span class="keyword">explicit</span> <a class="code" href="classHazelnp_1_1Parameter.html#a0c9faefc26cc9d8c886ef71e39e2f90c">Parameter</a>(<span class="keyword">const</span> std::string& key, <span class="keyword">const</span> <a class="code" href="classHazelnp_1_1Value.html">Value</a>* value);</div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  <a class="code" href="classHazelnp_1_1Parameter.html#a6e2ade42a712f1d3675653329266e42d">~Parameter</a>();</div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> //! Will return the key of this parameter</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span> <span class="keyword">const</span> std::string& <a class="code" href="classHazelnp_1_1Parameter.html#a7acd68ce06eec06ab286b1a062f9c8d6">Key</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> //! Will return the value of this parameter</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span> <span class="keyword">const</span> <a class="code" href="classHazelnp_1_1Value.html">Value</a>* <a class="code" href="classHazelnp_1_1Parameter.html#a4ab8ba022bde4a0175e5ceb8e3a598af">GetValue</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classHazelnp_1_1Parameter.html#a11b3529badcbf99b46262772472495c7"> 20</a></span>  <span class="keyword">friend</span> std::ostream& <a class="code" href="classHazelnp_1_1Parameter.html#a11b3529badcbf99b46262772472495c7">operator<< </a>(std::ostream& os, <span class="keyword">const</span> <a class="code" href="classHazelnp_1_1Parameter.html">Parameter</a>& p)</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  {</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordflow">return</span> 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 class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  std::string key;</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="classHazelnp_1_1Value.html">Hazelnp::Value</a>* value;</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  };</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> }</div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="anamespaceHazelnp_html"><div class="ttname"><a href="namespaceHazelnp.html">Hazelnp</a></div><div class="ttdef"><b>Definition:</b> <a href="DataType_8h_source.html#l00004">DataType.h:4</a></div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1Parameter_html_a6e2ade42a712f1d3675653329266e42d"><div class="ttname"><a href="classHazelnp_1_1Parameter.html#a6e2ade42a712f1d3675653329266e42d">Hazelnp::Parameter::~Parameter</a></div><div class="ttdeci">~Parameter()</div><div class="ttdef"><b>Definition:</b> <a href="Parameter_8cpp_source.html#l00013">Parameter.cpp:13</a></div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1Value_html"><div class="ttname"><a href="classHazelnp_1_1Value.html">Hazelnp::Value</a></div><div class="ttdoc">Abstract class for values.</div><div class="ttdef"><b>Definition:</b> <a href="Value_8h_source.html#l00010">Value.h:10</a></div></div>
|
|
<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="aclassHazelnp_1_1Parameter_html_a4ab8ba022bde4a0175e5ceb8e3a598af"><div class="ttname"><a href="classHazelnp_1_1Parameter.html#a4ab8ba022bde4a0175e5ceb8e3a598af">Hazelnp::Parameter::GetValue</a></div><div class="ttdeci">const Value * GetValue() const</div><div class="ttdoc">Will return the value of this parameter.</div><div class="ttdef"><b>Definition:</b> <a href="Parameter_8cpp_source.html#l00026">Parameter.cpp:26</a></div></div>
|
|
<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_1Parameter_html_a0c9faefc26cc9d8c886ef71e39e2f90c"><div class="ttname"><a href="classHazelnp_1_1Parameter.html#a0c9faefc26cc9d8c886ef71e39e2f90c">Hazelnp::Parameter::Parameter</a></div><div class="ttdeci">Parameter(const std::string &key, const Value *value)</div><div class="ttdef"><b>Definition:</b> <a href="Parameter_8cpp_source.html#l00005">Parameter.cpp:5</a></div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1Parameter_html_a11b3529badcbf99b46262772472495c7"><div class="ttname"><a href="classHazelnp_1_1Parameter.html#a11b3529badcbf99b46262772472495c7">Hazelnp::Parameter::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &os, const Parameter &p)</div><div class="ttdef"><b>Definition:</b> <a href="Parameter_8h_source.html#l00020">Parameter.h:20</a></div></div>
|
|
<div class="ttc" id="aValue_8h_html"><div class="ttname"><a href="Value_8h.html">Value.h</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Fri Jun 4 2021 15:58:56 for Leonetienne/Hazelnupp by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|