documentation for v1.0

This commit is contained in:
HRN
2025-01-10 13:02:07 +03:30
parent 53c7b23728
commit 0acd52f1b1
16893 changed files with 448346 additions and 285977 deletions

View File

@ -144,7 +144,7 @@ $(document).ready(function(){initNavTree('dynamicLinkLibs_8cpp_source.html','');
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; }</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a>(1)&lt;&lt; <span class="stringliteral">&quot;libs are &quot;</span>&lt;&lt; <a class="code" href="streams_8hpp.html#a37a406f400cfe49d19e51bfcc34cd2d3">greenText</a>(libNames)&lt;&lt;<a class="code" href="streams_8hpp.html#a04db65a6cb5a45695ea75cce1b5d7a10">endREPORT</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a>(1)&lt;&lt; <span class="stringliteral">&quot;libs are &quot;</span>&lt;&lt; <a class="code" href="iOstream_8hpp.html#ac569b1e93bab8b809907065244b11fd2">Green_Text</a>(libNames)&lt;&lt;<a class="code" href="streams_8hpp.html#a1861619f2a6e102d0043a98577c8c9e8">END_REPORT</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">for</span>(<span class="keyword">auto</span> libName:libNames)</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; {</div>
@ -175,7 +175,7 @@ $(document).ready(function(){initNavTree('dynamicLinkLibs_8cpp_source.html','');
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classpFlow_1_1dynamicLinkLibs.html#ae1659a2a86d7e045f9f4a4483427d7d5"> 69</a></span>&#160;<span class="keywordtype">void</span>* <a class="code" href="classpFlow_1_1dynamicLinkLibs.html#ae1659a2a86d7e045f9f4a4483427d7d5">pFlow::dynamicLinkLibs::open</a>(<a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> libName)</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;{</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a>(2)&lt;&lt;<span class="stringliteral">&quot;Loading &quot;</span>&lt;&lt; <a class="code" href="streams_8hpp.html#a37a406f400cfe49d19e51bfcc34cd2d3">greenText</a>(libName)&lt;&lt;<a class="code" href="streams_8hpp.html#a04db65a6cb5a45695ea75cce1b5d7a10">endREPORT</a>;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a>(2)&lt;&lt;<span class="stringliteral">&quot;Loading &quot;</span>&lt;&lt; <a class="code" href="iOstream_8hpp.html#ac569b1e93bab8b809907065244b11fd2">Green_Text</a>(libName)&lt;&lt;<a class="code" href="streams_8hpp.html#a1861619f2a6e102d0043a98577c8c9e8">END_REPORT</a>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">void</span>* handle = dlopen(libName.c_str(), RTLD_LAZY|RTLD_GLOBAL);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
@ -189,24 +189,24 @@ $(document).ready(function(){initNavTree('dynamicLinkLibs_8cpp_source.html','');
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aiOstream_8hpp_html_ac569b1e93bab8b809907065244b11fd2"><div class="ttname"><a href="iOstream_8hpp.html#ac569b1e93bab8b809907065244b11fd2">Green_Text</a></div><div class="ttdeci">#define Green_Text(text)</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00042">iOstream.hpp:42</a></div></div>
<div class="ttc" id="aclasspFlow_1_1List_html"><div class="ttname"><a href="classpFlow_1_1List.html">pFlow::List&lt; word &gt;</a></div></div>
<div class="ttc" id="astreams_8hpp_html_a04db65a6cb5a45695ea75cce1b5d7a10"><div class="ttname"><a href="streams_8hpp.html#a04db65a6cb5a45695ea75cce1b5d7a10">endREPORT</a></div><div class="ttdeci">#define endREPORT</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00041">streams.hpp:41</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dynamicLinkLibs_html_acd99b0a201ee4830e87164945077d9ff"><div class="ttname"><a href="classpFlow_1_1dynamicLinkLibs.html#acd99b0a201ee4830e87164945077d9ff">pFlow::dynamicLinkLibs::dynamicLinkLibs</a></div><div class="ttdeci">dynamicLinkLibs(const dictionary &amp;dict, word libList=&quot;libs&quot;)</div><div class="ttdef"><b>Definition:</b> <a href="dynamicLinkLibs_8cpp_source.html#l00028">dynamicLinkLibs.cpp:28</a></div></div>
<div class="ttc" id="aerror_8hpp_html_aad22a1cd3b45a97ac8cd195f06fe61fe"><div class="ttname"><a href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a></div><div class="ttdeci">#define fatalExit</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00057">error.hpp:57</a></div></div>
<div class="ttc" id="aerror_8hpp_html_aad22a1cd3b45a97ac8cd195f06fe61fe"><div class="ttname"><a href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a></div><div class="ttdeci">#define fatalExit</div><div class="ttdoc">Fatal exit.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00098">error.hpp:98</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dynamicLinkLibs_html_a8fdc16479233e2680939a03baf67d470"><div class="ttname"><a href="classpFlow_1_1dynamicLinkLibs.html#a8fdc16479233e2680939a03baf67d470">pFlow::dynamicLinkLibs::libs_</a></div><div class="ttdeci">wordHashMap&lt; void * &gt; libs_</div><div class="ttdef"><b>Definition:</b> <a href="dynamicLinkLibs_8hpp_source.html#l00036">dynamicLinkLibs.hpp:36</a></div></div>
<div class="ttc" id="astreams_8hpp_html_aeb765df06121339620670437d217fec8"><div class="ttname"><a href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a></div><div class="ttdeci">#define REPORT(n)</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00040">streams.hpp:40</a></div></div>
<div class="ttc" id="aerror_8hpp_html_a889d5e8bf195a24964ffb883bcb2fc3b"><div class="ttname"><a href="error_8hpp.html#a889d5e8bf195a24964ffb883bcb2fc3b">warningInFunction</a></div><div class="ttdeci">#define warningInFunction</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00055">error.hpp:55</a></div></div>
<div class="ttc" id="astreams_8hpp_html_aeb765df06121339620670437d217fec8"><div class="ttname"><a href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a></div><div class="ttdeci">#define REPORT(n)</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00039">streams.hpp:39</a></div></div>
<div class="ttc" id="aerror_8hpp_html_a889d5e8bf195a24964ffb883bcb2fc3b"><div class="ttname"><a href="error_8hpp.html#a889d5e8bf195a24964ffb883bcb2fc3b">warningInFunction</a></div><div class="ttdeci">#define warningInFunction</div><div class="ttdoc">Report a warning.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00095">error.hpp:95</a></div></div>
<div class="ttc" id="aList_8hpp_html"><div class="ttname"><a href="List_8hpp.html">List.hpp</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00063">builtinTypes.hpp:63</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream &amp; endl(iOstream &amp;os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00320">iOstream.hpp:320</a></div></div>
<div class="ttc" id="astreams_8hpp_html_a37a406f400cfe49d19e51bfcc34cd2d3"><div class="ttname"><a href="streams_8hpp.html#a37a406f400cfe49d19e51bfcc34cd2d3">greenText</a></div><div class="ttdeci">#define greenText(text)</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00032">streams.hpp:32</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a7ca8222c7de98177fe1e8e9d2615f77d"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a7ca8222c7de98177fe1e8e9d2615f77d">pFlow::dictionary::containsDataEntry</a></div><div class="ttdeci">bool containsDataEntry(const word &amp;name) const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00748">dictionary.cpp:748</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00064">builtinTypes.hpp:64</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream &amp; endl(iOstream &amp;os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00341">iOstream.hpp:341</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a7ca8222c7de98177fe1e8e9d2615f77d"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a7ca8222c7de98177fe1e8e9d2615f77d">pFlow::dictionary::containsDataEntry</a></div><div class="ttdeci">bool containsDataEntry(const word &amp;name) const</div><div class="ttdoc">check if a data entry exist</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00761">dictionary.cpp:761</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dynamicLinkLibs_html_ae1659a2a86d7e045f9f4a4483427d7d5"><div class="ttname"><a href="classpFlow_1_1dynamicLinkLibs.html#ae1659a2a86d7e045f9f4a4483427d7d5">pFlow::dynamicLinkLibs::open</a></div><div class="ttdeci">void * open(word libName)</div><div class="ttdef"><b>Definition:</b> <a href="dynamicLinkLibs_8cpp_source.html#l00069">dynamicLinkLibs.cpp:69</a></div></div>
<div class="ttc" id="astreams_8hpp_html_a1861619f2a6e102d0043a98577c8c9e8"><div class="ttname"><a href="streams_8hpp.html#a1861619f2a6e102d0043a98577c8c9e8">END_REPORT</a></div><div class="ttdeci">#define END_REPORT</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00040">streams.hpp:40</a></div></div>
<div class="ttc" id="astreams_8hpp_html"><div class="ttname"><a href="streams_8hpp.html">streams.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a523bcff98ab38f3c5961e56eeb0b1d47"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a523bcff98ab38f3c5961e56eeb0b1d47">pFlow::dictionary::getVal</a></div><div class="ttdeci">T getVal(const word &amp;keyword) const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00309">dictionary.hpp:309</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a523bcff98ab38f3c5961e56eeb0b1d47"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a523bcff98ab38f3c5961e56eeb0b1d47">pFlow::dictionary::getVal</a></div><div class="ttdeci">T getVal(const word &amp;keyword) const</div><div class="ttdoc">get the value of data entry</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00379">dictionary.hpp:379</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dynamicLinkLibs_html_a50cf59949b8a18ac16364a2ae3700368"><div class="ttname"><a href="classpFlow_1_1dynamicLinkLibs.html#a50cf59949b8a18ac16364a2ae3700368">pFlow::dynamicLinkLibs::~dynamicLinkLibs</a></div><div class="ttdeci">~dynamicLinkLibs()</div><div class="ttdef"><b>Definition:</b> <a href="dynamicLinkLibs_8cpp_source.html#l00058">dynamicLinkLibs.cpp:58</a></div></div>
<div class="ttc" id="adynamicLinkLibs_8hpp_html"><div class="ttname"><a href="dynamicLinkLibs_8hpp.html">dynamicLinkLibs.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html"><div class="ttname"><a href="classpFlow_1_1dictionary.html">pFlow::dictionary</a></div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00038">dictionary.hpp:38</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html"><div class="ttname"><a href="classpFlow_1_1dictionary.html">pFlow::dictionary</a></div><div class="ttdoc">Dictionary holds a set of data entries or sub-dictionaries that are enclosed in a curely braces or ar...</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00067">dictionary.hpp:67</a></div></div>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_cd7a5046d028e114fc17b2ebc2bd02d2.html">phasicFlow</a></li><li class="navelem"><a class="el" href="dir_8a09dd5b7fce343a5c545316ddba4e1b.html">repository</a></li><li class="navelem"><a class="el" href="dir_0bc712f0655242ad4a9b6418726e892d.html">systemControl</a></li><li class="navelem"><a class="el" href="dynamicLinkLibs_8cpp.html">dynamicLinkLibs.cpp</a></li>