Built mkdocs

This commit is contained in:
Leonetienne
2021-06-04 02:48:22 +02:00
parent 723c62a124
commit a88bbfe1fa
102 changed files with 467 additions and 320 deletions

View File

@@ -83,31 +83,42 @@ $(function() {
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;ostream&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;{</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 floating point values (uses long double)</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_1FloatValue.html"> 9</a></span>&#160; <span class="keyword">class </span><a class="code" href="classHazelnp_1_1FloatValue.html">FloatValue</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_1FloatValue.html#a6bb35564e3331a3feb57b08caad0df44">FloatValue</a>(<span class="keyword">const</span> <span class="keywordtype">long</span> <span class="keywordtype">double</span>&amp; value);</div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classHazelnp_1_1FloatValue.html#a02e61e453c3e8e32d4d527799c11fd4a"> 13</a></span>&#160; <a class="code" href="classHazelnp_1_1FloatValue.html#a02e61e453c3e8e32d4d527799c11fd4a">~FloatValue</a>()<span class="keyword"> override </span>{};</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <a class="code" href="classHazelnp_1_1Value.html">Value</a>* <a class="code" href="classHazelnp_1_1FloatValue.html#ab071916339a0d5a266d821ebbc8f12b0">Deepcopy</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; std::string <a class="code" href="classHazelnp_1_1FloatValue.html#a6c9a4b70a7618252f56d9062c483531c">GetAsOsString</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">const</span> <span class="keywordtype">long</span> <span class="keywordtype">double</span>&amp; <a class="code" href="classHazelnp_1_1FloatValue.html#a2ad79d8bfe75e45120d1fce132a89b8f">GetValue</a>() <span class="keyword">const</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_1FloatValue.html#ab071916339a0d5a266d821ebbc8f12b0">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_1FloatValue.html#a6c9a4b70a7618252f56d9062c483531c">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 return the raw value</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"></span> <span class="keyword">const</span> <span class="keywordtype">long</span> <span class="keywordtype">double</span>&amp; <a class="code" href="classHazelnp_1_1FloatValue.html#a2ad79d8bfe75e45120d1fce132a89b8f">GetValue</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">operator</span> <span class="keywordtype">long</span> double() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">operator</span> double() <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="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordtype">long</span> <span class="keywordtype">long</span> <span class="keywordtype">int</span> <a class="code" href="classHazelnp_1_1FloatValue.html#a762520d504d4564c48cf3bbefbb0f183">GetInt64</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classHazelnp_1_1FloatValue.html#a565741e80cd99a4d2af861ddc3c2dc99">GetInt32</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordtype">long</span> <span class="keywordtype">double</span> <a class="code" href="classHazelnp_1_1FloatValue.html#add33b370ef691ccb2f0957d0fe4ef6f9">GetFloat64</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">double</span> <a class="code" href="classHazelnp_1_1FloatValue.html#a1653ab3f4fa1700cf1b618ac6552ea81">GetFloat32</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; std::string <a class="code" href="classHazelnp_1_1FloatValue.html#afd5d078683f410cb9d450c61f12f250d">GetString</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">const</span> std::vector&lt;Value*&gt;&amp; <a class="code" href="classHazelnp_1_1FloatValue.html#a60b2698f28f1aacac0b67b6453c89fd1">GetList</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> //! Will return the data as a long long int</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</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_1FloatValue.html#a762520d504d4564c48cf3bbefbb0f183">GetInt64</a>() <span class="keyword">const override</span>;<span class="comment"></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> //! Will return the data as an int</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classHazelnp_1_1FloatValue.html#a565741e80cd99a4d2af861ddc3c2dc99">GetInt32</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> //! Will return the data as a long double</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"></span> <span class="keywordtype">long</span> <span class="keywordtype">double</span> <a class="code" href="classHazelnp_1_1FloatValue.html#add33b370ef691ccb2f0957d0fe4ef6f9">GetFloat64</a>() <span class="keyword">const override</span>;<span class="comment"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> //! Will return the data as a double</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="classHazelnp_1_1FloatValue.html#a1653ab3f4fa1700cf1b618ac6552ea81">GetFloat32</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"> //! Will return the data as a string</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"></span> std::string <a class="code" href="classHazelnp_1_1FloatValue.html#afd5d078683f410cb9d450c61f12f250d">GetString</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> //! Throws HazelnuppValueNotConvertibleException</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"></span> <span class="keyword">const</span> std::vector&lt;Value*&gt;&amp; <a class="code" href="classHazelnp_1_1FloatValue.html#a60b2698f28f1aacac0b67b6453c89fd1">GetList</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">long</span> <span class="keywordtype">double</span> value;</div>
@@ -131,7 +142,7 @@ $(function() {
<div class="ttc" id="aclassHazelnp_1_1FloatValue_html_a565741e80cd99a4d2af861ddc3c2dc99"><div class="ttname"><a href="classHazelnp_1_1FloatValue.html#a565741e80cd99a4d2af861ddc3c2dc99">Hazelnp::FloatValue::GetInt32</a></div><div class="ttdeci">int GetInt32() const override</div><div class="ttdoc">Will return the data as an int.</div><div class="ttdef"><b>Definition:</b> <a href="FloatValue_8cpp_source.html#l00049">FloatValue.cpp:49</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 4 2021 02:43:55 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Fri Jun 4 2021 02:48:01 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>