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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<meta name="robots" content="none">
<title>QuantLib: Link Class Template 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.3.14</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="faq.html">Frequently asked questions</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="deprecated.html">Deprecated Features</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.1 -->
<div class="nav">
<b>QuantLib</b>::<a class="el" href="class_quant_lib_1_1_link.html">Link</a></div>
<h1>Link Class Template Reference</h1><!-- doxytag: class="QuantLib::Link" --><!-- doxytag: inherits="QuantLib::Observable,QuantLib::Observer" --><code>#include <ql/handle.hpp></code>
<p>
Inheritance diagram for Link:<p><center><img src="class_quant_lib_1_1_link__inherit__graph.png" border="0" usemap="#_link__inherit__map" alt="Inheritance graph"></center>
<map name="_link__inherit__map">
<area href="class_quant_lib_1_1_observable.html" shape="rect" coords="5,7,104,31" alt="">
<area href="class_quant_lib_1_1_observer.html" shape="rect" coords="128,7,211,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_link-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br>
class QuantLib::Link< T ></h3>
Relinkable access to a shared pointer.
<p>
<dl class="pre" compact><dt><b>Precondition:</b></dt><dd>Class T must inherit from <a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> </dd></dl>
<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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_link.html#d47982e6097b75c362630ca58beb0219">Link</a> (const boost::shared_ptr< T > &h=boost::shared_ptr< T >(), bool registerAsObserver=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_link.html#7eec88ccb240dcc59ac81e7347c335bd">linkTo</a> (const boost::shared_ptr< T > &, bool registerAsObserver=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="644718bb2fb240de962dc3c9a1fdf0dc"></a><!-- doxytag: member="QuantLib::Link::empty" ref="644718bb2fb240de962dc3c9a1fdf0dc" args="() const" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_link.html#644718bb2fb240de962dc3c9a1fdf0dc">empty</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if the contained shared pointer points to anything. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="936a352f4eec1802f44e402db30b3146"></a><!-- doxytag: member="QuantLib::Link::currentLink" ref="936a352f4eec1802f44e402db30b3146" args="() const" -->
const boost::shared_ptr< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_link.html#936a352f4eec1802f44e402db30b3146">currentLink</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the contained shared pointer. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="81207037099141381525b68207b2f621"></a><!-- doxytag: member="QuantLib::Link::swap" ref="81207037099141381525b68207b2f621" args="(Link< T > &other)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_link.html#81207037099141381525b68207b2f621">swap</a> (<a class="el" href="class_quant_lib_1_1_link.html">Link</a>< T > &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Swaps two links. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::Link::update" ref="c5c54df7ed3b930268c8d7752c101725" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_link.html#c5c54df7ed3b930268c8d7752c101725">update</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_quant_lib_1_1_observer.html">Observer</a> interface. <br></td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e67b41fb6ff821bcfe4c08963ea2faa"></a><!-- doxytag: member="QuantLib::Link::swap" ref="3e67b41fb6ff821bcfe4c08963ea2faa" args="(Link< T > &, Link< T > &)" -->
void </td><td class="memItemRight" valign="bottom"><b>swap</b> (<a class="el" href="class_quant_lib_1_1_link.html">Link</a>< T > &, <a class="el" href="class_quant_lib_1_1_link.html">Link</a>< T > &)</td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="d47982e6097b75c362630ca58beb0219"></a><!-- doxytag: member="QuantLib::Link::Link" ref="d47982e6097b75c362630ca58beb0219" args="(const boost::shared_ptr< T > &h=boost::shared_ptr< T >(), bool registerAsObserver=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_link.html">Link</a> </td>
<td>(</td>
<td class="paramtype">const boost::shared_ptr< T > & </td>
<td class="paramname"> <em>h</em> = <code>boost::shared_ptr< T >()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>registerAsObserver</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000026">Warning:</a></b></dt><dd>see the documentation of the <a class="el" href="class_quant_lib_1_1_link.html#7eec88ccb240dcc59ac81e7347c335bd">linkTo()</a> method for issues relatives to <code>registerAsObserver</code>. </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7eec88ccb240dcc59ac81e7347c335bd"></a><!-- doxytag: member="QuantLib::Link::linkTo" ref="7eec88ccb240dcc59ac81e7347c335bd" args="(const boost::shared_ptr< T > &, bool registerAsObserver=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linkTo </td>
<td>(</td>
<td class="paramtype">const boost::shared_ptr< T > & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>registerAsObserver</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000027">Warning:</a></b></dt><dd><code>registerAsObserver</code> is left as a backdoor in case the programmer cannot guarantee that the object pointed to will remain alive for the whole lifetime of the handle---namely, it should be set to <code>false</code> when the passed shared pointer was created with <code>owns = false</code> (the latter should only happen in a controlled environment, so that the programmer is aware of it). Failure to do so can very likely result in a program crash. If the programmer does want the handle to register as observer of such a shared pointer, it is his responsibility to ensure that the handle gets destroyed before the pointed object does. </dd></dl>
</div>
</div><p>
</div>
<div class="footer">
<table align="top" width="100%">
<tr>
<td align="middle" width="33%">
<strong>QuantLib.org</strong><br>
<a href="http://quantlib.org/">
<img src="QL-small.jpg" alt="QuantLib" align="middle" border=0>
</a>
</td>
<td align="middle" width="33%">
<strong>Hosted by</strong><br>
<a href="http://sourceforge.net"><img src=
"sfnetlogo.png" width="88" height="31"
border="0" alt="SourceForge.net Logo"></a>
</td>
<td align="middle" width="33%">
<strong>Documentation generated by</strong><br>
<a href="http://www.doxygen.org">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53>
</a></td>
</tr>
</table>
</div>
</div>
</body>
</html>
|
