File: class_quant_lib_1_1_index_manager.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 (129 lines) | stat: -rw-r--r-- 8,858 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
<!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: IndexManager 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_index_manager.html">IndexManager</a></div>
<h1>IndexManager Class Reference</h1><!-- doxytag: class="QuantLib::IndexManager" --><!-- doxytag: inherits="QuantLib::Singleton" --><code>#include &lt;ql/indexes/indexmanager.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for IndexManager:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_index_manager__inherit__graph.png" border="0" usemap="#_index_manager__inherit__map" alt="Inheritance graph"></center>
<map name="_index_manager__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_singleton.html" title="Basic support for the singleton pattern." alt="" coords="5,7,275,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_index_manager-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
global repository for past index fixings 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>index names are case insensitive </dd></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"><a class="anchor" name="5bc396af9eb1d49d50c4b0bd6e03c03b"></a><!-- doxytag: member="QuantLib::IndexManager::hasHistory" ref="5bc396af9eb1d49d50c4b0bd6e03c03b" args="(const std::string &amp;name) const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#5bc396af9eb1d49d50c4b0bd6e03c03b">hasHistory</a> (const std::string &amp;name) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns whether historical fixings were stored for the index <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aebb8c5c9e8fd14aa534659ab9defff3"></a><!-- doxytag: member="QuantLib::IndexManager::getHistory" ref="aebb8c5c9e8fd14aa534659ab9defff3" args="(const std::string &amp;name) const " -->
const <a class="el" href="class_quant_lib_1_1_time_series.html">TimeSeries</a>&lt; <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#aebb8c5c9e8fd14aa534659ab9defff3">getHistory</a> (const std::string &amp;name) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the (possibly empty) history of the index fixings <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ec05a3736796561dedbc52be053940b"></a><!-- doxytag: member="QuantLib::IndexManager::setHistory" ref="9ec05a3736796561dedbc52be053940b" args="(const std::string &amp;name, const TimeSeries&lt; Real &gt; &amp;)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#9ec05a3736796561dedbc52be053940b">setHistory</a> (const std::string &amp;name, const <a class="el" href="class_quant_lib_1_1_time_series.html">TimeSeries</a>&lt; <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stores the historical fixings of the index <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="996c0c436b3d99f1ccf6449bd588f608"></a><!-- doxytag: member="QuantLib::IndexManager::notifier" ref="996c0c436b3d99f1ccf6449bd588f608" args="(const std::string &amp;name) const " -->
boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#996c0c436b3d99f1ccf6449bd588f608">notifier</a> (const std::string &amp;name) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">observer notifying of changes in the index fixings <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="43ed480ac14a9943843719bdf928c64d"></a><!-- doxytag: member="QuantLib::IndexManager::histories" ref="43ed480ac14a9943843719bdf928c64d" args="() const " -->
std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#43ed480ac14a9943843719bdf928c64d">histories</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns all names of the indexes for which fixings were stored <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="efc1fd999512aefe154064e77d3c5a18"></a><!-- doxytag: member="QuantLib::IndexManager::clearHistory" ref="efc1fd999512aefe154064e77d3c5a18" args="(const std::string &amp;name)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#efc1fd999512aefe154064e77d3c5a18">clearHistory</a> (const std::string &amp;name)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">clears the historical fixings of the index <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="86d5defd0569fa7fe6c33f358a50a7e8"></a><!-- doxytag: member="QuantLib::IndexManager::clearHistories" ref="86d5defd0569fa7fe6c33f358a50a7e8" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#86d5defd0569fa7fe6c33f358a50a7e8">clearHistories</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">clears all stored fixings <br></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="b10666efc7e0e3ce490caf4ee6718752"></a><!-- doxytag: member="QuantLib::IndexManager::Singleton&lt; IndexManager &gt;" ref="b10666efc7e0e3ce490caf4ee6718752" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>Singleton&lt; IndexManager &gt;</b></td></tr>

</table>

</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>