File: struct_quant_lib_1_1_e_c_b.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 (204 lines) | stat: -rw-r--r-- 15,962 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
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
<!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>ECB Struct 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="struct_quant_lib_1_1_e_c_b.html">ECB</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">ECB Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::ECB" -->
<p>European Central Bank reserve maintenance dates.  
 <a href="struct_quant_lib_1_1_e_c_b.html#details">More...</a></p>

<p><code>#include &lt;ql/time/ecb.hpp&gt;</code></p>

<p><a href="struct_quant_lib_1_1_e_c_b-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a47fa792d800abb74f278cc8a69de7d45"></a><!-- doxytag: member="QuantLib::ECB::knownDates" ref="a47fa792d800abb74f278cc8a69de7d45" args="()" -->
static const std::set&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>knownDates</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a896b03c3d50a86420e8a4d99183b01f2"></a><!-- doxytag: member="QuantLib::ECB::addDate" ref="a896b03c3d50a86420e8a4d99183b01f2" args="(const Date &amp;d)" -->
static void&#160;</td><td class="memItemRight" valign="bottom"><b>addDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3fb232faf0f34197ee2fa7c8dced0a81"></a><!-- doxytag: member="QuantLib::ECB::removeDate" ref="a3fb232faf0f34197ee2fa7c8dced0a81" args="(const Date &amp;d)" -->
static void&#160;</td><td class="memItemRight" valign="bottom"><b>removeDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ce0f6340602ee9fc2f87db0369bd950"></a><!-- doxytag: member="QuantLib::ECB::date" ref="a9ce0f6340602ee9fc2f87db0369bd950" args="(Month m, Year y)" -->
static <a class="el" href="class_quant_lib_1_1_date.html">Date</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_quant_lib_1_1_e_c_b.html#a9ce0f6340602ee9fc2f87db0369bd950">date</a> (<a class="el" href="group__datetime.html#gae34b763987dcf60c6c619d327b8c9dbb">Month</a> m, <a class="el" href="group__datetime.html#ga84dee895910074cbc7d936c86c1abf3d">Year</a> y)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">maintenance period start date in the given month/year <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_quant_lib_1_1_date.html">Date</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_quant_lib_1_1_e_c_b.html#a723827e2a30022eb84b073335de1eebe">date</a> (const std::string &amp;ecbCode, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;referenceDate=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_quant_lib_1_1_e_c_b.html#a46fa6730251ce58e9881cd0ba426eeba">code</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;ecbDate)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a625191a43ec4dd12278fe5e35475d5a7"></a><!-- doxytag: member="QuantLib::ECB::nextDate" ref="a625191a43ec4dd12278fe5e35475d5a7" args="(const Date &amp;d=Date())" -->
static <a class="el" href="class_quant_lib_1_1_date.html">Date</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_quant_lib_1_1_e_c_b.html#a625191a43ec4dd12278fe5e35475d5a7">nextDate</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;d=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>())</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">next maintenance period start date following the given date <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af23b14f39742593ecceefaf2a34f4a80"></a><!-- doxytag: member="QuantLib::ECB::nextDate" ref="af23b14f39742593ecceefaf2a34f4a80" args="(const std::string &amp;ecbCode, const Date &amp;referenceDate=Date())" -->
static <a class="el" href="class_quant_lib_1_1_date.html">Date</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_quant_lib_1_1_e_c_b.html#af23b14f39742593ecceefaf2a34f4a80">nextDate</a> (const std::string &amp;ecbCode, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;referenceDate=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>())</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">next maintenance period start date following the given <a class="el" href="struct_quant_lib_1_1_e_c_b.html" title="European Central Bank reserve maintenance dates.">ECB</a> code <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66b5865e5bceb55c8a7975fdc8134272"></a><!-- doxytag: member="QuantLib::ECB::nextDates" ref="a66b5865e5bceb55c8a7975fdc8134272" args="(const Date &amp;d=Date())" -->
static std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_quant_lib_1_1_e_c_b.html#a66b5865e5bceb55c8a7975fdc8134272">nextDates</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;d=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>())</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">next maintenance period start dates following the given date <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac87a8fee5c153c124df60e26f8cfe84d"></a><!-- doxytag: member="QuantLib::ECB::nextDates" ref="ac87a8fee5c153c124df60e26f8cfe84d" args="(const std::string &amp;ecbCode, const Date &amp;referenceDate=Date())" -->
static std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_quant_lib_1_1_e_c_b.html#ac87a8fee5c153c124df60e26f8cfe84d">nextDates</a> (const std::string &amp;ecbCode, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;referenceDate=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>())</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">next maintenance period start dates following the given code <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_quant_lib_1_1_e_c_b.html#aca410cfcdf9b3ff3ea113509d168ca69">isECBdate</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9fa5fcc17cb504aa3fb5cb54c58d2479"></a><!-- doxytag: member="QuantLib::ECB::isECBcode" ref="a9fa5fcc17cb504aa3fb5cb54c58d2479" args="(const std::string &amp;in)" -->
static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_quant_lib_1_1_e_c_b.html#a9fa5fcc17cb504aa3fb5cb54c58d2479">isECBcode</a> (const std::string &amp;in)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns whether or not the given string is an <a class="el" href="struct_quant_lib_1_1_e_c_b.html" title="European Central Bank reserve maintenance dates.">ECB</a> code <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46b27b0fd32c51e20c2ad1f824b2e54d"></a><!-- doxytag: member="QuantLib::ECB::nextCode" ref="a46b27b0fd32c51e20c2ad1f824b2e54d" args="(const Date &amp;d=Date())" -->
static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_quant_lib_1_1_e_c_b.html#a46b27b0fd32c51e20c2ad1f824b2e54d">nextCode</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;d=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>())</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">next <a class="el" href="struct_quant_lib_1_1_e_c_b.html" title="European Central Bank reserve maintenance dates.">ECB</a> code following the given date <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ee5fce11ae0c8f7b1b676b1dcc732b6"></a><!-- doxytag: member="QuantLib::ECB::nextCode" ref="a4ee5fce11ae0c8f7b1b676b1dcc732b6" args="(const std::string &amp;ecbCode)" -->
static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_quant_lib_1_1_e_c_b.html#a4ee5fce11ae0c8f7b1b676b1dcc732b6">nextCode</a> (const std::string &amp;ecbCode)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">next <a class="el" href="struct_quant_lib_1_1_e_c_b.html" title="European Central Bank reserve maintenance dates.">ECB</a> code following the given code <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>European Central Bank reserve maintenance dates. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a723827e2a30022eb84b073335de1eebe"></a><!-- doxytag: member="QuantLib::ECB::date" ref="a723827e2a30022eb84b073335de1eebe" args="(const std::string &amp;ecbCode, const Date &amp;referenceDate=Date())" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="class_quant_lib_1_1_date.html">Date</a> <a class="el" href="struct_quant_lib_1_1_e_c_b.html#a9ce0f6340602ee9fc2f87db0369bd950">date</a> </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>ecbCode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&#160;</td>
          <td class="paramname"><em>referenceDate</em> = <code><a class="el" href="class_quant_lib_1_1_date.html">Date</a>()</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>returns the <a class="el" href="struct_quant_lib_1_1_e_c_b.html" title="European Central Bank reserve maintenance dates.">ECB</a> date for the given <a class="el" href="struct_quant_lib_1_1_e_c_b.html" title="European Central Bank reserve maintenance dates.">ECB</a> code (e.g. March xxth, 2013 for MAR10).</p>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000147">Warning:</a></b></dt><dd>It raises an exception if the input string is not an <a class="el" href="struct_quant_lib_1_1_e_c_b.html" title="European Central Bank reserve maintenance dates.">ECB</a> code </dd></dl>

