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

@ -136,8 +136,8 @@ $(document).ready(function(){initNavTree('classpFlow_1_1fileStream.html',''); in
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa84e42e905cfb3f52afa76ec3074c9d2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#aa84e42e905cfb3f52afa76ec3074c9d2">fileStream</a> (const <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> &amp;path, bool <a class="el" href="classpFlow_1_1fileStream.html#af3458b34a937eb333ae314095c7725d6">outStream</a>=false)</td></tr>
<tr class="separator:aa84e42e905cfb3f52afa76ec3074c9d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af68d6624b6ee2ec7376de1ea4c2fa280"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#af68d6624b6ee2ec7376de1ea4c2fa280">fileStream</a> (const <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> &amp;path, bool <a class="el" href="classpFlow_1_1fileStream.html#af3458b34a937eb333ae314095c7725d6">outStream</a>=false, bool binary=false)</td></tr>
<tr class="separator:af68d6624b6ee2ec7376de1ea4c2fa280"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d86209d8fe5bac3eacf5301cfaf60e0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#a5d86209d8fe5bac3eacf5301cfaf60e0">fileStream</a> (const <a class="el" href="classpFlow_1_1fileStream.html">fileStream</a> &amp;)=delete</td></tr>
<tr class="separator:a5d86209d8fe5bac3eacf5301cfaf60e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ccd493a7a643ff561506567f4d7cc72"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1fileStream.html">fileStream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#a2ccd493a7a643ff561506567f4d7cc72">operator=</a> (const <a class="el" href="classpFlow_1_1fileStream.html">fileStream</a> &amp;)=delete</td></tr>
@ -164,13 +164,15 @@ Protected Attributes</h2></td></tr>
<tr class="separator:a85cc66c39570389f63084c1b0a8c065b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4210b27304c9ab2813b41ae934328d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1uniquePtr.html">uniquePtr</a>&lt; std::ofstream &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#af4210b27304c9ab2813b41ae934328d4">outStream_</a></td></tr>
<tr class="separator:af4210b27304c9ab2813b41ae934328d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad139edcd5a95667fd99c314eccefa0a4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#ad139edcd5a95667fd99c314eccefa0a4">binary_</a> = false</td></tr>
<tr class="separator:ad139edcd5a95667fd99c314eccefa0a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="fileStream_8hpp_source.html#l00036">36</a> of file <a class="el" href="fileStream_8hpp_source.html">fileStream.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa84e42e905cfb3f52afa76ec3074c9d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa84e42e905cfb3f52afa76ec3074c9d2">&#9670;&nbsp;</a></span>fileStream() <span class="overload">[1/2]</span></h2>
<a id="af68d6624b6ee2ec7376de1ea4c2fa280"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af68d6624b6ee2ec7376de1ea4c2fa280">&#9670;&nbsp;</a></span>fileStream() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
@ -185,7 +187,13 @@ Protected Attributes</h2></td></tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>outStream</em> = <code>false</code>&#160;</td>
<td class="paramname"><em>outStream</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>binary</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
@ -195,7 +203,7 @@ Protected Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00093">93</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00106">106</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
</div>
</div>
@ -248,9 +256,9 @@ Protected Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="fileStream_8hpp_source.html#l00065">65</a> of file <a class="el" href="fileStream_8hpp_source.html">fileStream.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="fileStream_8hpp_source.html#l00067">67</a> of file <a class="el" href="fileStream_8hpp_source.html">fileStream.hpp</a>.</p>
<p class="reference">References <a class="el" href="fileStream_8cpp_source.html#l00079">fileStream::close()</a>.</p>
<p class="reference">References <a class="el" href="fileStream_8cpp_source.html#l00092">fileStream::close()</a>.</p>
<div id="dynsection-2" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-2-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
@ -332,7 +340,7 @@ Protected Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00056">56</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00061">61</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
<p class="reference">References <a class="el" href="fileSystem_8cpp_source.html#l00196">fileSystem::createDirs()</a>, <a class="el" href="fileSystem_8cpp_source.html#l00082">fileSystem::dirPath()</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, <a class="el" href="error_8hpp_source.html#l00057">fatalExit</a>, and <a class="el" href="fileSystem_8hpp_source.html#l00126">fileSystem::wordPath()</a>.</p>
<div id="dynsection-4" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
@ -374,11 +382,11 @@ Protected Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00079">79</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00092">92</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
<p class="reference">References <a class="el" href="fileStream_8hpp_source.html#l00041">fileStream::inStream_</a>, and <a class="el" href="fileStream_8hpp_source.html#l00044">fileStream::outStream_</a>.</p>
<p class="reference">Referenced by <a class="el" href="fileStream_8hpp_source.html#l00065">fileStream::~fileStream()</a>.</p>
<p class="reference">Referenced by <a class="el" href="fileStream_8hpp_source.html#l00067">fileStream::~fileStream()</a>.</p>
<div id="dynsection-5" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-5-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-5-summary" class="dynsummary" style="display:block;">
@ -434,7 +442,7 @@ Protected Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00112">112</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00127">127</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
</div>
</div>
@ -453,7 +461,7 @@ Protected Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00117">117</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00132">132</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
</div>
</div>
@ -480,7 +488,7 @@ Protected Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="fileStream_8hpp_source.html#l00041">41</a> of file <a class="el" href="fileStream_8hpp_source.html">fileStream.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="fileStream_8cpp_source.html#l00079">fileStream::close()</a>.</p>
<p class="reference">Referenced by <a class="el" href="fileStream_8cpp_source.html#l00092">fileStream::close()</a>.</p>
</div>
</div>
@ -506,7 +514,31 @@ Protected Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="fileStream_8hpp_source.html#l00044">44</a> of file <a class="el" href="fileStream_8hpp_source.html">fileStream.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="fileStream_8cpp_source.html#l00079">fileStream::close()</a>.</p>
<p class="reference">Referenced by <a class="el" href="fileStream_8cpp_source.html#l00092">fileStream::close()</a>.</p>
</div>
</div>
<a id="ad139edcd5a95667fd99c314eccefa0a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad139edcd5a95667fd99c314eccefa0a4">&#9670;&nbsp;</a></span>binary_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool binary_ = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="fileStream_8hpp_source.html#l00046">46</a> of file <a class="el" href="fileStream_8hpp_source.html">fileStream.hpp</a>.</p>
</div>
</div>