phasicFlow/doc/code-documentation/html/dataEntry_8hpp_source.html

303 lines
42 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/dictionary/entry/dataEntry.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&amp;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>
&#160;<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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('dataEntry_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">dataEntry.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="dataEntry_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>&#160;<span class="comment">/*------------------------------- phasicFlow ---------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> O C enter of</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> O O E ngineering and</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> O O M ultiscale modeling of</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> OOOOOOO F luid flow </span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> Copyright (C): www.cemf.ir</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> email: hamid.r.norouzi AT gmail.com</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">------------------------------------------------------------------------------ </span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">Licence:</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"> </span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">-----------------------------------------------------------------------------*/</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">// based on OpenFOAM dictionary, with some modifications/simplifications</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">// to be tailored to our needs</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#ifndef __dataEntry_hpp__</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define __dataEntry_hpp__</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="iEntry_8hpp.html">iEntry.hpp</a>&quot;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="iTstream_8hpp.html">iTstream.hpp</a>&quot;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="oTstream_8hpp.html">oTstream.hpp</a>&quot;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacepFlow.html">pFlow</a></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;{</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">class </span>dictionary;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classpFlow_1_1dataEntry.html"> 40</a></span>&#160;<span class="keyword">class </span><a class="code" href="classpFlow_1_1dataEntry.html">dataEntry</a></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;:</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">public</span> <a class="code" href="classpFlow_1_1iEntry.html">iEntry</a></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;{</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </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">// - ref to parrent dictionary</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classpFlow_1_1dataEntry.html#aa915306f87921d86b69eaeb8032015f7"> 50</a></span>&#160; <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; <a class="code" href="classpFlow_1_1dataEntry.html#aa915306f87921d86b69eaeb8032015f7">parDict_</a>;</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">// - list the tokens as input token stream</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classpFlow_1_1dataEntry.html#a79c4b8a30c00f40c6ae2334fab4f9ec0"> 53</a></span>&#160; <a class="code" href="classpFlow_1_1iTstream.html">iTstream</a> <a class="code" href="classpFlow_1_1dataEntry.html#a79c4b8a30c00f40c6ae2334fab4f9ec0">tokenStream_</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; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="comment">// - read dataEntry from stream</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1dataEntry.html#a12a2f078710c7419e84afd6cdd58ac70">readDataEntry</a>(<a class="code" href="classpFlow_1_1iIstream.html">iIstream</a>&amp; is);</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; <span class="comment">// - write dataEntry to stream</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1dataEntry.html#aad22b29fba434ea640dcf3dcf1beb293">writeDataEntry</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>&amp; os) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classpFlow_1_1dataEntry.html#a69b422672deb33016b466d4f7ac204ba"> 66</a></span>&#160; <span class="keyword">static</span> <a class="code" href="classpFlow_1_1dataEntry.html">dataEntry</a> <a class="code" href="classpFlow_1_1dataEntry.html#a69b422672deb33016b466d4f7ac204ba">nullDataEntry</a>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</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; <span class="comment">// - construct null dataEntry</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="classpFlow_1_1dataEntry.html#a11137fa1981cd8a32fe7ff5edb606fe3">dataEntry</a>();</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">// - construct from keyword and parDict, empty dataEntry</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <a class="code" href="classpFlow_1_1dataEntry.html#a11137fa1981cd8a32fe7ff5edb606fe3">dataEntry</a>(<span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&amp; <a class="code" href="classpFlow_1_1iEntry.html#a7c88d41e6cee4f2ba2bfa06e3078373a">keyword</a>, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; parDict);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="comment">// - construct from keyword, parDict and input token stream</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="classpFlow_1_1dataEntry.html#a11137fa1981cd8a32fe7ff5edb606fe3">dataEntry</a>(<span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&amp; keyWord, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; parDict, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1iTstream.html">iTstream</a>&amp; is);</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; <span class="comment">//- construct from keyword, parDict and input stream</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="classpFlow_1_1dataEntry.html#a11137fa1981cd8a32fe7ff5edb606fe3">dataEntry</a>(<span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&amp; keyWord, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; parDict, <a class="code" href="classpFlow_1_1iIstream.html">iIstream</a>&amp; is);</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; <span class="comment">// - construct from keyword, parDict and a single token</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <a class="code" href="classpFlow_1_1dataEntry.html#a11137fa1981cd8a32fe7ff5edb606fe3">dataEntry</a>(<span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&amp; <a class="code" href="classpFlow_1_1iEntry.html#a7c88d41e6cee4f2ba2bfa06e3078373a">keyword</a>, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; parDict, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1token.html">token</a>&amp; tok);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="comment">// - construct from keyword, parDict, and data of type T</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <a class="code" href="classpFlow_1_1dataEntry.html#a11137fa1981cd8a32fe7ff5edb606fe3">dataEntry</a>(<span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&amp; <a class="code" href="classpFlow_1_1iEntry.html#a7c88d41e6cee4f2ba2bfa06e3078373a">keyword</a>, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; parDict, <span class="keyword">const</span> T&amp; v);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="comment">// - copy construct with new keyword and parDict</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <a class="code" href="classpFlow_1_1dataEntry.html#a11137fa1981cd8a32fe7ff5edb606fe3">dataEntry</a>(<span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&amp; <a class="code" href="classpFlow_1_1iEntry.html#a7c88d41e6cee4f2ba2bfa06e3078373a">keyword</a>, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; parDict, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dataEntry.html">dataEntry</a>&amp; entry );</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="comment">// - copy construct</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <a class="code" href="classpFlow_1_1dataEntry.html#a11137fa1981cd8a32fe7ff5edb606fe3">dataEntry</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1dataEntry.html">dataEntry</a>&amp; src )= <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="comment">// - global name of entry, separated with dots</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">virtual</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> <a class="code" href="classpFlow_1_1dataEntry.html#a85c3c1fce0c14d36030092df2f27b632">globalName</a>()<span class="keyword">const</span>;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="comment">// - access to token stream</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classpFlow_1_1iTstream.html">iTstream</a>&amp; <a class="code" href="classpFlow_1_1dataEntry.html#aec6909dffed34a3c8c286c344e4cf656">stream</a>();</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="comment">// - not permited to be called</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>* <a class="code" href="classpFlow_1_1dataEntry.html#a33ae8969435c4cbab441451744588591">dictPtr</a>();</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="comment">// - not permited to be called</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>* <a class="code" href="classpFlow_1_1dataEntry.html#a33ae8969435c4cbab441451744588591">dictPtr</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="comment">// - should returen false;</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1dataEntry.html#aed15599ef76092b99a4f4241816eff02">isDictionary</a>()<span class="keyword">const</span>;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="comment">// - const ref to parrent dictionary </span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; <a class="code" href="classpFlow_1_1dataEntry.html#a69904924abd50610c0a078515c9d39ed">parrentDict</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="comment">// - not permited to be called</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; <a class="code" href="classpFlow_1_1dataEntry.html#a3c48fdd67832443dbef24c124f7512d2">dict</a>();</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="comment">// - not permited to be called</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; <a class="code" href="classpFlow_1_1dataEntry.html#a3c48fdd67832443dbef24c124f7512d2">dict</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="comment">// clone the object</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classpFlow_1_1iEntry.html">iEntry</a>* <a class="code" href="classpFlow_1_1dataEntry.html#afc71ebfe0388847de8017552d16e4c90">clonePtr</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classpFlow_1_1uniquePtr.html">uniquePtr&lt;iEntry&gt;</a> <a class="code" href="classpFlow_1_1dataEntry.html#a5581674fad3e61d4e5391091517d9380">clone</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="comment">// clone the object and change its ownership to parDict </span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classpFlow_1_1iEntry.html">iEntry</a>* <a class="code" href="classpFlow_1_1dataEntry.html#afc71ebfe0388847de8017552d16e4c90">clonePtr</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; parDict) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classpFlow_1_1uniquePtr.html">uniquePtr&lt;iEntry&gt;</a> <a class="code" href="classpFlow_1_1dataEntry.html#a5581674fad3e61d4e5391091517d9380">clone</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; parDict)<span class="keyword">const</span>;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; </div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="comment">// - read from stream</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1dataEntry.html#aff8e92ab47032ae811d1271161cb9b22">read</a>(<a class="code" href="classpFlow_1_1iIstream.html">iIstream</a>&amp; is);</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="comment">// - write to stream</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1dataEntry.html#a6a40de4ceed55b2f78cf3027739dfd91">write</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>&amp; os) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;};</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; </div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00147"></a><span class="lineno"><a class="line" href="classpFlow_1_1dataEntry.html#afc423114f2030ef34706ad3f8aeb7773"> 147</a></span>&#160;<a class="code" href="classpFlow_1_1dataEntry.html#a11137fa1981cd8a32fe7ff5edb606fe3">dataEntry::dataEntry</a>(<span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&amp; keyword, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>&amp; parDict, <span class="keyword">const</span> T&amp; v)</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;:</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <a class="code" href="classpFlow_1_1dataEntry.html">dataEntry</a>(keyword, parDict)</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;{</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <a class="code" href="classpFlow_1_1oTstream.html">oTstream</a> os(<span class="stringliteral">&quot;oTStream for &quot;</span> + <a class="code" href="classpFlow_1_1dataEntry.html#a85c3c1fce0c14d36030092df2f27b632">globalName</a>());</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; </div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; os&lt;&lt; v &lt;&lt; <a class="code" href="namespacepFlow.html#a8c6bd0c60160c712f4f4a4b00e48183f">endStatementToken</a>();</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; </div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; <a class="code" href="classpFlow_1_1dataEntry.html#a79c4b8a30c00f40c6ae2334fab4f9ec0">tokenStream_</a> = std::move(os.<a class="code" href="classpFlow_1_1oTstream.html#afc3e5f6037eecf144698420e4d94a70a">tokens</a>());</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;}</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; </div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;} <span class="comment">// pFlow</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; </div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; </div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;<span class="preprocessor">#endif //__dataEntry_hpp__</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclasspFlow_1_1oTstream_html"><div class="ttname"><a href="classpFlow_1_1oTstream.html">pFlow::oTstream</a></div><div class="ttdef"><b>Definition:</b> <a href="oTstream_8hpp_source.html#l00023">oTstream.hpp:23</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_a12a2f078710c7419e84afd6cdd58ac70"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#a12a2f078710c7419e84afd6cdd58ac70">pFlow::dataEntry::readDataEntry</a></div><div class="ttdeci">bool readDataEntry(iIstream &amp;is)</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00035">dataEntry.cpp:35</a></div></div>
<div class="ttc" id="aiTstream_8hpp_html"><div class="ttname"><a href="iTstream_8hpp.html">iTstream.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1token_html"><div class="ttname"><a href="classpFlow_1_1token.html">pFlow::token</a></div><div class="ttdef"><b>Definition:</b> <a href="token_8hpp_source.html#l00042">token.hpp:42</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_aec6909dffed34a3c8c286c344e4cf656"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#aec6909dffed34a3c8c286c344e4cf656">pFlow::dataEntry::stream</a></div><div class="ttdeci">virtual iTstream &amp; stream()</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00261">dataEntry.cpp:261</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a8c6bd0c60160c712f4f4a4b00e48183f"><div class="ttname"><a href="namespacepFlow.html#a8c6bd0c60160c712f4f4a4b00e48183f">pFlow::endStatementToken</a></div><div class="ttdeci">token endStatementToken()</div><div class="ttdef"><b>Definition:</b> <a href="token_8hpp_source.html#l00504">token.hpp:504</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_a69904924abd50610c0a078515c9d39ed"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#a69904924abd50610c0a078515c9d39ed">pFlow::dataEntry::parrentDict</a></div><div class="ttdeci">virtual const dictionary &amp; parrentDict() const</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00297">dataEntry.cpp:297</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_a85c3c1fce0c14d36030092df2f27b632"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#a85c3c1fce0c14d36030092df2f27b632">pFlow::dataEntry::globalName</a></div><div class="ttdeci">virtual word globalName() const</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00291">dataEntry.cpp:291</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_aad22b29fba434ea640dcf3dcf1beb293"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#aad22b29fba434ea640dcf3dcf1beb293">pFlow::dataEntry::writeDataEntry</a></div><div class="ttdeci">bool writeDataEntry(iOstream &amp;os) const</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00098">dataEntry.cpp:98</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="aoTstream_8hpp_html"><div class="ttname"><a href="oTstream_8hpp.html">oTstream.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iEntry_html_a7c88d41e6cee4f2ba2bfa06e3078373a"><div class="ttname"><a href="classpFlow_1_1iEntry.html#a7c88d41e6cee4f2ba2bfa06e3078373a">pFlow::iEntry::keyword</a></div><div class="ttdeci">virtual const word &amp; keyword() const</div><div class="ttdef"><b>Definition:</b> <a href="iEntry_8hpp_source.html#l00084">iEntry.hpp:84</a></div></div>
<div class="ttc" id="aclasspFlow_1_1oTstream_html_afc3e5f6037eecf144698420e4d94a70a"><div class="ttname"><a href="classpFlow_1_1oTstream.html#afc3e5f6037eecf144698420e4d94a70a">pFlow::oTstream::tokens</a></div><div class="ttdeci">const tokenList &amp; tokens() const</div><div class="ttdef"><b>Definition:</b> <a href="oTstream_8cpp_source.html#l00032">oTstream.cpp:32</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_1dataEntry_html_aa915306f87921d86b69eaeb8032015f7"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#aa915306f87921d86b69eaeb8032015f7">pFlow::dataEntry::parDict_</a></div><div class="ttdeci">const dictionary &amp; parDict_</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8hpp_source.html#l00050">dataEntry.hpp:50</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_a11137fa1981cd8a32fe7ff5edb606fe3"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#a11137fa1981cd8a32fe7ff5edb606fe3">pFlow::dataEntry::dataEntry</a></div><div class="ttdeci">dataEntry()</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00159">dataEntry.cpp:159</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html"><div class="ttname"><a href="classpFlow_1_1dataEntry.html">pFlow::dataEntry</a></div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8hpp_source.html#l00040">dataEntry.hpp:40</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_1dataEntry_html_a79c4b8a30c00f40c6ae2334fab4f9ec0"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#a79c4b8a30c00f40c6ae2334fab4f9ec0">pFlow::dataEntry::tokenStream_</a></div><div class="ttdeci">iTstream tokenStream_</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8hpp_source.html#l00053">dataEntry.hpp:53</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_a33ae8969435c4cbab441451744588591"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#a33ae8969435c4cbab441451744588591">pFlow::dataEntry::dictPtr</a></div><div class="ttdeci">virtual dictionary * dictPtr()</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00269">dataEntry.cpp:269</a></div></div>
<div class="ttc" id="aiEntry_8hpp_html"><div class="ttname"><a href="iEntry_8hpp.html">iEntry.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_a69b422672deb33016b466d4f7ac204ba"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#a69b422672deb33016b466d4f7ac204ba">pFlow::dataEntry::nullDataEntry</a></div><div class="ttdeci">static dataEntry nullDataEntry</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8hpp_source.html#l00066">dataEntry.hpp:66</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_aed15599ef76092b99a4f4241816eff02"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#aed15599ef76092b99a4f4241816eff02">pFlow::dataEntry::isDictionary</a></div><div class="ttdeci">virtual bool isDictionary() const</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00286">dataEntry.cpp:286</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iTstream_html"><div class="ttname"><a href="classpFlow_1_1iTstream.html">pFlow::iTstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iTstream_8hpp_source.html#l00021">iTstream.hpp:21</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_aff8e92ab47032ae811d1271161cb9b22"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#aff8e92ab47032ae811d1271161cb9b22">pFlow::dataEntry::read</a></div><div class="ttdeci">virtual bool read(iIstream &amp;is)</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00345">dataEntry.cpp:345</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_1dataEntry_html_a5581674fad3e61d4e5391091517d9380"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#a5581674fad3e61d4e5391091517d9380">pFlow::dataEntry::clone</a></div><div class="ttdeci">virtual uniquePtr&lt; iEntry &gt; clone() const</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00321">dataEntry.cpp:321</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iEntry_html"><div class="ttname"><a href="classpFlow_1_1iEntry.html">pFlow::iEntry</a></div><div class="ttdef"><b>Definition:</b> <a href="iEntry_8hpp_source.html#l00038">iEntry.hpp:38</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_afc71ebfe0388847de8017552d16e4c90"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#afc71ebfe0388847de8017552d16e4c90">pFlow::dataEntry::clonePtr</a></div><div class="ttdeci">virtual iEntry * clonePtr() const</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00327">dataEntry.cpp:327</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_a3c48fdd67832443dbef24c124f7512d2"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#a3c48fdd67832443dbef24c124f7512d2">pFlow::dataEntry::dict</a></div><div class="ttdeci">virtual dictionary &amp; dict()</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00303">dataEntry.cpp:303</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_a6a40de4ceed55b2f78cf3027739dfd91"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#a6a40de4ceed55b2f78cf3027739dfd91">pFlow::dataEntry::write</a></div><div class="ttdeci">virtual bool write(iOstream &amp;os) const</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00366">dataEntry.cpp:366</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_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 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_1220c712ed5f98fd84ba71b4848374db.html">dictionary</a></li><li class="navelem"><a class="el" href="dir_12939209666026aa3d509ab05383a6fb.html">entry</a></li><li class="navelem"><a class="el" href="dataEntry_8hpp.html">dataEntry.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>