</div>
</div>
<a class="anchor" id="a46fa6730251ce58e9881cd0ba426eeba"></a><!-- doxytag: member="QuantLib::ECB::code" ref="a46fa6730251ce58e9881cd0ba426eeba" args="(const Date &amp;ecbDate)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static std::string <a class="el" href="struct_quant_lib_1_1_e_c_b.html#a46fa6730251ce58e9881cd0ba426eeba">code</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&#160;</td>
          <td class="paramname"><em>ecbDate</em></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>returns the <a class="el" href="struct_quant_lib_1_1_e_c_b.html" title="European Central Bank reserve maintenance dates.">ECB</a> code for the given date (e.g. MAR10 for March xxth, 2010).</p>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000148">Warning:</a></b></dt><dd>It raises an exception if the input date is not an <a class="el" href="struct_quant_lib_1_1_e_c_b.html" title="European Central Bank reserve maintenance dates.">ECB</a> date </dd></dl>

</div>
</div>
<a class="anchor" id="aca410cfcdf9b3ff3ea113509d168ca69"></a><!-- doxytag: member="QuantLib::ECB::isECBdate" ref="aca410cfcdf9b3ff3ea113509d168ca69" args="(const Date &amp;d)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="struct_quant_lib_1_1_e_c_b.html#aca410cfcdf9b3ff3ea113509d168ca69">isECBdate</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&#160;</td>
          <td class="paramname"><em>d</em></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>returns whether or not the given date is a maintenance period start date </p>

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