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

@@ -84,32 +84,43 @@ $(function() {
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<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>&#160;{</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;{<span class="comment"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> /** Abstract class for values</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<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>&#160; <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>&#160; {</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <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>&#160; <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>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <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>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <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>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <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="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> <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>&#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> <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>&#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 data type of this value</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<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>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classHazelnp_1_1Value.html#ad29db86c4a2dec5bc8d0006031b07211"> 24</a></span>&#160; <span class="keyword">friend</span> std::ostream&amp; <a class="code" href="classHazelnp_1_1Value.html#ad29db86c4a2dec5bc8d0006031b07211">operator&lt;&lt; </a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code" href="classHazelnp_1_1Value.html">Value</a>&amp; v)</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">return</span> os &lt;&lt; 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>&#160; }</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <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;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <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>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <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;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <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>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <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>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">virtual</span> <span class="keyword">const</span> std::vector&lt;Value*&gt;&amp; <a class="code" href="classHazelnp_1_1Value.html#a358092f951e817cd2a878225b5b1c869">GetList</a>() <span class="keyword">const</span> = 0;</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"> //! Will attempt to return the integer data (long long)</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"> //! Will attempt to return the string-data</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"> //! Will attempt to return the list-data</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"></span> <span class="keyword">virtual</span> <span class="keyword">const</span> std::vector&lt;Value*&gt;&amp; <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>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <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>
@@ -137,7 +148,7 @@ $(function() {
<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: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>