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
|
<!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: RelinkableHandle 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.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_relinkable_handle.html">RelinkableHandle</a></div>
<h1>RelinkableHandle Class Template Reference</h1><!-- doxytag: class="QuantLib::RelinkableHandle" --><!-- doxytag: inherits="QuantLib::Handle" --><code>#include <ql/handle.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for RelinkableHandle:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_relinkable_handle__inherit__graph.png" border="0" usemap="#_relinkable_handle__inherit__map" alt="Inheritance graph"></center>
<map name="_relinkable_handle__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_handle.html" title="Shared handle to an observable." alt="" coords="20,7,121,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_relinkable_handle-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br>
class QuantLib::RelinkableHandle< T ></h3>
Relinkable handle to an observable.
<p>
An instance of this class can be relinked so that it points to another observable. The change will be propagated to all handles that were created as copies of such instance.<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" title="Object that notifies its changes to a set of observables.">Observable</a> </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="_fitted_bond_curve_8cpp-example.html#_a4">FittedBondCurve.cpp</a>, <a class="el" href="_f_r_a_8cpp-example.html#_a1">FRA.cpp</a>, <a class="el" href="_repo_8cpp-example.html#_a13">Repo.cpp</a>, and <a class="el" href="swapvaluation_8cpp-example.html#_a24">swapvaluation.cpp</a>.</dl><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_relinkable_handle.html#2b14154fd8703a57398319e33fe58110">RelinkableHandle</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_relinkable_handle.html#7eec88ccb240dcc59ac81e7347c335bd">linkTo</a> (const boost::shared_ptr< T > &, bool registerAsObserver=true)</td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="2b14154fd8703a57398319e33fe58110"></a><!-- doxytag: member="QuantLib::RelinkableHandle::RelinkableHandle" ref="2b14154fd8703a57398319e33fe58110" 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_relinkable_handle.html">RelinkableHandle</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#_caveats000010">Warning:</a></b></dt><dd>see the <a class="el" href="class_quant_lib_1_1_handle.html" title="Shared handle to an observable.">Handle</a> documentation 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::RelinkableHandle::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"> <em>h</em>, </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#_caveats000011">Warning:</a></b></dt><dd>see the <a class="el" href="class_quant_lib_1_1_handle.html" title="Shared handle to an observable.">Handle</a> documentation for issues relatives to <code>registerAsObserver</code>. </dd></dl>
</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>
|