264 lines
35 KiB
HTML
264 lines
35 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<title>PhasicFlow: src/phasicFlow/repository/IOobject/IOfileHeader.hpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname"><a href="https://cemf.ir">PhasicFlow</a>
|
|
 <span id="projectnumber"><a href="https://cemf.ir">v0.1</a></span>
|
|
</div>
|
|
<div id="projectbrief"><a href="www.github.com/PhasicFlow">www.cemf.ir</a></div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('IOfileHeader_8hpp_source.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">IOfileHeader.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="IOfileHeader_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*------------------------------- phasicFlow ---------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> O C enter of</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> O O E ngineering and</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> O O M ultiscale modeling of</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> OOOOOOO F luid flow </span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> Copyright (C): www.cemf.ir</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> email: hamid.r.norouzi AT gmail.com</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">------------------------------------------------------------------------------ </span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">Licence:</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> This file is part of phasicFlow code. It is a free software for simulating </span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> granular and multiphase flows. You can redistribute it and/or modify it under</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> the terms of GNU General Public License v3 or any other later versions. </span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> </span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> phasicFlow is distributed to help others in their research in the field of </span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> granular and multiphase flows, but WITHOUT ANY WARRANTY; without even the</span></div>
|
|
<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>  </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">#ifndef __IOfileHeader_hpp__</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define __IOfileHeader_hpp__</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>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="uniquePtr_8hpp.html">uniquePtr.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="objectFile_8hpp.html">objectFile.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="streams_8hpp.html">streams.hpp</a>"</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> <span class="keyword">namespace </span><a class="code" href="namespacepFlow.html">pFlow</a></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</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> <span class="keyword">class </span>repository;</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_1IOfileHeader.html"> 35</a></span> <span class="keyword">class </span><a class="code" href="classpFlow_1_1IOfileHeader.html">IOfileHeader</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_1objectFile.html">objectFile</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">protected</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>  </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// owner repository</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classpFlow_1_1IOfileHeader.html#a7bb1f0bd1b5e54b7983dfafe4270b6d7"> 44</a></span>  <span class="keyword">const</span> <a class="code" href="classpFlow_1_1repository.html">repository</a>* <a class="code" href="classpFlow_1_1IOfileHeader.html#a7bb1f0bd1b5e54b7983dfafe4270b6d7">owner_</a> = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// object name read from file </span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classpFlow_1_1IOfileHeader.html#a0fc09585fc6fa997b81807dff8b8236d"> 47</a></span>  <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> <a class="code" href="classpFlow_1_1IOfileHeader.html#a0fc09585fc6fa997b81807dff8b8236d">objectName_</a>;</div>
|
|
<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>  <span class="comment">// object type read from file </span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classpFlow_1_1IOfileHeader.html#adf7afc3ea2cc179930f4e4f4ca48797c"> 50</a></span>  <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> <a class="code" href="classpFlow_1_1IOfileHeader.html#adf7afc3ea2cc179930f4e4f4ca48797c">objectType_</a>;</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>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// - input file stream</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classpFlow_1_1uniquePtr.html">uniquePtr<iFstream></a> <a class="code" href="classpFlow_1_1IOfileHeader.html#a770eebd1866493c91efe18ab806d9568">inStream</a>()<span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// - ouput file stream</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classpFlow_1_1uniquePtr.html">uniquePtr<oFstream></a> <a class="code" href="classpFlow_1_1IOfileHeader.html#aadf02aad5ab9dd4c10306e74510f4dd0">outStream</a>()<span class="keyword">const</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> <span class="keyword">public</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>  <span class="comment">// with owner </span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classpFlow_1_1IOfileHeader.html#aeb8db62c8360b96bf8aa002da3f6085d">IOfileHeader</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1objectFile.html">objectFile</a>& objf, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1repository.html">repository</a>* <a class="code" href="classpFlow_1_1IOfileHeader.html#a2c4e952d46d447c08664eeba4e791854">owner</a> = <span class="keyword">nullptr</span>);</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// - object name</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classpFlow_1_1IOfileHeader.html#a4ae6d6ea877ec8652d86076eaf333c12"> 66</a></span>  <span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>& <a class="code" href="classpFlow_1_1IOfileHeader.html#a4ae6d6ea877ec8652d86076eaf333c12">objectName</a>()<span class="keyword">const</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1IOfileHeader.html#a0fc09585fc6fa997b81807dff8b8236d">objectName_</a>;</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  }</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// - object type</span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classpFlow_1_1IOfileHeader.html#a67068cb6552c42a5ddb1c66bf6bbf6b3"> 72</a></span>  <span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>& <a class="code" href="classpFlow_1_1IOfileHeader.html#a67068cb6552c42a5ddb1c66bf6bbf6b3">objectType</a>()<span class="keyword">const</span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1IOfileHeader.html#adf7afc3ea2cc179930f4e4f4ca48797c">objectType_</a>;</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  }</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// - pointer to owner repository </span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classpFlow_1_1IOfileHeader.html#a2c4e952d46d447c08664eeba4e791854"> 78</a></span>  <span class="keyword">const</span> <a class="code" href="classpFlow_1_1repository.html">repository</a>* <a class="code" href="classpFlow_1_1IOfileHeader.html#a2c4e952d46d447c08664eeba4e791854">owner</a>()<span class="keyword">const </span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1IOfileHeader.html#a7bb1f0bd1b5e54b7983dfafe4270b6d7">owner_</a>;</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// - path to file name </span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classpFlow_1_1fileSystem.html">fileSystem</a> <a class="code" href="classpFlow_1_1IOfileHeader.html#ae1921a7f20c43d1438221946e607c488">path</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment">// - should be used for read operations </span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// check if the file exist,</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">// read the header of the file to check if it is ok</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOfileHeader.html#a1a248aa0488b774d5160449992ad31e5">headerOk</a>(<span class="keywordtype">bool</span> silent = <span class="keyword">false</span>);</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="comment">// - imply read </span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOfileHeader.html#aac13e923e67df5e79d9a75f592b97da3">implyRead</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">// - imply write </span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOfileHeader.html#adfb03998f9b3b981631dc794cffd05a1">implyWrite</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="comment">// - check if file exists</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOfileHeader.html#ac38363de350016ce974d10db7d4d0753">fileExist</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">// - check read if present </span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOfileHeader.html#aad1bd18bfebe1913d2b10785c0aff822">readIfPresent</a>()<span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">// - write the header in the file , typeName comes from caller</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOfileHeader.html#aa4249f7a47b0674a7697f67fff575591">writeHeader</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>& os, <span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>& typeName) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="comment">// - write the header in the file, typeName comes from the one read from file </span></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOfileHeader.html#aa4249f7a47b0674a7697f67fff575591">writeHeader</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>& os) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="comment">// - read the header in the file </span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOfileHeader.html#ad3e735fcc23f3717d149728c03f5074a">readHeader</a>(<a class="code" href="classpFlow_1_1iIstream.html">iIstream</a>& is, <span class="keywordtype">bool</span> silent=<span class="keyword">false</span>);</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="comment">// - write the banner </span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOfileHeader.html#a935aedcbc2d9fc4e32646d718eaec1f4">writeBanner</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>& os)<span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  </div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="comment">// - wirte a separator line </span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOfileHeader.html#a7724614a5d68ca0d55beead4b79f6051">writeSeparator</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>& os)<span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  </div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> };</div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  </div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  </div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> }</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  </div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor">#endif //__objectFile_hpp__</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_a67068cb6552c42a5ddb1c66bf6bbf6b3"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#a67068cb6552c42a5ddb1c66bf6bbf6b3">pFlow::IOfileHeader::objectType</a></div><div class="ttdeci">const word & objectType() const</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8hpp_source.html#l00072">IOfileHeader.hpp:72</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_aad1bd18bfebe1913d2b10785c0aff822"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#aad1bd18bfebe1913d2b10785c0aff822">pFlow::IOfileHeader::readIfPresent</a></div><div class="ttdeci">bool readIfPresent() const</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8cpp_source.html#l00116">IOfileHeader.cpp:116</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_adf7afc3ea2cc179930f4e4f4ca48797c"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#adf7afc3ea2cc179930f4e4f4ca48797c">pFlow::IOfileHeader::objectType_</a></div><div class="ttdeci">word objectType_</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8hpp_source.html#l00050">IOfileHeader.hpp:50</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_ad3e735fcc23f3717d149728c03f5074a"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#ad3e735fcc23f3717d149728c03f5074a">pFlow::IOfileHeader::readHeader</a></div><div class="ttdeci">bool readHeader(iIstream &is, bool silent=false)</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8cpp_source.html#l00142">IOfileHeader.cpp:142</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_ac38363de350016ce974d10db7d4d0753"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#ac38363de350016ce974d10db7d4d0753">pFlow::IOfileHeader::fileExist</a></div><div class="ttdeci">bool fileExist() const</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8cpp_source.html#l00111">IOfileHeader.cpp:111</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"><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_1IOfileHeader_html_a7bb1f0bd1b5e54b7983dfafe4270b6d7"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#a7bb1f0bd1b5e54b7983dfafe4270b6d7">pFlow::IOfileHeader::owner_</a></div><div class="ttdeci">const repository * owner_</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8hpp_source.html#l00044">IOfileHeader.hpp:44</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_1IOfileHeader_html_aadf02aad5ab9dd4c10306e74510f4dd0"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#aadf02aad5ab9dd4c10306e74510f4dd0">pFlow::IOfileHeader::outStream</a></div><div class="ttdeci">uniquePtr< oFstream > outStream() const</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8cpp_source.html#l00032">IOfileHeader.cpp:32</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1iIstream_html"><div class="ttname"><a href="classpFlow_1_1iIstream.html">pFlow::iIstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iIstream_8hpp_source.html#l00033">iIstream.hpp:33</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_aa4249f7a47b0674a7697f67fff575591"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#aa4249f7a47b0674a7697f67fff575591">pFlow::IOfileHeader::writeHeader</a></div><div class="ttdeci">bool writeHeader(iOstream &os, const word &typeName) const</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8cpp_source.html#l00122">IOfileHeader.cpp:122</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_ae1921a7f20c43d1438221946e607c488"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#ae1921a7f20c43d1438221946e607c488">pFlow::IOfileHeader::path</a></div><div class="ttdeci">fileSystem path() const</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8cpp_source.html#l00055">IOfileHeader.cpp:55</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_aeb8db62c8360b96bf8aa002da3f6085d"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#aeb8db62c8360b96bf8aa002da3f6085d">pFlow::IOfileHeader::IOfileHeader</a></div><div class="ttdeci">IOfileHeader(const objectFile &objf, const repository *owner=nullptr)</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8cpp_source.html#l00046">IOfileHeader.cpp:46</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_a0fc09585fc6fa997b81807dff8b8236d"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#a0fc09585fc6fa997b81807dff8b8236d">pFlow::IOfileHeader::objectName_</a></div><div class="ttdeci">word objectName_</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8hpp_source.html#l00047">IOfileHeader.hpp:47</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_a2c4e952d46d447c08664eeba4e791854"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#a2c4e952d46d447c08664eeba4e791854">pFlow::IOfileHeader::owner</a></div><div class="ttdeci">const repository * owner() const</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8hpp_source.html#l00078">IOfileHeader.hpp:78</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1objectFile_html"><div class="ttname"><a href="classpFlow_1_1objectFile.html">pFlow::objectFile</a></div><div class="ttdef"><b>Definition:</b> <a href="objectFile_8hpp_source.html#l00033">objectFile.hpp:33</a></div></div>
|
|
<div class="ttc" id="aobjectFile_8hpp_html"><div class="ttname"><a href="objectFile_8hpp.html">objectFile.hpp</a></div></div>
|
|
<div class="ttc" id="astreams_8hpp_html"><div class="ttname"><a href="streams_8hpp.html">streams.hpp</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_a770eebd1866493c91efe18ab806d9568"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#a770eebd1866493c91efe18ab806d9568">pFlow::IOfileHeader::inStream</a></div><div class="ttdeci">uniquePtr< iFstream > inStream() const</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8cpp_source.html#l00024">IOfileHeader.cpp:24</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_aac13e923e67df5e79d9a75f592b97da3"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#aac13e923e67df5e79d9a75f592b97da3">pFlow::IOfileHeader::implyRead</a></div><div class="ttdeci">bool implyRead() const</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8cpp_source.html#l00100">IOfileHeader.cpp:100</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html">pFlow::IOfileHeader</a></div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8hpp_source.html#l00035">IOfileHeader.hpp:35</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_a7724614a5d68ca0d55beead4b79f6051"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#a7724614a5d68ca0d55beead4b79f6051">pFlow::IOfileHeader::writeSeparator</a></div><div class="ttdeci">bool writeSeparator(iOstream &os) const</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8cpp_source.html#l00181">IOfileHeader.cpp:181</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_a1a248aa0488b774d5160449992ad31e5"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#a1a248aa0488b774d5160449992ad31e5">pFlow::IOfileHeader::headerOk</a></div><div class="ttdeci">bool headerOk(bool silent=false)</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8cpp_source.html#l00071">IOfileHeader.cpp:71</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1uniquePtr_html"><div class="ttname"><a href="classpFlow_1_1uniquePtr.html">pFlow::uniquePtr</a></div><div class="ttdef"><b>Definition:</b> <a href="uniquePtr_8hpp_source.html#l00044">uniquePtr.hpp:44</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_a4ae6d6ea877ec8652d86076eaf333c12"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#a4ae6d6ea877ec8652d86076eaf333c12">pFlow::IOfileHeader::objectName</a></div><div class="ttdeci">const word & objectName() const</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8hpp_source.html#l00066">IOfileHeader.hpp:66</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1repository_html"><div class="ttname"><a href="classpFlow_1_1repository.html">pFlow::repository</a></div><div class="ttdef"><b>Definition:</b> <a href="repository_8hpp_source.html#l00034">repository.hpp:34</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_adfb03998f9b3b981631dc794cffd05a1"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#adfb03998f9b3b981631dc794cffd05a1">pFlow::IOfileHeader::implyWrite</a></div><div class="ttdeci">bool implyWrite() const</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8cpp_source.html#l00106">IOfileHeader.cpp:106</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1iOstream_html"><div class="ttname"><a href="classpFlow_1_1iOstream.html">pFlow::iOstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00053">iOstream.hpp:53</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1IOfileHeader_html_a935aedcbc2d9fc4e32646d718eaec1f4"><div class="ttname"><a href="classpFlow_1_1IOfileHeader.html#a935aedcbc2d9fc4e32646d718eaec1f4">pFlow::IOfileHeader::writeBanner</a></div><div class="ttdeci">bool writeBanner(iOstream &os) const</div><div class="ttdef"><b>Definition:</b> <a href="IOfileHeader_8cpp_source.html#l00170">IOfileHeader.cpp:170</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_8a09dd5b7fce343a5c545316ddba4e1b.html">repository</a></li><li class="navelem"><a class="el" href="dir_557182f9d267f2db2f460147f8d9cd32.html">IOobject</a></li><li class="navelem"><a class="el" href="IOfileHeader_8hpp.html">IOfileHeader.hpp</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|