File: class_quant_lib_1_1_event.html

package info (click to toggle)
quantlib-refman-html 0.3.14-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 43,500 kB
  • ctags: 8,975
  • sloc: makefile: 31
file content (176 lines) | stat: -rw-r--r-- 8,972 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
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<meta name="robots" content="none">
<title>QuantLib: Event 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.3.14</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="faq.html">Frequently asked questions</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="deprecated.html">Deprecated Features</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.1 -->
<div class="nav">
<b>QuantLib</b>::<a class="el" href="class_quant_lib_1_1_event.html">Event</a></div>
<h1>Event Class Reference</h1><!-- doxytag: class="QuantLib::Event" --><!-- doxytag: inherits="QuantLib::Observable" --><code>#include &lt;ql/event.hpp&gt;</code>
<p>
Inheritance diagram for Event:<p><center><img src="class_quant_lib_1_1_event__inherit__graph.png" border="0" usemap="#_event__inherit__map" alt="Inheritance graph"></center>
<map name="_event__inherit__map">
<area href="class_quant_lib_1_1_callability.html" shape="rect" coords="185,156,273,180" alt="">
<area href="class_quant_lib_1_1_cash_flow.html" shape="rect" coords="327,156,412,180" alt="">
<area href="class_quant_lib_1_1_observable.html" shape="rect" coords="239,7,337,31" alt="">
<area href="class_quant_lib_1_1_soft_callability.html" shape="rect" coords="143,231,257,255" alt="">
<area href="class_quant_lib_1_1_coupon.html" shape="rect" coords="281,231,356,255" alt="">
<area href="class_quant_lib_1_1_dividend.html" shape="rect" coords="409,231,492,255" alt="">
<area href="class_quant_lib_1_1_simple_cash_flow.html" shape="rect" coords="516,231,647,255" alt="">
<area href="class_quant_lib_1_1_fixed_rate_coupon.html" shape="rect" coords="63,305,201,329" alt="">
<area href="class_quant_lib_1_1_floating_rate_coupon.html" shape="rect" coords="225,305,383,329" alt="">
<area href="class_quant_lib_1_1_c_m_s_coupon.html" shape="rect" coords="5,380,109,404" alt="">
<area href="class_quant_lib_1_1_in_arrear_indexed_coupon.html" shape="rect" coords="133,380,315,404" alt="">
<area href="class_quant_lib_1_1_par_coupon.html" shape="rect" coords="339,380,432,404" alt="">
<area href="class_quant_lib_1_1_up_front_indexed_coupon.html" shape="rect" coords="456,380,635,404" alt="">
<area href="class_quant_lib_1_1_short_3_01_par_coupon_01_4.html" shape="rect" coords="304,455,467,479" alt="">
<area href="class_quant_lib_1_1_fixed_dividend.html" shape="rect" coords="407,305,524,329" alt="">
<area href="class_quant_lib_1_1_fractional_dividend.html" shape="rect" coords="548,305,695,329" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_event-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for event. 
<p>
This class acts as a base class for the actual event implementations. 
<p>
<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 colspan="2"><div class="groupHeader">Event interface</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13bda6290db5f0ae13c13f69c1ae4c0"></a><!-- doxytag: member="QuantLib::Event::date" ref="a13bda6290db5f0ae13c13f69c1ae4c0" args="() const=0" -->
virtual <a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_event.html#a13bda6290db5f0ae13c13f69c1ae4c0">date</a> () const=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the date at which the event occurs <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_event.html#5d95069505c22ba0bdf59e099481cdac">hasOccurred</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;d, bool includeToday=false) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns true if an event has already occurred before a date  <a href="#5d95069505c22ba0bdf59e099481cdac"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Visitability</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1d7eaf2f5dccce1c7781b54d64ba4a07"></a><!-- doxytag: member="QuantLib::Event::accept" ref="1d7eaf2f5dccce1c7781b54d64ba4a07" args="(AcyclicVisitor &amp;)" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>accept</b> (<a class="el" href="class_quant_lib_1_1_acyclic_visitor.html">AcyclicVisitor</a> &amp;)</td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5d95069505c22ba0bdf59e099481cdac"></a><!-- doxytag: member="QuantLib::Event::hasOccurred" ref="5d95069505c22ba0bdf59e099481cdac" args="(const Date &amp;d, bool includeToday=false) const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool hasOccurred           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>d</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>includeToday</em> = <code>false</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
returns true if an event has already occurred before a date 
<p>
If QL_TODAYS_PAYMENT is true, then a payment event has not occurred if the input date is the same as the event date, and so includeToday should be defaulted to true.<p>
This should be the only place in the code that is affected directly by QL_TODAYS_PAYMENT<p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000005">Todo:</a></b></dt><dd>make QL_TODAYS_PAYMENT dynamically configurable? </dd></dl>

</div>
</div><p>

</div>

<div class="footer">

<table align="top" width="100%">
<tr>
<td align="middle" width="33%">
<strong>QuantLib.org</strong><br>
<a href="http://quantlib.org/">
<img src="QL-small.jpg" alt="QuantLib" align="middle" border=0>
</a>
</td>
<td align="middle" width="33%">
<strong>Hosted by</strong><br>
<a href="http://sourceforge.net"><img src=
"sfnetlogo.png" width="88" height="31"
border="0" alt="SourceForge.net Logo"></a>
</td>
<td align="middle" width="33%">
<strong>Documentation generated by</strong><br>
<a href="http://www.doxygen.org">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53>
</a></td>
</tr>
</table>
</div>

</div>

</body>
</html>