File: class_quant_lib_1_1_index_manager.html

package info (click to toggle)
quantlib-refman-html 1.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 84,552 kB
  • ctags: 5,132
  • sloc: makefile: 33
file content (138 lines) | stat: -rw-r--r-- 9,359 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
<!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>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="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_index_manager.html">IndexManager</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle">
<div class="title">IndexManager Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::IndexManager" --><!-- doxytag: inherits="Singleton&lt; IndexManager &gt;" -->
<p>global repository for past index fixings  
 <a href="class_quant_lib_1_1_index_manager.html#details">More...</a></p>

<p><code>#include &lt;ql/indexes/indexmanager.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for IndexManager:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_index_manager__inherit__graph.png" border="0" usemap="#_index_manager_inherit__map" alt="Inheritance graph"/></div>
<map name="_index_manager_inherit__map" id="_index_manager_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_singleton.html" title="Singleton\&lt; IndexManager \&gt;" alt="" coords="5,6,187,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_index_manager-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="a5bc396af9eb1d49d50c4b0bd6e03c03b"></a><!-- doxytag: member="QuantLib::IndexManager::hasHistory" ref="a5bc396af9eb1d49d50c4b0bd6e03c03b" args="(const std::string &amp;name) const " -->
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#a5bc396af9eb1d49d50c4b0bd6e03c03b">hasHistory</a> (const std::string &amp;name) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns whether historical fixings were stored for the index <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaebb8c5c9e8fd14aa534659ab9defff3"></a><!-- doxytag: member="QuantLib::IndexManager::getHistory" ref="aaebb8c5c9e8fd14aa534659ab9defff3" 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#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#aaebb8c5c9e8fd14aa534659ab9defff3">getHistory</a> (const std::string &amp;name) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the (possibly empty) history of the index fixings <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ec05a3736796561dedbc52be053940b"></a><!-- doxytag: member="QuantLib::IndexManager::setHistory" ref="a9ec05a3736796561dedbc52be053940b" args="(const std::string &amp;name, const TimeSeries&lt; Real &gt; &amp;)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#a9ec05a3736796561dedbc52be053940b">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#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &amp;)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">stores the historical fixings of the index <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a996c0c436b3d99f1ccf6449bd588f608"></a><!-- doxytag: member="QuantLib::IndexManager::notifier" ref="a996c0c436b3d99f1ccf6449bd588f608" 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;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#a996c0c436b3d99f1ccf6449bd588f608">notifier</a> (const std::string &amp;name) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">observer notifying of changes in the index fixings <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43ed480ac14a9943843719bdf928c64d"></a><!-- doxytag: member="QuantLib::IndexManager::histories" ref="a43ed480ac14a9943843719bdf928c64d" args="() const " -->
std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#a43ed480ac14a9943843719bdf928c64d">histories</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns all names of the indexes for which fixings were stored <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefc1fd999512aefe154064e77d3c5a18"></a><!-- doxytag: member="QuantLib::IndexManager::clearHistory" ref="aefc1fd999512aefe154064e77d3c5a18" args="(const std::string &amp;name)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#aefc1fd999512aefe154064e77d3c5a18">clearHistory</a> (const std::string &amp;name)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">clears the historical fixings of the index <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86d5defd0569fa7fe6c33f358a50a7e8"></a><!-- doxytag: member="QuantLib::IndexManager::clearHistories" ref="a86d5defd0569fa7fe6c33f358a50a7e8" args="()" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index_manager.html#a86d5defd0569fa7fe6c33f358a50a7e8">clearHistories</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">clears all stored fixings <br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab10666efc7e0e3ce490caf4ee6718752"></a><!-- doxytag: member="QuantLib::IndexManager::Singleton&lt; IndexManager &gt;" ref="ab10666efc7e0e3ce490caf4ee6718752" args="" -->
class&#160;</td><td class="memItemRight" valign="bottom"><b>Singleton&lt; IndexManager &gt;</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>global repository for past index fixings </p>
<dl class="note"><dt><b>Note:</b></dt><dd>index names are case insensitive </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>