Hazelnupp/docs/ListValue_8h_source.html
2021-06-04 13:53:59 +02:00

154 lines
18 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/ListValue.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&amp;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&amp;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">ListValue.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="ListValue_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>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Value_8h.html">Value.h</a>&quot;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceHazelnp.html">Hazelnp</a></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;{<span class="comment"></span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> /** Specializations for list values (uses std::vector&lt;Value*&gt;)</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="classHazelnp_1_1ListValue.html"> 9</a></span>&#160; <span class="keyword">class </span><a class="code" href="classHazelnp_1_1ListValue.html">ListValue</a> : <span class="keyword">public</span> <a class="code" href="classHazelnp_1_1Value.html">Value</a></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; {</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <a class="code" href="classHazelnp_1_1ListValue.html#a6082aaa506b31496720a168da8ab2708">ListValue</a>();</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <a class="code" href="classHazelnp_1_1ListValue.html#a91f1450f299d46b3301774a6b4eb6c18">~ListValue</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> //! Will return a deeopopy of this object</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"></span> <a class="code" href="classHazelnp_1_1Value.html">Value</a>* <a class="code" href="classHazelnp_1_1ListValue.html#a51c89ff315026b03d908345c6f58169d">Deepcopy</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<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>&#160;<span class="comment"></span> std::string <a class="code" href="classHazelnp_1_1ListValue.html#a5b1f8af329e48c5469fee16634b7889c">GetAsOsString</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> //! Will add this value to the list</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classHazelnp_1_1ListValue.html#af8787d266aa353d3f96e2c76cce76c41">AddValue</a>(<span class="keyword">const</span> <a class="code" href="classHazelnp_1_1Value.html">Value</a>* value);</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> //! Will return the raw value</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"></span> <span class="keyword">const</span> std::vector&lt;Value*&gt;&amp; <a class="code" href="classHazelnp_1_1ListValue.html#a7907ae7433e4011157f1b31dd5339702">GetValue</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">operator</span> std::vector&lt;Value*&gt;() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> //! Throws HazelnuppValueNotConvertibleException</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"></span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <span class="keywordtype">int</span> <a class="code" href="classHazelnp_1_1ListValue.html#a9a7a1161ddeb3e56eaafee5f10f75995">GetInt64</a>() <span class="keyword">const override</span>;<span class="comment"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> //! Throws HazelnuppValueNotConvertibleException</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classHazelnp_1_1ListValue.html#a565c2b86fcfb3a13de29e59d95a358e7">GetInt32</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> //! Throws HazelnuppValueNotConvertibleException</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment"></span> <span class="keywordtype">long</span> <span class="keywordtype">double</span> <a class="code" href="classHazelnp_1_1ListValue.html#a571178db1c9d23f6c685ea8898dbb60e">GetFloat64</a>() <span class="keyword">const override</span>;<span class="comment"></span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"> //! Throws HazelnuppValueNotConvertibleException</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="classHazelnp_1_1ListValue.html#a637fec02ed7f7325554e494fc7cd4e86">GetFloat32</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"> //! Throws HazelnuppValueNotConvertibleException</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"></span> std::string <a class="code" href="classHazelnp_1_1ListValue.html#aeaf80c07236045a77d72349ebcfc3b89">GetString</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"> //! Will return this values list</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"></span> <span class="keyword">const</span> std::vector&lt;Value*&gt;&amp; <a class="code" href="classHazelnp_1_1ListValue.html#ad578d9088c0375cd9b9c6658e5d9ba1f">GetList</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; std::vector&lt;Value*&gt; value;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; };</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassHazelnp_1_1ListValue_html_a5b1f8af329e48c5469fee16634b7889c"><div class="ttname"><a href="classHazelnp_1_1ListValue.html#a5b1f8af329e48c5469fee16634b7889c">Hazelnp::ListValue::GetAsOsString</a></div><div class="ttdeci">std::string GetAsOsString() const override</div><div class="ttdoc">Will return a string suitable for an std::ostream;.</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8cpp_source.html#l00044">ListValue.cpp:44</a></div></div>
<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_1ListValue_html_a637fec02ed7f7325554e494fc7cd4e86"><div class="ttname"><a href="classHazelnp_1_1ListValue.html#a637fec02ed7f7325554e494fc7cd4e86">Hazelnp::ListValue::GetFloat32</a></div><div class="ttdeci">double GetFloat32() const override</div><div class="ttdoc">Throws HazelnuppValueNotConvertibleException.</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8cpp_source.html#l00084">ListValue.cpp:84</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1ListValue_html_aeaf80c07236045a77d72349ebcfc3b89"><div class="ttname"><a href="classHazelnp_1_1ListValue.html#aeaf80c07236045a77d72349ebcfc3b89">Hazelnp::ListValue::GetString</a></div><div class="ttdeci">std::string GetString() const override</div><div class="ttdoc">Throws HazelnuppValueNotConvertibleException.</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8cpp_source.html#l00089">ListValue.cpp:89</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1ListValue_html_ad578d9088c0375cd9b9c6658e5d9ba1f"><div class="ttname"><a href="classHazelnp_1_1ListValue.html#ad578d9088c0375cd9b9c6658e5d9ba1f">Hazelnp::ListValue::GetList</a></div><div class="ttdeci">const std::vector&lt; Value * &gt; &amp; GetList() const override</div><div class="ttdoc">Will return this values list.</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8cpp_source.html#l00094">ListValue.cpp:94</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1ListValue_html_a7907ae7433e4011157f1b31dd5339702"><div class="ttname"><a href="classHazelnp_1_1ListValue.html#a7907ae7433e4011157f1b31dd5339702">Hazelnp::ListValue::GetValue</a></div><div class="ttdeci">const std::vector&lt; Value * &gt; &amp; GetValue() const</div><div class="ttdoc">Will return the raw value.</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8cpp_source.html#l00039">ListValue.cpp:39</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_1ListValue_html_a9a7a1161ddeb3e56eaafee5f10f75995"><div class="ttname"><a href="classHazelnp_1_1ListValue.html#a9a7a1161ddeb3e56eaafee5f10f75995">Hazelnp::ListValue::GetInt64</a></div><div class="ttdeci">long long int GetInt64() const override</div><div class="ttdoc">Throws HazelnuppValueNotConvertibleException.</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8cpp_source.html#l00069">ListValue.cpp:69</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1ListValue_html_a565c2b86fcfb3a13de29e59d95a358e7"><div class="ttname"><a href="classHazelnp_1_1ListValue.html#a565c2b86fcfb3a13de29e59d95a358e7">Hazelnp::ListValue::GetInt32</a></div><div class="ttdeci">int GetInt32() const override</div><div class="ttdoc">Throws HazelnuppValueNotConvertibleException.</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8cpp_source.html#l00074">ListValue.cpp:74</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1ListValue_html_af8787d266aa353d3f96e2c76cce76c41"><div class="ttname"><a href="classHazelnp_1_1ListValue.html#af8787d266aa353d3f96e2c76cce76c41">Hazelnp::ListValue::AddValue</a></div><div class="ttdeci">void AddValue(const Value *value)</div><div class="ttdoc">Will add this value to the list.</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8cpp_source.html#l00033">ListValue.cpp:33</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1ListValue_html_a91f1450f299d46b3301774a6b4eb6c18"><div class="ttname"><a href="classHazelnp_1_1ListValue.html#a91f1450f299d46b3301774a6b4eb6c18">Hazelnp::ListValue::~ListValue</a></div><div class="ttdeci">~ListValue() override</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8cpp_source.html#l00013">ListValue.cpp:13</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1ListValue_html_a6082aaa506b31496720a168da8ab2708"><div class="ttname"><a href="classHazelnp_1_1ListValue.html#a6082aaa506b31496720a168da8ab2708">Hazelnp::ListValue::ListValue</a></div><div class="ttdeci">ListValue()</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8cpp_source.html#l00007">ListValue.cpp:7</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1ListValue_html_a51c89ff315026b03d908345c6f58169d"><div class="ttname"><a href="classHazelnp_1_1ListValue.html#a51c89ff315026b03d908345c6f58169d">Hazelnp::ListValue::Deepcopy</a></div><div class="ttdeci">Value * Deepcopy() const override</div><div class="ttdoc">Will return a deeopopy of this object.</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8cpp_source.html#l00023">ListValue.cpp:23</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1ListValue_html_a571178db1c9d23f6c685ea8898dbb60e"><div class="ttname"><a href="classHazelnp_1_1ListValue.html#a571178db1c9d23f6c685ea8898dbb60e">Hazelnp::ListValue::GetFloat64</a></div><div class="ttdeci">long double GetFloat64() const override</div><div class="ttdoc">Throws HazelnuppValueNotConvertibleException.</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8cpp_source.html#l00079">ListValue.cpp:79</a></div></div>
<div class="ttc" id="aclassHazelnp_1_1ListValue_html"><div class="ttname"><a href="classHazelnp_1_1ListValue.html">Hazelnp::ListValue</a></div><div class="ttdoc">Specializations for list values (uses std::vector&lt;Value*&gt;)</div><div class="ttdef"><b>Definition:</b> <a href="ListValue_8h_source.html#l00009">ListValue.h:9</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 13:53:38 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>