File: class_quant_lib_1_1_observable.html

package info (click to toggle)
quantlib-refman-html 1.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 84,552 kB
  • ctags: 5,132
  • sloc: makefile: 33
file content (151 lines) | stat: -rw-r--r-- 9,279 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<meta name="robots" content="none">
<title>Observable Class Reference</title>
<link rel="stylesheet" href="quantlib.css" type="text/css">
<link rel="stylesheet" href="print.css" type="text/css" media="print">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<link rel="icon" href="favicon.ico" type="image/x-icon">
</head>
<body>

<div id="container">
<div id="header">
<img class="titleimage"
 src="QL-title.jpg" width="185" height="50" border="0"
 alt="QuantLib">
<br>
<h3 class="subtitle">A free/open-source library for quantitative finance</h3>
</div>
<div id="menu">

<h3 class="navbartitle">Version 1.2</h3>

<hr>

<h3 class="navbartitle">Getting started</h3>
<ul class="navbarlist">
<li class="navlink"><a href="index.html">Introduction</a></li>
<li class="navlink"><a href="where.html">Where to get QuantLib</a></li>
<li class="navlink"><a href="install.html">Installation</a></li>
<li class="navlink"><a href="config.html">Configuration</a></li>
<li class="navlink"><a href="usage.html">Usage</a></li>
<li class="navlink"><a href="history.html">Version history</a></li>
<li class="navlink"><a href="resources.html">Additional resources</a></li>
<li class="navlink"><a href="group.html">The QuantLib group</a></li>
<li class="navlink"><a href="license.html">Copyright and license</a></li>
</ul>

<hr>

<h3 class="navbartitle">Reference manual</h3>
<ul class="navbarlist">
<li class="navlink"><a href="modules.html">Modules</a></li>
<li class="navlink"><a href="hierarchy.html">Class Hierarchy</a></li>
<li class="navlink"><a href="annotated.html">Compound List</a></li>
<li class="navlink"><a href="files.html">File List</a></li>
<li class="navlink"><a href="functions.html">Compound Members</a></li>
<li class="navlink"><a href="globals.html">File Members</a></li>
<li class="navlink"><a href="todo.html">Todo List</a></li>
<li class="navlink"><a href="bug.html">Known Bugs</a></li>
<li class="navlink"><a href="caveats.html">Caveats</a></li>
<li class="navlink"><a href="test.html">Test Suite</a></li>
<li class="navlink"><a href="examples.html">Examples</a></li>
</ul>
</div>

<div id="content">
<!--Doxygen-generated content-->

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>QuantLib</b>      </li>
      <li class="navelem"><a class="el" href="class_quant_lib_1_1_observable.html">Observable</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle">
<div class="title">Observable Class Reference<div class="ingroups"><a class="el" href="group__patterns.html">Design patterns</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::Observable" -->
<p>Object that notifies its changes to a set of observers.  
 <a href="class_quant_lib_1_1_observable.html#details">More...</a></p>

<p><code>#include &lt;ql/patterns/observable.hpp&gt;</code></p>

<p>Inherited by <a class="el" href="class_quant_lib_1_1_bootstrap_helper.html">BootstrapHelper&lt; YoYInflationTermStructure &gt;</a>, <a class="el" href="class_quant_lib_1_1_bootstrap_helper.html">BootstrapHelper&lt; YoYOptionletVolatilitySurface &gt;</a>, <a class="el" href="class_quant_lib_1_1_bootstrap_helper.html">BootstrapHelper&lt; ZeroInflationTermStructure &gt;</a>, <a class="el" href="class_quant_lib_1_1_affine_model.html">AffineModel</a><code> [virtual]</code>, <a class="el" href="class_quant_lib_1_1_bootstrap_helper.html">BootstrapHelper&lt; TS &gt;</a>, <a class="el" href="class_quant_lib_1_1_calibrated_model.html">CalibratedModel</a><code> [virtual]</code>, <a class="el" href="class_quant_lib_1_1_calibration_helper.html">CalibrationHelper</a>, <a class="el" href="class_quant_lib_1_1_claim.html">Claim</a>, <a class="el" href="class_quant_lib_1_1_commodity_index.html">CommodityIndex</a>, <a class="el" href="class_quant_lib_1_1_event.html">Event</a>, FdmQuantoHelper, <a class="el" href="class_quant_lib_1_1_floating_rate_coupon_pricer.html">FloatingRateCouponPricer</a><code> [virtual]</code>, Handle&lt; T &gt;::Link, <a class="el" href="class_quant_lib_1_1_index.html">Index</a>, <a class="el" href="class_quant_lib_1_1_inflation_coupon_pricer.html">InflationCouponPricer</a><code> [virtual]</code>, <a class="el" href="class_quant_lib_1_1_lazy_object.html">LazyObject</a><code> [virtual]</code>, <a class="el" href="class_quant_lib_1_1_market_model_factory.html">MarketModelFactory</a>, <a class="el" href="class_quant_lib_1_1_pricing_engine.html">PricingEngine</a>, <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a><code> [virtual]</code>, <a class="el" href="class_quant_lib_1_1_recovery_rate_model.html">RecoveryRateModel</a><code> [virtual]</code>, RendistatoBasket, <a class="el" href="class_quant_lib_1_1_smile_section.html">SmileSection</a><code> [virtual]</code>, <a class="el" href="class_quant_lib_1_1_stochastic_process.html">StochasticProcess</a>, <a class="el" href="class_quant_lib_1_1_term_structure.html">TermStructure</a><code> [virtual]</code>, and <a class="el" href="class_quant_lib_1_1_term_structure_consistent_model.html">TermStructureConsistentModel</a><code> [virtual]</code>.</p>

<p><a href="class_quant_lib_1_1_observable-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a840dd96e33a304cbf681d357de7f48d0"></a><!-- doxytag: member="QuantLib::Observable::Observable" ref="a840dd96e33a304cbf681d357de7f48d0" args="(const Observable &amp;)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>Observable</b> (const <a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_observable.html#a522aacdd0f2408fe5e46527a6db999b4">operator=</a> (const <a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_observable.html#a397546715bfc5aedd1d16dd202a19d4c">notifyObservers</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1bc1613ca5d6d0e8b2fbce5ef15dd38f"></a><!-- doxytag: member="QuantLib::Observable::Observer" ref="a1bc1613ca5d6d0e8b2fbce5ef15dd38f" args="" -->
class&#160;</td><td class="memItemRight" valign="bottom"><b>Observer</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Object that notifies its changes to a set of observers. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a522aacdd0f2408fe5e46527a6db999b4"></a><!-- doxytag: member="QuantLib::Observable::operator=" ref="a522aacdd0f2408fe5e46527a6db999b4" args="(const Observable &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> &amp; operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> &amp;&#160;</td>
          <td class="paramname"><em>o</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000086">Warning:</a></b></dt><dd>notification is sent before the copy constructor has a chance of actually change the data members. Therefore, observers whose update() method tries to use their observables will not see the updated values. It is suggested that the update() method just raise a flag in order to trigger a later recalculation. </dd></dl>

</div>
</div>
<a class="anchor" id="a397546715bfc5aedd1d16dd202a19d4c"></a><!-- doxytag: member="QuantLib::Observable::notifyObservers" ref="a397546715bfc5aedd1d16dd202a19d4c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_quant_lib_1_1_observable.html#a397546715bfc5aedd1d16dd202a19d4c">notifyObservers</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This method should be called at the end of non-const methods or when the programmer desires to notify any changes. </p>

</div>
</div>
</div><!-- contents -->

</div>

<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.7.6.1
</div>
</div>

</div>

</body>
</html>