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
@ -125,13 +125,13 @@ $(document).ready(function(){initNavTree('peakableRegion_8cpp_source.html','');
|
||||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span> </div>
|
||||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">-----------------------------------------------------------------------------*/</span></div>
|
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="peakableRegion_8hpp.html">peakableRegion.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="dictionary_8hpp.html">dictionary.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <a class="code" href="classpFlow_1_1peakableRegion.html#abf43b56be2edb758022e5748d0adc983">pFlow::peakableRegion::peakableRegion</a></div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classpFlow_1_1peakableRegion.html#abf43b56be2edb758022e5748d0adc983"> 26</a></span> (</div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>& type, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>& dict</div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "<a class="code" href="peakableRegion_8hpp.html">peakableRegion.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="dictionary_8hpp.html">dictionary.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <a class="code" href="classpFlow_1_1peakableRegion.html#abf43b56be2edb758022e5748d0adc983">pFlow::peakableRegion::peakableRegion</a></div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classpFlow_1_1peakableRegion.html#abf43b56be2edb758022e5748d0adc983"> 25</a></span> (</div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>& type, </div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>& dict</div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> )</div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="pFlowMacros_8hpp.html#aee00d54cd02615bc094de03967dde20d">CONSUME_PARAM</a>(type);</div>
|
||||
@ -144,8 +144,8 @@ $(document).ready(function(){initNavTree('peakableRegion_8cpp_source.html','');
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>& type,</div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>& dict</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> )</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> regionType = <a class="code" href="namespacepFlow.html#af4e1df8908797640749fa02e2f5db7a7">angleBracketsNames</a>(<span class="stringliteral">"peakableRegion"</span>, type);</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> { </div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> regionType = <a class="code" href="namespacepFlow.html#af4e1df8908797640749fa02e2f5db7a7">angleBracketsNames</a>(<span class="stringliteral">"peakable"</span>, type);</div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">if</span>( wordvCtorSelector_.search(regionType) )</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div>
|
||||
@ -155,7 +155,7 @@ $(document).ready(function(){initNavTree('peakableRegion_8cpp_source.html','');
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  {</div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="namespacepFlow.html#a9c4454c5f18c8245eaaebf2b4832eab0">printKeys</a></div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  ( </div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="error_8hpp.html#adfe9ae1313e6913aca3f96d3eb67906e">fatalError</a> << <span class="stringliteral">"Ctor Selector "</span><< regionType << <span class="stringliteral">" dose not exist. \n"</span></div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="error_8hpp.html#adfe9ae1313e6913aca3f96d3eb67906e">fatalError</a> << <span class="stringliteral">"Ctor Selector "</span><< regionType << <span class="stringliteral">" does not exist. \n"</span></div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <<<span class="stringliteral">"Avaiable ones are: \n\n"</span></div>
|
||||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  ,</div>
|
||||
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  wordvCtorSelector_</div>
|
||||
@ -167,18 +167,18 @@ $(document).ready(function(){initNavTree('peakableRegion_8cpp_source.html','');
|
||||
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> }</div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<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="aclasspFlow_1_1peakableRegion_html_abf43b56be2edb758022e5748d0adc983"><div class="ttname"><a href="classpFlow_1_1peakableRegion.html#abf43b56be2edb758022e5748d0adc983">pFlow::peakableRegion::peakableRegion</a></div><div class="ttdeci">peakableRegion(const word &type, const dictionary &dict)</div><div class="ttdef"><b>Definition:</b> <a href="peakableRegion_8cpp_source.html#l00026">peakableRegion.cpp:26</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="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_1peakableRegion_html_abf43b56be2edb758022e5748d0adc983"><div class="ttname"><a href="classpFlow_1_1peakableRegion.html#abf43b56be2edb758022e5748d0adc983">pFlow::peakableRegion::peakableRegion</a></div><div class="ttdeci">peakableRegion(const word &type, const dictionary &dict)</div><div class="ttdef"><b>Definition:</b> <a href="peakableRegion_8cpp_source.html#l00025">peakableRegion.cpp:25</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_af4e1df8908797640749fa02e2f5db7a7"><div class="ttname"><a href="namespacepFlow.html#af4e1df8908797640749fa02e2f5db7a7">pFlow::angleBracketsNames</a></div><div class="ttdeci">word angleBracketsNames(const word &w1, const word &w2)</div><div class="ttdef"><b>Definition:</b> <a href="bTypesFunctions_8cpp_source.html#l00131">bTypesFunctions.cpp:131</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_af4e1df8908797640749fa02e2f5db7a7"><div class="ttname"><a href="namespacepFlow.html#af4e1df8908797640749fa02e2f5db7a7">pFlow::angleBracketsNames</a></div><div class="ttdeci">word angleBracketsNames(const word &w1, const word &w2)</div><div class="ttdoc">Output <w1,w2></div><div class="ttdef"><b>Definition:</b> <a href="bTypesFunctions_8cpp_source.html#l00156">bTypesFunctions.cpp:156</a></div></div>
|
||||
<div class="ttc" id="adictionary_8hpp_html"><div class="ttname"><a href="dictionary_8hpp.html">dictionary.hpp</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1peakableRegion_html_a7c89091eec63fb3273bfeac98f38343f"><div class="ttname"><a href="classpFlow_1_1peakableRegion.html#a7c89091eec63fb3273bfeac98f38343f">pFlow::peakableRegion::create</a></div><div class="ttdeci">static uniquePtr< peakableRegion > create(const word &type, const dictionary &dict)</div><div class="ttdef"><b>Definition:</b> <a href="peakableRegion_8cpp_source.html#l00036">peakableRegion.cpp:36</a></div></div>
|
||||
<div class="ttc" id="apeakableRegion_8hpp_html"><div class="ttname"><a href="peakableRegion_8hpp.html">peakableRegion.hpp</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="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::peakableRegion ></a></div></div>
|
||||
<div class="ttc" id="apFlowMacros_8hpp_html_aee00d54cd02615bc094de03967dde20d"><div class="ttname"><a href="pFlowMacros_8hpp.html#aee00d54cd02615bc094de03967dde20d">CONSUME_PARAM</a></div><div class="ttdeci">#define CONSUME_PARAM(x)</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00038">pFlowMacros.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="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_0b265ec0eb5bc5fbad75b6fd7b5b024b.html">structuredData</a></li><li class="navelem"><a class="el" href="dir_4f9e597021b90228ccac48345da86dec.html">peakableRegion</a></li><li class="navelem"><a class="el" href="dir_fcee4eefc34728867d2bd32b142ae11c.html">peakableRegion</a></li><li class="navelem"><a class="el" href="peakableRegion_8cpp.html">peakableRegion.cpp</a></li>
|
||||
|
||||
Reference in New Issue
Block a user