jcarr
/
coriolis
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
coriolis/katabatic/doc/html/classKatabatic_1_1Observer....

156 lines
8.5 KiB
HTML
Raw Normal View History

Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0//EN'>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Katabatic Documentation</title>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="SoC.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<h1 id="pagetop" class="header">Katabatic - Routing Toolbox</h1>
<!--
<center class="header">
<table class="header">
<tr>
<td><a href="customSummary.html">Summary</a></td>
<td><a href="namespaces.html">Namespaces</a></td>
<td><a href="customHierarchy.html">Class Hierarchy</a></td>
<td><a href="annotated.html">Classes</a></td>
<td><a href="functions.html">Member Index</a></td>
</tr>
</table>
</center>
-->
<br>
<body onload="javascript:toggleLevel(1)">
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceKatabatic.html">Katabatic</a></li><li class="navelem"><a class="el" href="classKatabatic_1_1Observer.html">Observer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="classKatabatic_1_1Observer-members.html">List of all members</a> &#124;
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Observer&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classKatabatic_1_1Observer.html" title="Observer Design Pattern, Observer part. ">Observer</a> Design Pattern, <a class="el" href="classKatabatic_1_1Observer.html" title="Observer Design Pattern, Observer part. ">Observer</a> part.
<a href="classKatabatic_1_1Observer.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Observer&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classKatabatic_1_1Observer__inherit__graph.png" border="0" usemap="#Observer_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="Observer_3_01T_01_4_inherit__map" id="Observer_3_01T_01_4_inherit__map">
<area shape="rect" id="node2" href="classKatabatic_1_1BaseObserver.html" title="Observer Design Pattern, Observer part. " alt="" coords="6,5,111,32"/>
</map>
<center><span class="legend">[<a 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:ab05ec12517c51952960dd4f324499b44"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1Observer.html#ab05ec12517c51952960dd4f324499b44">Observer</a> (const T *owner)</td></tr>
<tr class="separator:ab05ec12517c51952960dd4f324499b44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac29b8f99d632058c95784fd7233b8474"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1Observer.html#ac29b8f99d632058c95784fd7233b8474">getOwner</a> () const</td></tr>
<tr class="separator:ac29b8f99d632058c95784fd7233b8474"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classKatabatic_1_1BaseObserver"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classKatabatic_1_1BaseObserver')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classKatabatic_1_1BaseObserver.html">BaseObserver</a></td></tr>
<tr class="memitem:a52e577fb0c4f2e3650928334fb621c2f inherit pub_methods_classKatabatic_1_1BaseObserver"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKatabatic_1_1BaseObserver.html#a52e577fb0c4f2e3650928334fb621c2f">notify</a> (unsigned int flags)</td></tr>
<tr class="separator:a52e577fb0c4f2e3650928334fb621c2f inherit pub_methods_classKatabatic_1_1BaseObserver"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br />
class Katabatic::Observer&lt; T &gt;</h3>
<p><a class="el" href="classKatabatic_1_1Observer.html" title="Observer Design Pattern, Observer part. ">Observer</a> Design Pattern, <a class="el" href="classKatabatic_1_1Observer.html" title="Observer Design Pattern, Observer part. ">Observer</a> part. </p>
<p><b>First, a warning about names:</b> although this class is named <a class="el" href="classKatabatic_1_1Observer.html" title="Observer Design Pattern, Observer part. ">Observer</a>, it is intended to be an attribute nested inside the whole object which is indeed, the true <a class="el" href="classKatabatic_1_1Observer.html" title="Observer Design Pattern, Observer part. ">Observer</a>. This nesting object is called, most of the time the <b>owner</b> in the following. But sometimes, for simplification it may also be called the <a class="el" href="classKatabatic_1_1Observer.html" title="Observer Design Pattern, Observer part. ">Observer</a>.</p>
<h1><a class="anchor" id="secImplObserver"></a>
Observer Implementation Notes</h1>
<p>To retrieve the <em>owner</em> from the <a class="el" href="classKatabatic_1_1Observer.html" title="Observer Design Pattern, Observer part. ">Observer</a> attribute, we uses the offset from the attribute in the <em>owner</em>. This offset is computed once and for all the first time the template constructor is called. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab05ec12517c51952960dd4f324499b44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab05ec12517c51952960dd4f324499b44">&#9670;&nbsp;</a></span>Observer()</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="classKatabatic_1_1Observer.html">Observer</a> </td>
<td>(</td>
<td class="paramtype">const T *&#160;</td>
<td class="paramname"><em>owner</em></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>The owner of the oberver is needed to compute, on the first creation only, the offset of the <a class="el" href="classKatabatic_1_1Observer.html" title="Observer Design Pattern, Observer part. ">Observer</a> attribute inside the <code>owner</code> complete object. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac29b8f99d632058c95784fd7233b8474"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac29b8f99d632058c95784fd7233b8474">&#9670;&nbsp;</a></span>getOwner()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T * getOwner </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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><b>Returns:</b> The owner of the observer. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Observer_8h_source.html">Observer.h</a></li>
<li>Observer.dox</li>
</ul>
</div><!-- contents -->
<br>
<hr>
<table class="footer1">
<tr>
<td class="LFooter"><small>Generated by doxygen 1.8.13 on Mon May 14 2018</small></td>
<td class="RFooter"><a href='#pagetop'><small>Return to top of page</small></a></td>
</tr>
</table>
<table class="footer2">
<tr>
<td class="LFooter">Katabatic - Routing Toolbox</td>
<td class="RFooter"><small>Copyright &#169; 2008-2016 UPMC. All rights reserved</small></td>
</tr>
</table>
</body>
</html>