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

@ -184,15 +184,15 @@ $(document).ready(function(){initNavTree('setFieldList_8cpp_source.html',''); in
</div><!-- doc-content -->
<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="asetFieldList_8hpp_html"><div class="ttname"><a href="setFieldList_8hpp.html">setFieldList.hpp</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_1setFieldList_html_a4c69c45fdc17483b13be9b2b1a83c3fb"><div class="ttname"><a href="classpFlow_1_1setFieldList.html#a4c69c45fdc17483b13be9b2b1a83c3fb">pFlow::setFieldList::writeSetFieldList</a></div><div class="ttdeci">bool writeSetFieldList(dictionary &amp;dict) const</div><div class="ttdef"><b>Definition:</b> <a href="setFieldList_8cpp_source.html#l00038">setFieldList.cpp:38</a></div></div>
<div class="ttc" id="aclasspFlow_1_1setFieldList_html_aa69848b595397b66f2be84cd1424cae1"><div class="ttname"><a href="classpFlow_1_1setFieldList.html#aa69848b595397b66f2be84cd1424cae1">pFlow::setFieldList::setFieldList</a></div><div class="ttdeci">setFieldList(const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="setFieldList_8cpp_source.html#l00047">setFieldList.cpp:47</a></div></div>
<div class="ttc" id="aclasspFlow_1_1setFieldList_html_a6964e9f1f100001543fdb044fa7fc896"><div class="ttname"><a href="classpFlow_1_1setFieldList.html#a6964e9f1f100001543fdb044fa7fc896">pFlow::setFieldList::write</a></div><div class="ttdeci">bool write(dictionary &amp;dict) const</div><div class="ttdef"><b>Definition:</b> <a href="setFieldList_8cpp_source.html#l00070">setFieldList.cpp:70</a></div></div>
<div class="ttc" id="aclasspFlow_1_1setFieldList_html_a6ce0c64db98eb6144d363dbfc86104eb"><div class="ttname"><a href="classpFlow_1_1setFieldList.html#a6ce0c64db98eb6144d363dbfc86104eb">pFlow::setFieldList::read</a></div><div class="ttdeci">bool read(const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="setFieldList_8cpp_source.html#l00061">setFieldList.cpp:61</a></div></div>
<div class="ttc" id="aclasspFlow_1_1setFieldList_html_a371caec5118a7107207dfbe970b00d34"><div class="ttname"><a href="classpFlow_1_1setFieldList.html#a371caec5118a7107207dfbe970b00d34">pFlow::setFieldList::readSetFieldList</a></div><div class="ttdeci">bool readSetFieldList(const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="setFieldList_8cpp_source.html#l00024">setFieldList.cpp:24</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a713abeb5a65a5982d48bebb237e19722"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a713abeb5a65a5982d48bebb237e19722">pFlow::dictionary::dataEntryRef</a></div><div class="ttdeci">dataEntry &amp; dataEntryRef(const word &amp;keyword)</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00600">dictionary.cpp:600</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a4ec29cc19fce60018543fdd6d7ebf971"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a4ec29cc19fce60018543fdd6d7ebf971">pFlow::dictionary::dataEntryKeywords</a></div><div class="ttdeci">wordList dataEntryKeywords() const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00706">dictionary.cpp:706</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_a713abeb5a65a5982d48bebb237e19722"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a713abeb5a65a5982d48bebb237e19722">pFlow::dictionary::dataEntryRef</a></div><div class="ttdeci">dataEntry &amp; dataEntryRef(const word &amp;keyword)</div><div class="ttdoc">ref to a subdictioanry fatalExit if not found/not a dataEntry</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00613">dictionary.cpp:613</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a4ec29cc19fce60018543fdd6d7ebf971"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a4ec29cc19fce60018543fdd6d7ebf971">pFlow::dictionary::dataEntryKeywords</a></div><div class="ttdeci">wordList dataEntryKeywords() const</div><div class="ttdoc">return a list of all dataEntries (non-nullptr) keywords</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00719">dictionary.cpp:719</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_9b7c0f625f4f6d33472b6a893e385484.html">setFieldList</a></li><li class="navelem"><a class="el" href="setFieldList_8cpp.html">setFieldList.cpp</a></li>