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

216 lines
22 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/eventSubscriber.cpp 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('eventSubscriber_8cpp_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">eventSubscriber.cpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="eventSubscriber_8cpp.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; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="eventSubscriber_8hpp.html">eventSubscriber.hpp</a>&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Set_8hpp.html">Set.hpp</a>&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classpFlow_1_1eventSubscriber.html#a4fe17de555051fd4062006af5b54c755"> 25</a></span>&#160;<a class="code" href="classpFlow_1_1eventSubscriber.html#a4fe17de555051fd4062006af5b54c755">pFlow::eventSubscriber::~eventSubscriber</a>()</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; <span class="keywordflow">for</span>(<span class="keyword">auto</span>&amp; observer:<a class="code" href="classpFlow_1_1eventSubscriber.html#ac73c100aa0cf2bf7ffc79a739d5f3ab7">observerList_</a>)</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; observer-&gt;invalidateSubscriber();</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; }</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;<span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1eventSubscriber.html#a7d53ce19a500ec6de33f564e36f658df">pFlow::eventSubscriber::subscribe</a></div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classpFlow_1_1eventSubscriber.html#a7d53ce19a500ec6de33f564e36f658df"> 34</a></span>&#160;(</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="classpFlow_1_1eventObserver.html">eventObserver</a>* observer</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;)<span class="keyword">const</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">if</span>(observer)</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"> 40</span>&#160; observerList_.push_back(observer);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; }</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">else</span></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="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; }</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</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="keywordtype">bool</span> <a class="code" href="classpFlow_1_1eventSubscriber.html#a8ab6c2b69854876b1f5777553cf190ed">pFlow::eventSubscriber::unsubscribe</a></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classpFlow_1_1eventSubscriber.html#a8ab6c2b69854876b1f5777553cf190ed"> 50</a></span>&#160;(</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="classpFlow_1_1eventObserver.html">eventObserver</a>* observer</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;)<span class="keyword">const</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;{</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">if</span>(observer)</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; {</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; observerList_.remove(observer);</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="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;}</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="keywordtype">bool</span> <a class="code" href="classpFlow_1_1eventSubscriber.html#a8be673bd14011c024b47ba6a391e75fc">pFlow::eventSubscriber::notify</a></div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classpFlow_1_1eventSubscriber.html#a8be673bd14011c024b47ba6a391e75fc"> 62</a></span>&#160;(</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">const</span> <a class="code" href="classpFlow_1_1eventMessage.html">eventMessage</a> &amp;msg</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;)</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"> 66</span>&#160; <span class="keywordflow">for</span> ( <span class="keyword">auto</span>&amp; observer:observerList_ )</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">if</span>(observer)</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordflow">if</span>( !observer-&gt;<a class="code" href="classpFlow_1_1eventObserver.html#a64730bf40b61714954f7d250702052df">update</a>(msg) ) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; }</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;}</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1eventSubscriber.html#a8be673bd14011c024b47ba6a391e75fc">pFlow::eventSubscriber::notify</a></div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classpFlow_1_1eventSubscriber.html#a064ad67bb3dfc6fff5f239149913f61d"> 76</a></span>&#160;(</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">const</span> <a class="code" href="classpFlow_1_1eventMessage.html">eventMessage</a>&amp; msg,</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">const</span> <a class="code" href="classpFlow_1_1List.html">List&lt;eventObserver*&gt;</a>&amp; exclutionList</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;)</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;{</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="namespacepFlow.html#a5a3972b374b884e9021d78ba9ea58014">Set&lt;eventObserver*&gt;</a> sortedExcList(exclutionList.begin(),exclutionList.end());</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordflow">for</span>(<span class="keyword">auto</span>&amp; observer:observerList_)</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="keywordflow">if</span>( observer &amp;&amp; sortedExcList.count(observer) == 0 )</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; {</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">if</span>(!observer-&gt;<a class="code" href="classpFlow_1_1eventObserver.html#a64730bf40b61714954f7d250702052df">update</a>(msg)) <span class="keywordflow">return</span> <span class="keyword">false</span>;</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; }</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclasspFlow_1_1List_html"><div class="ttname"><a href="classpFlow_1_1List.html">pFlow::List</a></div><div class="ttdef"><b>Definition:</b> <a href="List_8hpp_source.html#l00039">List.hpp:39</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_1eventSubscriber_html_a8be673bd14011c024b47ba6a391e75fc"><div class="ttname"><a href="classpFlow_1_1eventSubscriber.html#a8be673bd14011c024b47ba6a391e75fc">pFlow::eventSubscriber::notify</a></div><div class="ttdeci">bool notify(const eventMessage &amp;msg)</div><div class="ttdef"><b>Definition:</b> <a href="eventSubscriber_8cpp_source.html#l00062">eventSubscriber.cpp:62</a></div></div>
<div class="ttc" id="aSet_8hpp_html"><div class="ttname"><a href="Set_8hpp.html">Set.hpp</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a5a3972b374b884e9021d78ba9ea58014"><div class="ttname"><a href="namespacepFlow.html#a5a3972b374b884e9021d78ba9ea58014">pFlow::Set</a></div><div class="ttdeci">std::set&lt; Key, std::less&lt; Key &gt;, std::allocator&lt; Key &gt; &gt; Set</div><div class="ttdef"><b>Definition:</b> <a href="Set_8hpp_source.html#l00031">Set.hpp:31</a></div></div>
<div class="ttc" id="aclasspFlow_1_1eventSubscriber_html_ac73c100aa0cf2bf7ffc79a739d5f3ab7"><div class="ttname"><a href="classpFlow_1_1eventSubscriber.html#ac73c100aa0cf2bf7ffc79a739d5f3ab7">pFlow::eventSubscriber::observerList_</a></div><div class="ttdeci">List&lt; eventObserver * &gt; observerList_</div><div class="ttdef"><b>Definition:</b> <a href="eventSubscriber_8hpp_source.html#l00039">eventSubscriber.hpp:39</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="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 &amp;msg)=0</div></div>
<div class="ttc" id="aclasspFlow_1_1eventSubscriber_html_a7d53ce19a500ec6de33f564e36f658df"><div class="ttname"><a href="classpFlow_1_1eventSubscriber.html#a7d53ce19a500ec6de33f564e36f658df">pFlow::eventSubscriber::subscribe</a></div><div class="ttdeci">virtual bool subscribe(eventObserver *observer) const</div><div class="ttdef"><b>Definition:</b> <a href="eventSubscriber_8cpp_source.html#l00034">eventSubscriber.cpp:34</a></div></div>
<div class="ttc" id="aclasspFlow_1_1eventSubscriber_html_a4fe17de555051fd4062006af5b54c755"><div class="ttname"><a href="classpFlow_1_1eventSubscriber.html#a4fe17de555051fd4062006af5b54c755">pFlow::eventSubscriber::~eventSubscriber</a></div><div class="ttdeci">virtual ~eventSubscriber()</div><div class="ttdef"><b>Definition:</b> <a href="eventSubscriber_8cpp_source.html#l00025">eventSubscriber.cpp:25</a></div></div>
<div class="ttc" id="aclasspFlow_1_1eventSubscriber_html_a8ab6c2b69854876b1f5777553cf190ed"><div class="ttname"><a href="classpFlow_1_1eventSubscriber.html#a8ab6c2b69854876b1f5777553cf190ed">pFlow::eventSubscriber::unsubscribe</a></div><div class="ttdeci">virtual bool unsubscribe(eventObserver *observer) const</div><div class="ttdef"><b>Definition:</b> <a href="eventSubscriber_8cpp_source.html#l00050">eventSubscriber.cpp:50</a></div></div>
<div class="ttc" id="aeventSubscriber_8hpp_html"><div class="ttname"><a href="eventSubscriber_8hpp.html">eventSubscriber.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="eventSubscriber_8cpp.html">eventSubscriber.cpp</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>