File: class_quant_lib_1_1_observable.html

package info (click to toggle)
quantlib-refman-html 0.9.0-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 60,592 kB
  • ctags: 7,595
  • sloc: makefile: 30
file content (151 lines) | stat: -rw-r--r-- 9,634 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>QuantLib: 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="212" height="47" 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 0.9.0</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="overview.html">Project overview</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="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.5.4 -->
<div class="nav">
<a class="el" href="namespace_quant_lib.html">QuantLib</a>::<a class="el" href="class_quant_lib_1_1_observable.html">Observable</a></div>
<h1>Observable Class Reference<br>
<small>
[<a class="el" href="group__patterns.html">Design patterns</a>]</small>
</h1><!-- doxytag: class="QuantLib::Observable" --><code>#include &lt;ql/patterns/observable.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for Observable:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_observable__inherit__graph.png" border="0" usemap="#_observable__inherit__map" alt="Inheritance graph"></center>
<map name="_observable__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_affine_model.html" title="Affine model class." alt="" coords="299,5,397,32"><area shape="rect" href="class_quant_lib_1_1_bootstrap_helper.html" title="Base helper class for bootstrapping." alt="" coords="284,56,412,83"><area shape="rect" href="class_quant_lib_1_1_bootstrap_helper.html" title="BootstrapHelper\&lt; QuantLib::YieldTermStructure \&gt;" alt="" coords="175,107,521,133"><area shape="rect" href="class_quant_lib_1_1_bootstrap_helper.html" title="BootstrapHelper\&lt; QuantLib::YoYInflationTermStructure \&gt;" alt="" coords="152,157,544,184"><area shape="rect" href="class_quant_lib_1_1_bootstrap_helper.html" title="BootstrapHelper\&lt; QuantLib::ZeroInflationTermStructure \&gt;" alt="" coords="149,208,547,235"><area shape="rect" href="class_quant_lib_1_1_calibrated_model.html" title="Calibrated model class." alt="" coords="285,259,411,285"><area shape="rect" href="class_quant_lib_1_1_calibration_helper.html" title="liquid market instrument used during calibration" alt="" coords="281,309,415,336"><area shape="rect" href="class_quant_lib_1_1_event.html" title="Base class for event." alt="" coords="319,360,377,387"><area shape="rect" href="class_quant_lib_1_1_floating_rate_coupon_pricer.html" title="generic pricer for floating&#45;rate coupons" alt="" coords="253,411,443,437"><area shape="rect" href="class_quant_lib_1_1_index.html" title="purely virtual base class for indexes" alt="" coords="320,461,376,488"><area shape="rect" href="class_quant_lib_1_1_lazy_object.html" title="Framework for calculation on demand and result caching." alt="" coords="301,512,395,539"><area shape="rect" href="class_quant_lib_1_1_market_model_factory.html" title="base class for market&#45;model factories" alt="" coords="272,563,424,589"><area shape="rect" href="class_quant_lib_1_1_pricing_engine.html" title="interface for pricing engines" alt="" coords="295,613,401,640"><area shape="rect" href="class_quant_lib_1_1_quote.html" title="purely virtual base class for market observables" alt="" coords="317,664,379,691"><area shape="rect" href="class_quant_lib_1_1_smile_section.html" title="interest rate volatility smile section" alt="" coords="296,715,400,741"><area shape="rect" href="class_quant_lib_1_1_stochastic_process.html" title="multi&#45;dimensional stochastic process class." alt="" coords="279,765,417,792"><area shape="rect" href="class_quant_lib_1_1_term_structure.html" title="Basic term&#45;structure functionality." alt="" coords="292,816,404,843"><area shape="rect" href="class_quant_lib_1_1_term_structure_consistent_model.html" title="Term&#45;structure consistent model class." alt="" coords="237,867,459,893"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_observable-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Object that notifies its changes to a set of observables. 
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="840dd96e33a304cbf681d357de7f48d0"></a><!-- doxytag: member="QuantLib::Observable::Observable" ref="840dd96e33a304cbf681d357de7f48d0" args="(const Observable &amp;)" -->
&nbsp;</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" nowrap align="right" valign="top"><a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_observable.html#522aacdd0f2408fe5e46527a6db999b4">operator=</a> (const <a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> &amp;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_observable.html#397546715bfc5aedd1d16dd202a19d4c">notifyObservers</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1bc1613ca5d6d0e8b2fbce5ef15dd38f"></a><!-- doxytag: member="QuantLib::Observable::Observer" ref="1bc1613ca5d6d0e8b2fbce5ef15dd38f" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>Observer</b></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="522aacdd0f2408fe5e46527a6db999b4"></a><!-- doxytag: member="QuantLib::Observable::operator=" ref="522aacdd0f2408fe5e46527a6db999b4" 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;&nbsp;</td>
          <td class="paramname"> <em>o</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000071">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><p>
<a class="anchor" name="397546715bfc5aedd1d16dd202a19d4c"></a><!-- doxytag: member="QuantLib::Observable::notifyObservers" ref="397546715bfc5aedd1d16dd202a19d4c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void notifyObservers           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></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. 
</div>
</div><p>

</div>

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

</div>

</body>
</html>