xfygogo
/
phasicFlow
mirror of https://github.com/PhasicFlow/phasicFlow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
phasicFlow/doc/code-documentation/html/classpFlow_1_1eventSubscrib...

387 lines
20 KiB
HTML
Raw Blame History

<!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: eventSubscriber Class Reference</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('classpFlow_1_1eventSubscriber.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classpFlow_1_1eventSubscriber-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">eventSubscriber Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for eventSubscriber:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1eventSubscriber__inherit__graph.png" border="0" usemap="#eventSubscriber_inherit__map" alt="Inheritance graph"/></div>
<map name="eventSubscriber_inherit__map" id="eventSubscriber_inherit__map">
<area shape="rect" title=" " alt="" coords="61,5,187,32"/>
<area shape="rect" href="classpFlow_1_1pointStructure.html" title=" " alt="" coords="5,80,120,107"/>
<area shape="rect" href="classpFlow_1_1triSurface.html" title=" " alt="" coords="144,80,229,107"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for eventSubscriber:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1eventSubscriber__coll__graph.png" border="0" usemap="#eventSubscriber_coll__map" alt="Collaboration graph"/></div>
<map name="eventSubscriber_coll__map" id="eventSubscriber_coll__map">
<area shape="rect" title=" " alt="" coords="56,95,183,121"/>
<area shape="rect" href="classpFlow_1_1List.html" title=" " alt="" coords="5,5,233,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad2c10adc1df71b0ad3daffab23eecbd6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1eventSubscriber.html#ad2c10adc1df71b0ad3daffab23eecbd6">eventSubscriber</a> ()</td></tr>
<tr class="separator:ad2c10adc1df71b0ad3daffab23eecbd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fe17de555051fd4062006af5b54c755"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1eventSubscriber.html#a4fe17de555051fd4062006af5b54c755">~eventSubscriber</a> ()</td></tr>
<tr class="separator:a4fe17de555051fd4062006af5b54c755"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d53ce19a500ec6de33f564e36f658df"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1eventSubscriber.html#a7d53ce19a500ec6de33f564e36f658df">subscribe</a> (<a class="el" href="classpFlow_1_1eventObserver.html">eventObserver</a> *observer) const</td></tr>
<tr class="separator:a7d53ce19a500ec6de33f564e36f658df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ab6c2b69854876b1f5777553cf190ed"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1eventSubscriber.html#a8ab6c2b69854876b1f5777553cf190ed">unsubscribe</a> (<a class="el" href="classpFlow_1_1eventObserver.html">eventObserver</a> *observer) const</td></tr>
<tr class="separator:a8ab6c2b69854876b1f5777553cf190ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8be673bd14011c024b47ba6a391e75fc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1eventSubscriber.html#a8be673bd14011c024b47ba6a391e75fc">notify</a> (const <a class="el" href="classpFlow_1_1eventMessage.html">eventMessage</a> &amp;msg)</td></tr>
<tr class="separator:a8be673bd14011c024b47ba6a391e75fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a064ad67bb3dfc6fff5f239149913f61d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1eventSubscriber.html#a064ad67bb3dfc6fff5f239149913f61d">notify</a> (const <a class="el" href="classpFlow_1_1eventMessage.html">eventMessage</a> &amp;msg, const <a class="el" href="classpFlow_1_1List.html">List</a>&lt; <a class="el" href="classpFlow_1_1eventObserver.html">eventObserver</a> * &gt; &amp;exclutionList)</td></tr>
<tr class="separator:a064ad67bb3dfc6fff5f239149913f61d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ac73c100aa0cf2bf7ffc79a739d5f3ab7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1List.html">List</a>&lt; <a class="el" href="classpFlow_1_1eventObserver.html">eventObserver</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1eventSubscriber.html#ac73c100aa0cf2bf7ffc79a739d5f3ab7">observerList_</a></td></tr>
<tr class="separator:ac73c100aa0cf2bf7ffc79a739d5f3ab7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="eventSubscriber_8hpp_source.html#l00034">34</a> of file <a class="el" href="eventSubscriber_8hpp_source.html">eventSubscriber.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad2c10adc1df71b0ad3daffab23eecbd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2c10adc1df71b0ad3daffab23eecbd6">&#9670;&nbsp;</a></span>eventSubscriber()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1eventSubscriber.html">eventSubscriber</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="eventSubscriber_8hpp_source.html#l00043">43</a> of file <a class="el" href="eventSubscriber_8hpp_source.html">eventSubscriber.hpp</a>.</p>
</div>
</div>
<a id="a4fe17de555051fd4062006af5b54c755"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fe17de555051fd4062006af5b54c755">&#9670;&nbsp;</a></span>~eventSubscriber()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classpFlow_1_1eventSubscriber.html">eventSubscriber</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="eventSubscriber_8cpp_source.html#l00025">25</a> of file <a class="el" href="eventSubscriber_8cpp_source.html">eventSubscriber.cpp</a>.</p>
<p class="reference">References <a class="el" href="eventSubscriber_8hpp_source.html#l00039">eventSubscriber::observerList_</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7d53ce19a500ec6de33f564e36f658df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d53ce19a500ec6de33f564e36f658df">&#9670;&nbsp;</a></span>subscribe()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool subscribe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classpFlow_1_1eventObserver.html">eventObserver</a> *&#160;</td>
<td class="paramname"><em>observer</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="eventSubscriber_8cpp_source.html#l00034">34</a> of file <a class="el" href="eventSubscriber_8cpp_source.html">eventSubscriber.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="eventObserver_8cpp_source.html#l00050">eventObserver::subscribe()</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1eventSubscriber_a7d53ce19a500ec6de33f564e36f658df_icgraph.png" border="0" usemap="#classpFlow_1_1eventSubscriber_a7d53ce19a500ec6de33f564e36f658df_icgraph" alt=""/></div>
<map name="classpFlow_1_1eventSubscriber_a7d53ce19a500ec6de33f564e36f658df_icgraph" id="classpFlow_1_1eventSubscriber_a7d53ce19a500ec6de33f564e36f658df_icgraph">
<area shape="rect" title=" " alt="" coords="217,13,301,39"/>
<area shape="rect" href="classpFlow_1_1eventObserver.html#a7d5ac42c30174e7700a36b3d05de5747" title=" " alt="" coords="5,5,169,47"/>
</map>
</div>
</div>
</div>
<a id="a8ab6c2b69854876b1f5777553cf190ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ab6c2b69854876b1f5777553cf190ed">&#9670;&nbsp;</a></span>unsubscribe()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool unsubscribe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classpFlow_1_1eventObserver.html">eventObserver</a> *&#160;</td>
<td class="paramname"><em>observer</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="eventSubscriber_8cpp_source.html#l00050">50</a> of file <a class="el" href="eventSubscriber_8cpp_source.html">eventSubscriber.cpp</a>.</p>
</div>
</div>
<a id="a8be673bd14011c024b47ba6a391e75fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8be673bd14011c024b47ba6a391e75fc">&#9670;&nbsp;</a></span>notify() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool notify </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpFlow_1_1eventMessage.html">eventMessage</a> &amp;&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="eventSubscriber_8cpp_source.html#l00062">62</a> of file <a class="el" href="eventSubscriber_8cpp_source.html">eventSubscriber.cpp</a>.</p>
<p class="reference">References <a class="el" href="classpFlow_1_1eventObserver.html#a64730bf40b61714954f7d250702052df">eventObserver::update()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1eventSubscriber_a8be673bd14011c024b47ba6a391e75fc_cgraph.png" border="0" usemap="#classpFlow_1_1eventSubscriber_a8be673bd14011c024b47ba6a391e75fc_cgraph" alt=""/></div>
<map name="classpFlow_1_1eventSubscriber_a8be673bd14011c024b47ba6a391e75fc_cgraph" id="classpFlow_1_1eventSubscriber_a8be673bd14011c024b47ba6a391e75fc_cgraph">
<area shape="rect" title=" " alt="" coords="5,13,64,39"/>
<area shape="rect" href="classpFlow_1_1eventObserver.html#a64730bf40b61714954f7d250702052df" title=" " alt="" coords="112,5,276,47"/>
</map>
</div>
</div>
</div>
<a id="a064ad67bb3dfc6fff5f239149913f61d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a064ad67bb3dfc6fff5f239149913f61d">&#9670;&nbsp;</a></span>notify() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool notify </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpFlow_1_1eventMessage.html">eventMessage</a> &amp;&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classpFlow_1_1List.html">List</a>&lt; <a class="el" href="classpFlow_1_1eventObserver.html">eventObserver</a> * &gt; &amp;&#160;</td>
<td class="paramname"><em>exclutionList</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="eventSubscriber_8cpp_source.html#l00076">76</a> of file <a class="el" href="eventSubscriber_8cpp_source.html">eventSubscriber.cpp</a>.</p>
<p class="reference">References <a class="el" href="classpFlow_1_1eventObserver.html#a64730bf40b61714954f7d250702052df">eventObserver::update()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1eventSubscriber_a064ad67bb3dfc6fff5f239149913f61d_cgraph.png" border="0" usemap="#classpFlow_1_1eventSubscriber_a064ad67bb3dfc6fff5f239149913f61d_cgraph" alt=""/></div>
<map name="classpFlow_1_1eventSubscriber_a064ad67bb3dfc6fff5f239149913f61d_cgraph" id="classpFlow_1_1eventSubscriber_a064ad67bb3dfc6fff5f239149913f61d_cgraph">
<area shape="rect" title=" " alt="" coords="5,13,64,39"/>
<area shape="rect" href="classpFlow_1_1eventObserver.html#a64730bf40b61714954f7d250702052df" title=" " alt="" coords="112,5,276,47"/>
</map>
</div>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac73c100aa0cf2bf7ffc79a739d5f3ab7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac73c100aa0cf2bf7ffc79a739d5f3ab7">&#9670;&nbsp;</a></span>observerList_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1List.html">List</a>&lt;<a class="el" href="classpFlow_1_1eventObserver.html">eventObserver</a>*&gt; observerList_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="eventSubscriber_8hpp_source.html#l00039">39</a> of file <a class="el" href="eventSubscriber_8hpp_source.html">eventSubscriber.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="eventSubscriber_8cpp_source.html#l00025">eventSubscriber::~eventSubscriber()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/phasicFlow/eventSubscriber/<a class="el" href="eventSubscriber_8hpp_source.html">eventSubscriber.hpp</a></li>
<li>src/phasicFlow/eventSubscriber/<a class="el" href="eventSubscriber_8cpp_source.html">eventSubscriber.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacepFlow.html">pFlow</a></li><li class="navelem"><a class="el" href="classpFlow_1_1eventSubscriber.html">eventSubscriber</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>
Reference in New Issue View Git Blame Copy Permalink