doc for Geometry

This commit is contained in:
Hamidreza Norouzi
2023-04-13 11:46:41 -07:00
parent 895e48d89f
commit 123023579a
3624 changed files with 83821 additions and 29967 deletions

View File

@ -149,60 +149,63 @@ $(document).ready(function(){initNavTree('fileStream_8hpp_source.html',''); init
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="comment">// - out file stream</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classpFlow_1_1fileStream.html#af4210b27304c9ab2813b41ae934328d4"> 44</a></span>&#160; <a class="code" href="classpFlow_1_1uniquePtr.html">uniquePtr&lt;std::ofstream&gt;</a> <a class="code" href="classpFlow_1_1fileStream.html#af4210b27304c9ab2813b41ae934328d4">outStream_</a>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="comment">// - open input file</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classpFlow_1_1fileStream.html#a2202773d095b6ad3bd8186c6b4ef1458">openInFile</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1fileSystem.html">fileSystem</a>&amp; path);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// - open output file</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classpFlow_1_1fileStream.html#a8d6b427b76776c3ef060ad31d8ea44fd">openOutFile</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1fileSystem.html">fileSystem</a>&amp; path);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="comment">// - close streams </span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classpFlow_1_1fileStream.html#a5ae591df94fc66ccb85cbb6565368bca">close</a>();</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classpFlow_1_1fileStream.html#ad139edcd5a95667fd99c314eccefa0a4"> 46</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1fileStream.html#ad139edcd5a95667fd99c314eccefa0a4">binary_</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="comment">// - open input file</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classpFlow_1_1fileStream.html#a2202773d095b6ad3bd8186c6b4ef1458">openInFile</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1fileSystem.html">fileSystem</a>&amp; path);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// - open output file</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classpFlow_1_1fileStream.html#a8d6b427b76776c3ef060ad31d8ea44fd">openOutFile</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1fileSystem.html">fileSystem</a>&amp; path);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">// - close streams </span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classpFlow_1_1fileStream.html#a5ae591df94fc66ccb85cbb6565368bca">close</a>();</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="comment">// - Constructors</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="classpFlow_1_1fileStream.html#aa84e42e905cfb3f52afa76ec3074c9d2">fileStream</a>( <span class="keyword">const</span> <a class="code" href="classpFlow_1_1fileSystem.html">fileSystem</a>&amp; path, <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1fileStream.html#af3458b34a937eb333ae314095c7725d6">outStream</a> = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <a class="code" href="classpFlow_1_1fileStream.html#aa84e42e905cfb3f52afa76ec3074c9d2">fileStream</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1fileStream.html">fileStream</a>&amp;)= <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="classpFlow_1_1fileStream.html">fileStream</a>&amp; <a class="code" href="classpFlow_1_1fileStream.html#a2ccd493a7a643ff561506567f4d7cc72">operator=</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1fileStream.html">fileStream</a>&amp;)=<span class="keyword">delete</span>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">// - Constructors</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <a class="code" href="classpFlow_1_1fileStream.html#af68d6624b6ee2ec7376de1ea4c2fa280">fileStream</a>( <span class="keyword">const</span> <a class="code" href="classpFlow_1_1fileSystem.html">fileSystem</a>&amp; path, <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1fileStream.html#af3458b34a937eb333ae314095c7725d6">outStream</a> = <span class="keyword">false</span>, <span class="keywordtype">bool</span> binary = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="classpFlow_1_1fileStream.html#af68d6624b6ee2ec7376de1ea4c2fa280">fileStream</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1fileStream.html">fileStream</a>&amp;)= <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classpFlow_1_1fileStream.html#a5fe998970d1259a6c509c88724a8a599"> 65</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classpFlow_1_1fileStream.html#a5fe998970d1259a6c509c88724a8a599">~fileStream</a>() </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; {</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="classpFlow_1_1fileStream.html#a5ae591df94fc66ccb85cbb6565368bca">close</a>();</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; }</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </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; <span class="comment">// - access </span></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; std::ifstream&amp; <a class="code" href="classpFlow_1_1fileStream.html#a3bcd8dda96066183fbf2024b67915655">inStream</a>();</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; std::ofstream&amp; <a class="code" href="classpFlow_1_1fileStream.html#af3458b34a937eb333ae314095c7725d6">outStream</a>();</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;};</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="code" href="classpFlow_1_1fileStream.html">fileStream</a>&amp; <a class="code" href="classpFlow_1_1fileStream.html#a2ccd493a7a643ff561506567f4d7cc72">operator=</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1fileStream.html">fileStream</a>&amp;)=<span class="keyword">delete</span>;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classpFlow_1_1fileStream.html#a5fe998970d1259a6c509c88724a8a599"> 67</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classpFlow_1_1fileStream.html#a5fe998970d1259a6c509c88724a8a599">~fileStream</a>() </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; {</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <a class="code" href="classpFlow_1_1fileStream.html#a5ae591df94fc66ccb85cbb6565368bca">close</a>();</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; </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="comment">// - access </span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; std::ifstream&amp; <a class="code" href="classpFlow_1_1fileStream.html#a3bcd8dda96066183fbf2024b67915655">inStream</a>();</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; std::ofstream&amp; <a class="code" href="classpFlow_1_1fileStream.html#af3458b34a937eb333ae314095c7725d6">outStream</a>();</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;}</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;};</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;}</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclasspFlow_1_1fileStream_html_af4210b27304c9ab2813b41ae934328d4"><div class="ttname"><a href="classpFlow_1_1fileStream.html#af4210b27304c9ab2813b41ae934328d4">pFlow::fileStream::outStream_</a></div><div class="ttdeci">uniquePtr&lt; std::ofstream &gt; outStream_</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8hpp_source.html#l00044">fileStream.hpp:44</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_a2202773d095b6ad3bd8186c6b4ef1458"><div class="ttname"><a href="classpFlow_1_1fileStream.html#a2202773d095b6ad3bd8186c6b4ef1458">pFlow::fileStream::openInFile</a></div><div class="ttdeci">void openInFile(const fileSystem &amp;path)</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8cpp_source.html#l00030">fileStream.cpp:30</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_aa84e42e905cfb3f52afa76ec3074c9d2"><div class="ttname"><a href="classpFlow_1_1fileStream.html#aa84e42e905cfb3f52afa76ec3074c9d2">pFlow::fileStream::fileStream</a></div><div class="ttdeci">fileStream(const fileSystem &amp;path, bool outStream=false)</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8cpp_source.html#l00093">fileStream.cpp:93</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_a5ae591df94fc66ccb85cbb6565368bca"><div class="ttname"><a href="classpFlow_1_1fileStream.html#a5ae591df94fc66ccb85cbb6565368bca">pFlow::fileStream::close</a></div><div class="ttdeci">void close()</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8cpp_source.html#l00079">fileStream.cpp:79</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_a5ae591df94fc66ccb85cbb6565368bca"><div class="ttname"><a href="classpFlow_1_1fileStream.html#a5ae591df94fc66ccb85cbb6565368bca">pFlow::fileStream::close</a></div><div class="ttdeci">void close()</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8cpp_source.html#l00092">fileStream.cpp:92</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_a2ccd493a7a643ff561506567f4d7cc72"><div class="ttname"><a href="classpFlow_1_1fileStream.html#a2ccd493a7a643ff561506567f4d7cc72">pFlow::fileStream::operator=</a></div><div class="ttdeci">fileStream &amp; operator=(const fileStream &amp;)=delete</div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_a5fe998970d1259a6c509c88724a8a599"><div class="ttname"><a href="classpFlow_1_1fileStream.html#a5fe998970d1259a6c509c88724a8a599">pFlow::fileStream::~fileStream</a></div><div class="ttdeci">virtual ~fileStream()</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8hpp_source.html#l00065">fileStream.hpp:65</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_af68d6624b6ee2ec7376de1ea4c2fa280"><div class="ttname"><a href="classpFlow_1_1fileStream.html#af68d6624b6ee2ec7376de1ea4c2fa280">pFlow::fileStream::fileStream</a></div><div class="ttdeci">fileStream(const fileSystem &amp;path, bool outStream=false, bool binary=false)</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8cpp_source.html#l00106">fileStream.cpp:106</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_a5fe998970d1259a6c509c88724a8a599"><div class="ttname"><a href="classpFlow_1_1fileStream.html#a5fe998970d1259a6c509c88724a8a599">pFlow::fileStream::~fileStream</a></div><div class="ttdeci">virtual ~fileStream()</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8hpp_source.html#l00067">fileStream.hpp:67</a></div></div>
<div class="ttc" id="afileSystem_8hpp_html"><div class="ttname"><a href="fileSystem_8hpp.html">fileSystem.hpp</a></div></div>
<div class="ttc" id="anamespacepFlow_html"><div class="ttname"><a href="namespacepFlow.html">pFlow</a></div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00028">demComponent.hpp:28</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileSystem_html"><div class="ttname"><a href="classpFlow_1_1fileSystem.html">pFlow::fileSystem</a></div><div class="ttdef"><b>Definition:</b> <a href="fileSystem_8hpp_source.html#l00063">fileSystem.hpp:63</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_af3458b34a937eb333ae314095c7725d6"><div class="ttname"><a href="classpFlow_1_1fileStream.html#af3458b34a937eb333ae314095c7725d6">pFlow::fileStream::outStream</a></div><div class="ttdeci">std::ofstream &amp; outStream()</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8cpp_source.html#l00117">fileStream.cpp:117</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_af3458b34a937eb333ae314095c7725d6"><div class="ttname"><a href="classpFlow_1_1fileStream.html#af3458b34a937eb333ae314095c7725d6">pFlow::fileStream::outStream</a></div><div class="ttdeci">std::ofstream &amp; outStream()</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8cpp_source.html#l00132">fileStream.cpp:132</a></div></div>
<div class="ttc" id="auniquePtr_8hpp_html"><div class="ttname"><a href="uniquePtr_8hpp.html">uniquePtr.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_ad139edcd5a95667fd99c314eccefa0a4"><div class="ttname"><a href="classpFlow_1_1fileStream.html#ad139edcd5a95667fd99c314eccefa0a4">pFlow::fileStream::binary_</a></div><div class="ttdeci">bool binary_</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8hpp_source.html#l00046">fileStream.hpp:46</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_a85cc66c39570389f63084c1b0a8c065b"><div class="ttname"><a href="classpFlow_1_1fileStream.html#a85cc66c39570389f63084c1b0a8c065b">pFlow::fileStream::inStream_</a></div><div class="ttdeci">uniquePtr&lt; std::ifstream &gt; inStream_</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8hpp_source.html#l00041">fileStream.hpp:41</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html"><div class="ttname"><a href="classpFlow_1_1fileStream.html">pFlow::fileStream</a></div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8hpp_source.html#l00036">fileStream.hpp:36</a></div></div>
<div class="ttc" id="aclasspFlow_1_1uniquePtr_html"><div class="ttname"><a href="classpFlow_1_1uniquePtr.html">pFlow::uniquePtr&lt; std::ifstream &gt;</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_a8d6b427b76776c3ef060ad31d8ea44fd"><div class="ttname"><a href="classpFlow_1_1fileStream.html#a8d6b427b76776c3ef060ad31d8ea44fd">pFlow::fileStream::openOutFile</a></div><div class="ttdeci">void openOutFile(const fileSystem &amp;path)</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8cpp_source.html#l00056">fileStream.cpp:56</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_a3bcd8dda96066183fbf2024b67915655"><div class="ttname"><a href="classpFlow_1_1fileStream.html#a3bcd8dda96066183fbf2024b67915655">pFlow::fileStream::inStream</a></div><div class="ttdeci">std::ifstream &amp; inStream()</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8cpp_source.html#l00112">fileStream.cpp:112</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_a8d6b427b76776c3ef060ad31d8ea44fd"><div class="ttname"><a href="classpFlow_1_1fileStream.html#a8d6b427b76776c3ef060ad31d8ea44fd">pFlow::fileStream::openOutFile</a></div><div class="ttdeci">void openOutFile(const fileSystem &amp;path)</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8cpp_source.html#l00061">fileStream.cpp:61</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileStream_html_a3bcd8dda96066183fbf2024b67915655"><div class="ttname"><a href="classpFlow_1_1fileStream.html#a3bcd8dda96066183fbf2024b67915655">pFlow::fileStream::inStream</a></div><div class="ttdeci">std::ifstream &amp; inStream()</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8cpp_source.html#l00127">fileStream.cpp:127</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_b13948a90891cb8a59f39ab8c50a8102.html">streams</a></li><li class="navelem"><a class="el" href="dir_1cabe3740960a39038ba2cb1fab9ec4c.html">Fstream</a></li><li class="navelem"><a class="el" href="fileStream_8hpp.html">fileStream.hpp</a></li>