<!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.3.1"/>
<title>METSlib: mets::subject< observed_subject > Class Template 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="doxygen.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 style="padding-left: 0.5em;">
<div id="projectname">METSlib
 <span id="projectnumber">0.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>mets</b></li><li class="navelem"><a class="el" href="a00035.html">subject</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="a00143.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mets::subject< observed_subject > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>template class for subjects (cfr. Observer Design Pattern).
<a href="a00035.html#details">More...</a></p>
<p><code>#include <observer.hh></code></p>
<div class="dynheader">
Collaboration diagram for mets::subject< observed_subject >:</div>
<div class="dyncontent">
<div class="center"><img src="a00144.png" border="0" usemap="#mets_1_1subject_3_01observed__subject_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="mets_1_1subject_3_01observed__subject_01_4_coll__map" id="mets_1_1subject_3_01observed__subject_01_4_coll__map">
</map>
</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:a580c481db07f883261c0a24f0f201067"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a580c481db07f883261c0a24f0f201067">attach</a> (<a class="el" href="a00027.html">observer</a>< observed_subject > &o)</td></tr>
<tr class="memdesc:a580c481db07f883261c0a24f0f201067"><td class="mdescLeft"> </td><td class="mdescRight">Attach a new observer to this subject. <a href="#a580c481db07f883261c0a24f0f201067">More...</a><br/></td></tr>
<tr class="separator:a580c481db07f883261c0a24f0f201067"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6b5055d74cb5671e46bb57a4109cf3a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#af6b5055d74cb5671e46bb57a4109cf3a">detach</a> (<a class="el" href="a00027.html">observer</a>< observed_subject > &o)</td></tr>
<tr class="memdesc:af6b5055d74cb5671e46bb57a4109cf3a"><td class="mdescLeft"> </td><td class="mdescRight">Detach a new observer to this subject. <a href="#af6b5055d74cb5671e46bb57a4109cf3a">More...</a><br/></td></tr>
<tr class="separator:af6b5055d74cb5671e46bb57a4109cf3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a604a3c6cb19a470779170e29528f3e83"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00035.html#a604a3c6cb19a470779170e29528f3e83">notify</a> ()</td></tr>
<tr class="memdesc:a604a3c6cb19a470779170e29528f3e83"><td class="mdescLeft"> </td><td class="mdescRight">Notify all attached observers. <a href="#a604a3c6cb19a470779170e29528f3e83">More...</a><br/></td></tr>
<tr class="separator:a604a3c6cb19a470779170e29528f3e83"><td class="memSeparator" colspan="2"> </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:a01924f78859ce56ff0448030e81166e0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01924f78859ce56ff0448030e81166e0"></a>
std::set< <a class="el" href="a00027.html">observer</a><br class="typebreak"/>
< observed_subject > * > </td><td class="memItemRight" valign="bottom"><b>observers_m</b></td></tr>
<tr class="separator:a01924f78859ce56ff0448030e81166e0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename observed_subject><br/>
class mets::subject< observed_subject ></h3>
<p>template class for subjects (cfr. Observer Design Pattern). </p>
<p>You must declare the subject of the observations with:</p>
<p>class my_observed_sbj : public subject<my_observed_sbj></p>
<p>Than you should call <a class="el" href="a00035.html#a604a3c6cb19a470779170e29528f3e83" title="Notify all attached observers.">notify()</a> manually or automatically from every method that changes the subject status.</p>
<p>Only attached observers (cfr. <a class="el" href="a00035.html#a580c481db07f883261c0a24f0f201067" title="Attach a new observer to this subject.">attach()</a> and <a class="el" href="a00035.html#af6b5055d74cb5671e46bb57a4109cf3a" title="Detach a new observer to this subject.">detach()</a> methods) will be notified. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a580c481db07f883261c0a24f0f201067"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename observed_subject> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00035.html">mets::subject</a>< observed_subject >::attach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00027.html">observer</a>< observed_subject< observed_subject > > & </td>
<td class="paramname"><em>o</em></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>Attach a new observer to this subject. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">o,:</td><td>a new observer for this subject. if the observer was already present nothing happens. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af6b5055d74cb5671e46bb57a4109cf3a"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename observed_subject> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00035.html">mets::subject</a>< observed_subject >::detach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00027.html">observer</a>< observed_subject< observed_subject > > & </td>
<td class="paramname"><em>o</em></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>Detach a new observer to this subject. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">o,:</td><td>observer to detach from this subject. if the observer "o" was not present nothing happens. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a604a3c6cb19a470779170e29528f3e83"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename observed_subject > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00035.html">mets::subject</a>< observed_subject >::notify </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>Notify all attached observers. </p>
<p>When this method is called every observed_subject::update method is called and "this" subject is passed as a param. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>metslib/observer.hh</li>
</ul>
</div><!-- contents -->
<hr>
<p align="right">
Return to <a href="https://projects.coin-or.org/metslib" target="_top">METS<i>lib</i> home page</a>
</p>
</body>
</html>
