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
|
<!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>Handle< T > 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="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_handle.html">Handle</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">Handle< T > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::Handle" -->
<p>Shared handle to an observable.
<a href="class_quant_lib_1_1_handle.html#details">More...</a></p>
<p><code>#include <ql/handle.hpp></code></p>
<div class="dynheader">
Inheritance diagram for Handle< T >:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_handle__inherit__graph.png" border="0" usemap="#_handle_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_handle_3_01_t_01_4_inherit__map" id="_handle_3_01_t_01_4_inherit__map">
<area shape="rect" id="node3" href="class_quant_lib_1_1_relinkable_handle.html" title="Relinkable handle to an observable." alt="" coords="5,86,160,117"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_quant_lib_1_1_handle-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="ab4a6670fe9c581ee1415114296e6688f"></a><!-- doxytag: member="QuantLib::Handle::currentLink" ref="ab4a6670fe9c581ee1415114296e6688f" args="() const " -->
const boost::shared_ptr< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_handle.html#ab4a6670fe9c581ee1415114296e6688f">currentLink</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">dereferencing <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7f131d2a22209986c1097a8495d20ba"></a><!-- doxytag: member="QuantLib::Handle::operator->" ref="aa7f131d2a22209986c1097a8495d20ba" args="() const " -->
const boost::shared_ptr< T > & </td><td class="memItemRight" valign="bottom"><b>operator-></b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf958a1f0614967f9ad7ee7aa1f98dc6"></a><!-- doxytag: member="QuantLib::Handle::operator*" ref="abf958a1f0614967f9ad7ee7aa1f98dc6" args="() const " -->
const boost::shared_ptr< T > & </td><td class="memItemRight" valign="bottom"><b>operator*</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6e61de369e994009e36f344f99c15ad"></a><!-- doxytag: member="QuantLib::Handle::empty" ref="ac6e61de369e994009e36f344f99c15ad" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_handle.html#ac6e61de369e994009e36f344f99c15ad">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" align="right" valign="top"><a class="anchor" id="ac0b3ed61a44036fb7b305892a1546385"></a><!-- doxytag: member="QuantLib::Handle::operator boost::shared_ptr< Observable >" ref="ac0b3ed61a44036fb7b305892a1546385" args="() const " -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_handle.html#ac0b3ed61a44036fb7b305892a1546385">operator boost::shared_ptr< Observable ></a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">allows registration as observable <br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="addb704db2fc67cd1a460ffcefc4edfc3"></a><!-- doxytag: member="QuantLib::Handle::operator==" ref="addb704db2fc67cd1a460ffcefc4edfc3" args="(const Handle< U > &other)" -->
template<class U > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_handle.html#addb704db2fc67cd1a460ffcefc4edfc3">operator==</a> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< U > &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">equality test <br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="afd8dd188c1e3841781aed424af314ce8"></a><!-- doxytag: member="QuantLib::Handle::operator!=" ref="afd8dd188c1e3841781aed424af314ce8" args="(const Handle< U > &other)" -->
template<class U > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_handle.html#afd8dd188c1e3841781aed424af314ce8">operator!=</a> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< U > &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">disequality test <br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="aa5d79ded650949461ffd1e66aa3a72ae"></a><!-- doxytag: member="QuantLib::Handle::operator<" ref="aa5d79ded650949461ffd1e66aa3a72ae" args="(const Handle< U > &other)" -->
template<class U > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_handle.html#aa5d79ded650949461ffd1e66aa3a72ae">operator<</a> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< U > &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">strict weak ordering <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<tr><td colspan="2"><div class="groupText"><dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000029">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 does not own the pointee (this 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></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8fe4fc521257777e2c467d5145c467ab"></a><!-- doxytag: member="QuantLib::Handle::Handle" ref="a8fe4fc521257777e2c467d5145c467ab" args="(const boost::shared_ptr< T > &p=boost::shared_ptr< T >(), bool registerAsObserver=true)" -->
 </td><td class="memItemRight" valign="bottom"><b>Handle</b> (const boost::shared_ptr< T > &p=boost::shared_ptr< T >(), bool registerAsObserver=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7382e5e4476438ef39a23de9e22542a1"></a><!-- doxytag: member="QuantLib::Handle::Handle" ref="a7382e5e4476438ef39a23de9e22542a1" args="(T *p, bool registerAsObserver=true)" -->
 </td><td class="memItemRight" valign="bottom"><b>Handle</b> (T *p, bool registerAsObserver=true)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a082f4b0854913f436256f61ddb0c3769"></a><!-- doxytag: member="QuantLib::Handle::link_" ref="a082f4b0854913f436256f61ddb0c3769" args="" -->
boost::shared_ptr< Link > </td><td class="memItemRight" valign="bottom"><b>link_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class T><br/>
class QuantLib::Handle< T ></h3>
<p>Shared handle to an observable. </p>
<p>All copies of an instance of this class refer to the same observable by means of a relinkable smart pointer. When such pointer is relinked to another observable, the change will be propagated to all the copies.</p>
<dl class="pre"><dt><b>Precondition:</b></dt><dd>Class T must inherit from <a class="el" href="class_quant_lib_1_1_observable.html" title="Object that notifies its changes to a set of observers.">Observable</a> </dd></dl>
</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>
|
