mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-07-28 03:27:05 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -124,58 +124,51 @@ $(document).ready(function(){initNavTree('iFstream_8hpp_source.html',''); initRe
|
||||
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span></div>
|
||||
<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> <span class="comment">// based on OpenFOAM stream, with some modifications/simplifications</span></div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// to be tailored to our needs</span></div>
|
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef __iFstream_hpp__</span></div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define __iFstream_hpp__</span></div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef __iFstream_hpp__</span></div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define __iFstream_hpp__</span></div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="fileSystem_8hpp.html">fileSystem.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="fileStream_8hpp.html">fileStream.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="Istream_8hpp.html">Istream.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> <span class="preprocessor">#include "<a class="code" href="fileSystem_8hpp.html">fileSystem.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="fileStream_8hpp.html">fileStream.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="Istream_8hpp.html">Istream.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespacepFlow.html">pFlow</a></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>  </div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespacepFlow.html">pFlow</a></div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classpFlow_1_1iFstream.html"> 35</a></span> <span class="keyword">class </span><a class="code" href="classpFlow_1_1iFstream.html">iFstream</a></div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> :</div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">public</span> <a class="code" href="classpFlow_1_1fileStream.html">fileStream</a>,</div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">public</span> <a class="code" href="classpFlow_1_1Istream.html">Istream</a></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> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// - Constructor </span></div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classpFlow_1_1iFstream.html#a8707b807ad68cb8c8d81bd600db44bae">iFstream</a> (<span class="keyword">const</span> <a class="code" href="classpFlow_1_1fileSystem.html">fileSystem</a>& path, <span class="keywordtype">bool</span> binary = <span class="keyword">false</span>);</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// no copy constructor</span></div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="classpFlow_1_1iFstream.html#a8707b807ad68cb8c8d81bd600db44bae">iFstream</a>( <span class="keyword">const</span> <a class="code" href="classpFlow_1_1iFstream.html">iFstream</a>& src) = <span class="keyword">delete</span>;</div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// no assignment</span></div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classpFlow_1_1iFstream.html">iFstream</a>& <a class="code" href="classpFlow_1_1iFstream.html#a1e6c9b638c8f85e897652f0fabcf6d41">operator = </a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1iFstream.html">iFstream</a>& rhs) = <span class="keyword">delete</span>;</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>  <span class="comment">// - Destructor</span></div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">virtual</span> <a class="code" href="classpFlow_1_1iFstream.html#a1bd497f969d87155b8dd9c3bc4c8520a">~iFstream</a>() = <span class="keywordflow">default</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> };</div>
|
||||
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
||||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> }</div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classpFlow_1_1iFstream.html"> 37</a></span> <span class="keyword">class </span><a class="code" href="classpFlow_1_1iFstream.html">iFstream</a></div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> :</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">public</span> <a class="code" href="classpFlow_1_1fileStream.html">fileStream</a>,</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span> <a class="code" href="classpFlow_1_1Istream.html">Istream</a></div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> {</div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classpFlow_1_1iFstream.html#a8707b807ad68cb8c8d81bd600db44bae">iFstream</a> (<span class="keyword">const</span> <a class="code" href="classpFlow_1_1fileSystem.html">fileSystem</a>& path, <span class="keywordtype">bool</span> binary = <span class="keyword">false</span>);</div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="classpFlow_1_1iFstream.html#a8707b807ad68cb8c8d81bd600db44bae">iFstream</a>( <span class="keyword">const</span> <a class="code" href="classpFlow_1_1iFstream.html">iFstream</a>& src) = <span class="keyword">delete</span>;</div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
||||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classpFlow_1_1iFstream.html">iFstream</a>& <a class="code" href="classpFlow_1_1iFstream.html#a1e6c9b638c8f85e897652f0fabcf6d41">operator = </a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1iFstream.html">iFstream</a>& rhs) = <span class="keyword">delete</span>;</div>
|
||||
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
||||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">virtual</span> <a class="code" href="classpFlow_1_1iFstream.html#a1bd497f969d87155b8dd9c3bc4c8520a">~iFstream</a>() = <span class="keywordflow">default</span>;</div>
|
||||
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
|
||||
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> };</div>
|
||||
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
|
||||
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> }</div>
|
||||
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
||||
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
||||
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#endif</span></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="aclasspFlow_1_1iFstream_html_a1bd497f969d87155b8dd9c3bc4c8520a"><div class="ttname"><a href="classpFlow_1_1iFstream.html#a1bd497f969d87155b8dd9c3bc4c8520a">pFlow::iFstream::~iFstream</a></div><div class="ttdeci">virtual ~iFstream()=default</div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iFstream_html_a1bd497f969d87155b8dd9c3bc4c8520a"><div class="ttname"><a href="classpFlow_1_1iFstream.html#a1bd497f969d87155b8dd9c3bc4c8520a">pFlow::iFstream::~iFstream</a></div><div class="ttdeci">virtual ~iFstream()=default</div><div class="ttdoc">Destructor.</div></div>
|
||||
<div class="ttc" id="aIstream_8hpp_html"><div class="ttname"><a href="Istream_8hpp.html">Istream.hpp</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="aclasspFlow_1_1iFstream_html"><div class="ttname"><a href="classpFlow_1_1iFstream.html">pFlow::iFstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iFstream_8hpp_source.html#l00035">iFstream.hpp:35</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_1Istream_html"><div class="ttname"><a href="classpFlow_1_1Istream.html">pFlow::Istream</a></div><div class="ttdef"><b>Definition:</b> <a href="Istream_8hpp_source.html#l00038">Istream.hpp:38</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iFstream_html_a1e6c9b638c8f85e897652f0fabcf6d41"><div class="ttname"><a href="classpFlow_1_1iFstream.html#a1e6c9b638c8f85e897652f0fabcf6d41">pFlow::iFstream::operator=</a></div><div class="ttdeci">iFstream & operator=(const iFstream &rhs)=delete</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_1iFstream_html_a8707b807ad68cb8c8d81bd600db44bae"><div class="ttname"><a href="classpFlow_1_1iFstream.html#a8707b807ad68cb8c8d81bd600db44bae">pFlow::iFstream::iFstream</a></div><div class="ttdeci">iFstream(const fileSystem &path, bool binary=false)</div><div class="ttdef"><b>Definition:</b> <a href="iFstream_8cpp_source.html#l00028">iFstream.cpp:28</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iFstream_html"><div class="ttname"><a href="classpFlow_1_1iFstream.html">pFlow::iFstream</a></div><div class="ttdoc">Input file stream for reading binary or ascii data from a file.</div><div class="ttdef"><b>Definition:</b> <a href="iFstream_8hpp_source.html#l00037">iFstream.hpp:37</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="demGeometry_8hpp_source.html#l00027">demGeometry.hpp:27</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="ttdoc">Manages file pathes, manupulate and combines them.</div><div class="ttdef"><b>Definition:</b> <a href="fileSystem_8hpp_source.html#l00071">fileSystem.hpp:71</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1Istream_html"><div class="ttname"><a href="classpFlow_1_1Istream.html">pFlow::Istream</a></div><div class="ttdoc">Standard input stream for binary and ascii data.</div><div class="ttdef"><b>Definition:</b> <a href="Istream_8hpp_source.html#l00039">Istream.hpp:39</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iFstream_html_a1e6c9b638c8f85e897652f0fabcf6d41"><div class="ttname"><a href="classpFlow_1_1iFstream.html#a1e6c9b638c8f85e897652f0fabcf6d41">pFlow::iFstream::operator=</a></div><div class="ttdeci">iFstream & operator=(const iFstream &rhs)=delete</div><div class="ttdoc">No assignment.</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="ttdoc">Creates and manages an input/output file stream with specified format.</div><div class="ttdef"><b>Definition:</b> <a href="fileStream_8hpp_source.html#l00043">fileStream.hpp:43</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iFstream_html_a8707b807ad68cb8c8d81bd600db44bae"><div class="ttname"><a href="classpFlow_1_1iFstream.html#a8707b807ad68cb8c8d81bd600db44bae">pFlow::iFstream::iFstream</a></div><div class="ttdeci">iFstream(const fileSystem &path, bool binary=false)</div><div class="ttdoc">From file path and format.</div><div class="ttdef"><b>Definition:</b> <a href="iFstream_8cpp_source.html#l00025">iFstream.cpp:25</a></div></div>
|
||||
<div class="ttc" id="afileStream_8hpp_html"><div class="ttname"><a href="fileStream_8hpp.html">fileStream.hpp</a></div></div>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
|
||||
Reference in New Issue
Block a user