190 lines
20 KiB
HTML
190 lines
20 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/eventSubscriber/eventObserver.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('eventObserver_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">eventObserver.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="eventObserver_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 __eventObserver_hpp__</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define __eventObserver_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> <span class="preprocessor">#include "<a class="code" href="eventMessage_8hpp.html">eventMessage.hpp</a>"</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="keyword">namespace </span><a class="code" href="namespacepFlow.html">pFlow</a></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</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">class </span>eventSubscriber;</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"><a class="line" href="classpFlow_1_1eventObserver.html"> 33</a></span> <span class="keyword">class </span><a class="code" href="classpFlow_1_1eventObserver.html">eventObserver</a></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classpFlow_1_1eventObserver.html#a0fb69aec8e6e5c3f6a27c4ecc724338b"> 37</a></span>  <span class="keyword">const</span> <a class="code" href="classpFlow_1_1eventSubscriber.html">eventSubscriber</a>* <a class="code" href="classpFlow_1_1eventObserver.html#a0fb69aec8e6e5c3f6a27c4ecc724338b">subscriber_</a> = <span class="keyword">nullptr</span>;</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="comment">// if this object is linked to subscriber </span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classpFlow_1_1eventObserver.html#afe38338c2fa622334e0f3d49d455ab47"> 40</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1eventObserver.html#afe38338c2fa622334e0f3d49d455ab47">subscribed_</a> = <span class="keyword">false</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="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="classpFlow_1_1eventObserver.html#a69e17341cf34a16cf432fe89b5d1e3d1">eventObserver</a>();</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>  <a class="code" href="classpFlow_1_1eventObserver.html#a69e17341cf34a16cf432fe89b5d1e3d1">eventObserver</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1eventSubscriber.html">eventSubscriber</a>& subscriber, <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1eventObserver.html#a7d5ac42c30174e7700a36b3d05de5747">subscribe</a> = <span class="keyword">true</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="keyword">virtual</span> <a class="code" href="classpFlow_1_1eventObserver.html#ab4a79ac5fa9ae6f5074748fe4b8fc954">~eventObserver</a>();</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classpFlow_1_1eventObserver.html#a0bbca55d6c8f234990c4f78bf4449288"> 50</a></span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1eventObserver.html#a0bbca55d6c8f234990c4f78bf4449288">subscribed</a>()<span class="keyword">const </span>{<span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1eventObserver.html#afe38338c2fa622334e0f3d49d455ab47">subscribed_</a>;}</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1eventObserver.html#a7d5ac42c30174e7700a36b3d05de5747">subscribe</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1eventSubscriber.html">eventSubscriber</a>& subscriber);</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classpFlow_1_1eventObserver.html#a6945b636972adfaba66c9ca5f1e68a25"> 54</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classpFlow_1_1eventObserver.html#a6945b636972adfaba66c9ca5f1e68a25">invalidateSubscriber</a>()</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>  <a class="code" href="classpFlow_1_1eventObserver.html#afe38338c2fa622334e0f3d49d455ab47">subscribed_</a> = <span class="keyword">false</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="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1eventObserver.html#a64730bf40b61714954f7d250702052df">update</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1eventMessage.html">eventMessage</a>& msg)=0;</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> } <span class="comment">// pFlow</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</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="preprocessor">#endif // __eventObserver_hpp__</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="aclasspFlow_1_1eventObserver_html_a6945b636972adfaba66c9ca5f1e68a25"><div class="ttname"><a href="classpFlow_1_1eventObserver.html#a6945b636972adfaba66c9ca5f1e68a25">pFlow::eventObserver::invalidateSubscriber</a></div><div class="ttdeci">void invalidateSubscriber()</div><div class="ttdef"><b>Definition:</b> <a href="eventObserver_8hpp_source.html#l00054">eventObserver.hpp:54</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1eventSubscriber_html"><div class="ttname"><a href="classpFlow_1_1eventSubscriber.html">pFlow::eventSubscriber</a></div><div class="ttdef"><b>Definition:</b> <a href="eventSubscriber_8hpp_source.html#l00034">eventSubscriber.hpp:34</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1eventObserver_html_a7d5ac42c30174e7700a36b3d05de5747"><div class="ttname"><a href="classpFlow_1_1eventObserver.html#a7d5ac42c30174e7700a36b3d05de5747">pFlow::eventObserver::subscribe</a></div><div class="ttdeci">bool subscribe(const eventSubscriber &subscriber)</div><div class="ttdef"><b>Definition:</b> <a href="eventObserver_8cpp_source.html#l00050">eventObserver.cpp:50</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1eventObserver_html_a69e17341cf34a16cf432fe89b5d1e3d1"><div class="ttname"><a href="classpFlow_1_1eventObserver.html#a69e17341cf34a16cf432fe89b5d1e3d1">pFlow::eventObserver::eventObserver</a></div><div class="ttdeci">eventObserver()</div><div class="ttdef"><b>Definition:</b> <a href="eventObserver_8cpp_source.html#l00024">eventObserver.cpp:24</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1eventMessage_html"><div class="ttname"><a href="classpFlow_1_1eventMessage.html">pFlow::eventMessage</a></div><div class="ttdef"><b>Definition:</b> <a href="eventMessage_8hpp_source.html#l00029">eventMessage.hpp:29</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1eventObserver_html_a0bbca55d6c8f234990c4f78bf4449288"><div class="ttname"><a href="classpFlow_1_1eventObserver.html#a0bbca55d6c8f234990c4f78bf4449288">pFlow::eventObserver::subscribed</a></div><div class="ttdeci">bool subscribed() const</div><div class="ttdef"><b>Definition:</b> <a href="eventObserver_8hpp_source.html#l00050">eventObserver.hpp:50</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1eventObserver_html_afe38338c2fa622334e0f3d49d455ab47"><div class="ttname"><a href="classpFlow_1_1eventObserver.html#afe38338c2fa622334e0f3d49d455ab47">pFlow::eventObserver::subscribed_</a></div><div class="ttdeci">bool subscribed_</div><div class="ttdef"><b>Definition:</b> <a href="eventObserver_8hpp_source.html#l00040">eventObserver.hpp:40</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1eventObserver_html_ab4a79ac5fa9ae6f5074748fe4b8fc954"><div class="ttname"><a href="classpFlow_1_1eventObserver.html#ab4a79ac5fa9ae6f5074748fe4b8fc954">pFlow::eventObserver::~eventObserver</a></div><div class="ttdeci">virtual ~eventObserver()</div><div class="ttdef"><b>Definition:</b> <a href="eventObserver_8cpp_source.html#l00044">eventObserver.cpp:44</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1eventObserver_html"><div class="ttname"><a href="classpFlow_1_1eventObserver.html">pFlow::eventObserver</a></div><div class="ttdef"><b>Definition:</b> <a href="eventObserver_8hpp_source.html#l00033">eventObserver.hpp:33</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_1eventObserver_html_a64730bf40b61714954f7d250702052df"><div class="ttname"><a href="classpFlow_1_1eventObserver.html#a64730bf40b61714954f7d250702052df">pFlow::eventObserver::update</a></div><div class="ttdeci">virtual bool update(const eventMessage &msg)=0</div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1eventObserver_html_a0fb69aec8e6e5c3f6a27c4ecc724338b"><div class="ttname"><a href="classpFlow_1_1eventObserver.html#a0fb69aec8e6e5c3f6a27c4ecc724338b">pFlow::eventObserver::subscriber_</a></div><div class="ttdeci">const eventSubscriber * subscriber_</div><div class="ttdef"><b>Definition:</b> <a href="eventObserver_8hpp_source.html#l00037">eventObserver.hpp:37</a></div></div>
|
|
<div class="ttc" id="aeventMessage_8hpp_html"><div class="ttname"><a href="eventMessage_8hpp.html">eventMessage.hpp</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_f2d1de0559fb274c8b34b5d7634aedcc.html">eventSubscriber</a></li><li class="navelem"><a class="el" href="eventObserver_8hpp.html">eventObserver.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>
|