157 lines
19 KiB
HTML
157 lines
19 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/Value.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">Value.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="Value_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="DataType_8h.html">DataType.h</a>"</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include <ostream></span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <vector></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> {<span class="comment"></span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> /** Abstract class for values</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="classHazelnp_1_1Value.html"> 10</a></span>  <span class="keyword">class </span><a class="code" href="classHazelnp_1_1Value.html">Value</a></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  {</div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classHazelnp_1_1Value.html#a977dea61ee5b00b6c6d77ad6ad2c8d4c"> 13</a></span>  <span class="keyword">virtual</span> <a class="code" href="classHazelnp_1_1Value.html#a977dea61ee5b00b6c6d77ad6ad2c8d4c">~Value</a>() {};</div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> //! Will return a deeopopy of this object</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classHazelnp_1_1Value.html">Value</a>* <a class="code" href="classHazelnp_1_1Value.html#aec9bc16f1630734c79bc69e916622dc6">Deepcopy</a>() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> //! Will return a string suitable for an std::ostream</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span> <span class="keyword">virtual</span> std::string <a class="code" href="classHazelnp_1_1Value.html#ae1fdc694ed1c2b3080ad3929efda0a0e">GetAsOsString</a>() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> //! Will return the data type of this value</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span> <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="classHazelnp_1_1Value.html#adbb80bf6d455a316e6e5103353429993">GetDataType</a>() <span class="keyword">const</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"><a class="line" href="classHazelnp_1_1Value.html#ad29db86c4a2dec5bc8d0006031b07211"> 24</a></span>  <span class="keyword">friend</span> std::ostream& <a class="code" href="classHazelnp_1_1Value.html#ad29db86c4a2dec5bc8d0006031b07211">operator<< </a>(std::ostream& os, <span class="keyword">const</span> <a class="code" href="classHazelnp_1_1Value.html">Value</a>& v)</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordflow">return</span> os << v.<a class="code" href="classHazelnp_1_1Value.html#ae1fdc694ed1c2b3080ad3929efda0a0e">GetAsOsString</a>();</div>
|
|
<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="comment"></span> </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> //! Will attempt to return the integer data (long long)</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <span class="keywordtype">int</span> <a class="code" href="classHazelnp_1_1Value.html#a92d75905211e964cb900bdc868ed12a7">GetInt64</a>() <span class="keyword">const</span> = 0;<span class="comment"></span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> //! Will attempt to return the integer data (int)</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classHazelnp_1_1Value.html#a2cb73333bdeca657dfbf6c8b2e50a5ef">GetInt32</a>() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> //! Will attempt to return the floating-point data (long double)</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">long</span> <span class="keywordtype">double</span> <a class="code" href="classHazelnp_1_1Value.html#af645b9d78970d102360be37fc18e9e8a">GetFloat64</a>() <span class="keyword">const</span> = 0;<span class="comment"></span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> //! Will attempt to return the floating-point data (double)</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="classHazelnp_1_1Value.html#a64eeb2943ccea6e16ce4e6f53a6e9b6d">GetFloat32</a>() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> //! Will attempt to return the string-data</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span> <span class="keyword">virtual</span> std::string <a class="code" href="classHazelnp_1_1Value.html#a1446705c062026f03866d0f452c39501">GetString</a>() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> //! Will attempt to return the list-data</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keyword">const</span> std::vector<Value*>& <a class="code" href="classHazelnp_1_1Value.html#a358092f951e817cd2a878225b5b1c869">GetList</a>() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="classHazelnp_1_1Value.html#a8455d65bb2d939e850d6772dfbf8bfec">Value</a>(<a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="classHazelnp_1_1Value.html#ae5760a30c237095db595c466372e3c23">type</a>);</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classHazelnp_1_1Value.html#ae5760a30c237095db595c466372e3c23"> 48</a></span>  <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="classHazelnp_1_1Value.html#ae5760a30c237095db595c466372e3c23">type</a>;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  };</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> }</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="aDataType_8h_html"><div class="ttname"><a href="DataType_8h.html">DataType.h</a></div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1Value_html_a64eeb2943ccea6e16ce4e6f53a6e9b6d"><div class="ttname"><a href="classHazelnp_1_1Value.html#a64eeb2943ccea6e16ce4e6f53a6e9b6d">Hazelnp::Value::GetFloat32</a></div><div class="ttdeci">virtual double GetFloat32() const =0</div><div class="ttdoc">Will attempt to return the floating-point data (double)</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_1Value_html_a2cb73333bdeca657dfbf6c8b2e50a5ef"><div class="ttname"><a href="classHazelnp_1_1Value.html#a2cb73333bdeca657dfbf6c8b2e50a5ef">Hazelnp::Value::GetInt32</a></div><div class="ttdeci">virtual int GetInt32() const =0</div><div class="ttdoc">Will attempt to return the integer data (int)</div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1Value_html_a1446705c062026f03866d0f452c39501"><div class="ttname"><a href="classHazelnp_1_1Value.html#a1446705c062026f03866d0f452c39501">Hazelnp::Value::GetString</a></div><div class="ttdeci">virtual std::string GetString() const =0</div><div class="ttdoc">Will attempt to return the string-data.</div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1Value_html_a977dea61ee5b00b6c6d77ad6ad2c8d4c"><div class="ttname"><a href="classHazelnp_1_1Value.html#a977dea61ee5b00b6c6d77ad6ad2c8d4c">Hazelnp::Value::~Value</a></div><div class="ttdeci">virtual ~Value()</div><div class="ttdef"><b>Definition:</b> <a href="Value_8h_source.html#l00013">Value.h:13</a></div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1Value_html_a8455d65bb2d939e850d6772dfbf8bfec"><div class="ttname"><a href="classHazelnp_1_1Value.html#a8455d65bb2d939e850d6772dfbf8bfec">Hazelnp::Value::Value</a></div><div class="ttdeci">Value(DATA_TYPE type)</div><div class="ttdef"><b>Definition:</b> <a href="Value_8cpp_source.html#l00005">Value.cpp:5</a></div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1Value_html_adbb80bf6d455a316e6e5103353429993"><div class="ttname"><a href="classHazelnp_1_1Value.html#adbb80bf6d455a316e6e5103353429993">Hazelnp::Value::GetDataType</a></div><div class="ttdeci">DATA_TYPE GetDataType() const</div><div class="ttdoc">Will return the data type of this value.</div><div class="ttdef"><b>Definition:</b> <a href="Value_8cpp_source.html#l00012">Value.cpp:12</a></div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1Value_html_a92d75905211e964cb900bdc868ed12a7"><div class="ttname"><a href="classHazelnp_1_1Value.html#a92d75905211e964cb900bdc868ed12a7">Hazelnp::Value::GetInt64</a></div><div class="ttdeci">virtual long long int GetInt64() const =0</div><div class="ttdoc">Will attempt to return the integer data (long long)</div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1Value_html_ae1fdc694ed1c2b3080ad3929efda0a0e"><div class="ttname"><a href="classHazelnp_1_1Value.html#ae1fdc694ed1c2b3080ad3929efda0a0e">Hazelnp::Value::GetAsOsString</a></div><div class="ttdeci">virtual std::string GetAsOsString() const =0</div><div class="ttdoc">Will return a string suitable for an std::ostream.</div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1Value_html_a358092f951e817cd2a878225b5b1c869"><div class="ttname"><a href="classHazelnp_1_1Value.html#a358092f951e817cd2a878225b5b1c869">Hazelnp::Value::GetList</a></div><div class="ttdeci">virtual const std::vector< Value * > & GetList() const =0</div><div class="ttdoc">Will attempt to return the list-data.</div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1Value_html_ad29db86c4a2dec5bc8d0006031b07211"><div class="ttname"><a href="classHazelnp_1_1Value.html#ad29db86c4a2dec5bc8d0006031b07211">Hazelnp::Value::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &os, const Value &v)</div><div class="ttdef"><b>Definition:</b> <a href="Value_8h_source.html#l00024">Value.h:24</a></div></div>
|
|
<div class="ttc" id="anamespaceHazelnp_html_a07b61ac22ce9cd97eceebdf9487f803f"><div class="ttname"><a href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">Hazelnp::DATA_TYPE</a></div><div class="ttdeci">DATA_TYPE</div><div class="ttdoc">The different data types a paramater can be.</div><div class="ttdef"><b>Definition:</b> <a href="DataType_8h_source.html#l00008">DataType.h:8</a></div></div>
|
|
<div class="ttc" id="aclassHazelnp_1_1Value_html_ae5760a30c237095db595c466372e3c23"><div class="ttname"><a href="classHazelnp_1_1Value.html#ae5760a30c237095db595c466372e3c23">Hazelnp::Value::type</a></div><div class="ttdeci">DATA_TYPE type</div><div class="ttdef"><b>Definition:</b> <a href="Value_8h_source.html#l00048">Value.h:48</a></div></div>
|
|
<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>
|
|
<div class="ttc" id="aclassHazelnp_1_1Value_html_af645b9d78970d102360be37fc18e9e8a"><div class="ttname"><a href="classHazelnp_1_1Value.html#af645b9d78970d102360be37fc18e9e8a">Hazelnp::Value::GetFloat64</a></div><div class="ttdeci">virtual long double GetFloat64() const =0</div><div class="ttdoc">Will attempt to return the floating-point data (long double)</div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Fri Jun 4 2021 02:48:01 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>
|