mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-06-22 16:28:30 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -192,7 +192,7 @@ $(document).ready(function(){initNavTree('includeMask_8cpp_source.html',''); ini
|
||||
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">auto</span> objPtr = </div>
|
||||
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  dictionaryvCtorSelector_[method]</div>
|
||||
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  (dict, opType, <a class="code" href="classpFlow_1_1timeFolder.html">timeFolder</a>);</div>
|
||||
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a>(2)<< dict.name()<< <span class="stringliteral">" with model "</span><<<a class="code" href="streams_8hpp.html#a37a406f400cfe49d19e51bfcc34cd2d3">greenText</a>(method)<<<span class="stringliteral">" is processed."</span><<<a class="code" href="streams_8hpp.html#a04db65a6cb5a45695ea75cce1b5d7a10">endREPORT</a>;</div>
|
||||
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a>(2)<< dict.name()<< <span class="stringliteral">" with model "</span><<<a class="code" href="iOstream_8hpp.html#ac569b1e93bab8b809907065244b11fd2">Green_Text</a>(method)<<<span class="stringliteral">" is processed."</span><<<a class="code" href="streams_8hpp.html#a1861619f2a6e102d0043a98577c8c9e8">END_REPORT</a>;</div>
|
||||
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">return</span> objPtr;</div>
|
||||
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  }</div>
|
||||
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">else</span></div>
|
||||
@ -215,24 +215,24 @@ $(document).ready(function(){initNavTree('includeMask_8cpp_source.html',''); ini
|
||||
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<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="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_1includeMask_html_a2d6fa293e543267f3139df717b643ca9"><div class="ttname"><a href="classpFlow_1_1includeMask.html#a2d6fa293e543267f3139df717b643ca9">pFlow::includeMask::create</a></div><div class="ttdeci">static uniquePtr< includeMask > create(const dictionary &dict, const word &opType, readFromTimeFolder &timeFolder)</div><div class="ttdef"><b>Definition:</b> <a href="includeMask_8cpp_source.html#l00068">includeMask.cpp:68</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a5585dc9a8b971fbfe2c99fdb75c5d647"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a5585dc9a8b971fbfe2c99fdb75c5d647">pFlow::dictionary::getValOrSet</a></div><div class="ttdeci">T getValOrSet(const word &keyword, const T &setVal) const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00325">dictionary.hpp:325</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a5585dc9a8b971fbfe2c99fdb75c5d647"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a5585dc9a8b971fbfe2c99fdb75c5d647">pFlow::dictionary::getValOrSet</a></div><div class="ttdeci">T getValOrSet(const word &keyword, const T &setVal) const</div><div class="ttdoc">get the value of data entry or if not found, set the value to setVal</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00415">dictionary.hpp:415</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1includeMask_html_a84505e826985ad10d53f4063d43128ea"><div class="ttname"><a href="classpFlow_1_1includeMask.html#a84505e826985ad10d53f4063d43128ea">pFlow::includeMask::fieldName_</a></div><div class="ttdeci">word fieldName_</div><div class="ttdef"><b>Definition:</b> <a href="includeMask_8hpp_source.html#l00036">includeMask.hpp:36</a></div></div>
|
||||
<div class="ttc" id="aincludeMask_8hpp_html"><div class="ttname"><a href="includeMask_8hpp.html">includeMask.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="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_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="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="aclasspFlow_1_1readFromTimeFolder_html"><div class="ttname"><a href="classpFlow_1_1readFromTimeFolder.html">pFlow::readFromTimeFolder</a></div><div class="ttdef"><b>Definition:</b> <a href="readFromTimeFolder_8hpp_source.html#l00031">readFromTimeFolder.hpp:31</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1includeMask_html_ac79c0ce5bab11b4b49996bc8f642d295"><div class="ttname"><a href="classpFlow_1_1includeMask.html#ac79c0ce5bab11b4b49996bc8f642d295">pFlow::includeMask::getFieldType</a></div><div class="ttdeci">static bool getFieldType(const dictionary &dict, readFromTimeFolder &timeFolder, word &fName, word &fType)</div><div class="ttdef"><b>Definition:</b> <a href="includeMask_8cpp_source.html#l00041">includeMask.cpp:41</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_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_a9c4454c5f18c8245eaaebf2b4832eab0"><div class="ttname"><a href="namespacepFlow.html#a9c4454c5f18c8245eaaebf2b4832eab0">pFlow::printKeys</a></div><div class="ttdeci">iOstream & printKeys(iOstream &os, const wordHashMap< T > &m)</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 & endl(iOstream &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="anamespacepFlow_html_afe403b837013166b7f41881dded792a8"><div class="ttname"><a href="namespacepFlow.html#afe403b837013166b7f41881dded792a8">pFlow::angleBracketsNames2</a></div><div class="ttdeci">word angleBracketsNames2(const word &base, const word &w1, const word &w2)</div><div class="ttdef"><b>Definition:</b> <a href="bTypesFunctions_8cpp_source.html#l00137">bTypesFunctions.cpp:137</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_aca9aa547c8441e4410a65a2ce7c21554"><div class="ttname"><a href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554">fatalErrorInFunction</a></div><div class="ttdeci">#define fatalErrorInFunction</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00042">error.hpp:42</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_adfe9ae1313e6913aca3f96d3eb67906e"><div class="ttname"><a href="error_8hpp.html#adfe9ae1313e6913aca3f96d3eb67906e">fatalError</a></div><div class="ttdeci">#define fatalError</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00036">error.hpp:36</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 & endl(iOstream &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="anamespacepFlow_html_afe403b837013166b7f41881dded792a8"><div class="ttname"><a href="namespacepFlow.html#afe403b837013166b7f41881dded792a8">pFlow::angleBracketsNames2</a></div><div class="ttdeci">word angleBracketsNames2(const word &base, const word &w1, const word &w2)</div><div class="ttdoc">Output base<w1,w2></div><div class="ttdef"><b>Definition:</b> <a href="bTypesFunctions_8cpp_source.html#l00162">bTypesFunctions.cpp:162</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_aca9aa547c8441e4410a65a2ce7c21554"><div class="ttname"><a href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554">fatalErrorInFunction</a></div><div class="ttdeci">#define fatalErrorInFunction</div><div class="ttdoc">Report a fatal error and function name and exit the application.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00077">error.hpp:77</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="aerror_8hpp_html_adfe9ae1313e6913aca3f96d3eb67906e"><div class="ttname"><a href="error_8hpp.html#adfe9ae1313e6913aca3f96d3eb67906e">fatalError</a></div><div class="ttdeci">#define fatalError</div><div class="ttdoc">Report a fatal error and exit the applicaiton.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00070">error.hpp:70</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1uniquePtr_html"><div class="ttname"><a href="classpFlow_1_1uniquePtr.html">pFlow::uniquePtr< pFlow::includeMask ></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 class="ttc" id="aclasspFlow_1_1includeMask_html_a885fb6d2cc1add5cb4edb4acf05e0485"><div class="ttname"><a href="classpFlow_1_1includeMask.html#a885fb6d2cc1add5cb4edb4acf05e0485">pFlow::includeMask::fieldType_</a></div><div class="ttdeci">word fieldType_</div><div class="ttdef"><b>Definition:</b> <a href="includeMask_8hpp_source.html#l00038">includeMask.hpp:38</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1timeFolder_html"><div class="ttname"><a href="classpFlow_1_1timeFolder.html">pFlow::timeFolder</a></div><div class="ttdef"><b>Definition:</b> <a href="timeFolder_8hpp_source.html#l00032">timeFolder.hpp:32</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1includeMask_html_a70bbe45140906680c8e4a0041fdcd6cb"><div class="ttname"><a href="classpFlow_1_1includeMask.html#a70bbe45140906680c8e4a0041fdcd6cb">pFlow::includeMask::includeMask</a></div><div class="ttdeci">includeMask(const dictionary &dict, const word &opType, readFromTimeFolder &timeFolder)</div><div class="ttdef"><b>Definition:</b> <a href="includeMask_8cpp_source.html#l00024">includeMask.cpp:24</a></div></div>
|
||||
|
||||
Reference in New Issue
Block a user