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
|
<!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>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="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_event.html">Event</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Event Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::Event" --><!-- doxytag: inherits="QuantLib::Observable" -->
<p>Base class for event.
<a href="class_quant_lib_1_1_event.html#details">More...</a></p>
<p><code>#include <ql/event.hpp></code></p>
<div class="dynheader">
Inheritance diagram for Event:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_event__inherit__graph.png" border="0" usemap="#_event_inherit__map" alt="Inheritance graph"/></div>
<map name="_event_inherit__map" id="_event_inherit__map">
<area shape="rect" id="node5" href="class_quant_lib_1_1_callability.html" title="instrument callability" alt="" coords="5,166,83,197"/><area shape="rect" id="node7" href="class_quant_lib_1_1_cash_flow.html" title="Base class for cash flows." alt="" coords="107,166,184,197"/><area shape="rect" id="node9" href="class_quant_lib_1_1_default_event.html" title="Credit event on a bond of a certain seniority(ies)/currency." alt="" coords="208,166,304,197"/><area shape="rect" id="node2" href="class_quant_lib_1_1_observable.html" title="Object that notifies its changes to a set of observers." alt="" coords="101,6,189,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_quant_lib_1_1_event-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 colspan="2"><div class="groupHeader">Event interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac659412fae5cc99a0fdf25f7f4b9562e"></a><!-- doxytag: member="QuantLib::Event::date" ref="ac659412fae5cc99a0fdf25f7f4b9562e" args="() const =0" -->
virtual <a class="el" href="class_quant_lib_1_1_date.html">Date</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_event.html#ac659412fae5cc99a0fdf25f7f4b9562e">date</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the date at which the event occurs <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_event.html#aca737dd96c9485ce9613e5fb187c46eb">hasOccurred</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &refDate=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>(), boost::optional< bool > includeRefDate=boost::none) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if an event has already occurred before a date <a href="#aca737dd96c9485ce9613e5fb187c46eb"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Visitability</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a896099363a2a409d2485c3ce9e4e4265"></a><!-- doxytag: member="QuantLib::Event::accept" ref="a896099363a2a409d2485c3ce9e4e4265" args="(AcyclicVisitor &)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>accept</b> (<a class="el" href="class_quant_lib_1_1_acyclic_visitor.html">AcyclicVisitor</a> &)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for event. </p>
<p>This class acts as a base class for the actual event implementations. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aca737dd96c9485ce9613e5fb187c46eb"></a><!-- doxytag: member="QuantLib::Event::hasOccurred" ref="aca737dd96c9485ce9613e5fb187c46eb" args="(const Date &refDate=Date(), boost::optional< bool > includeRefDate=boost::none) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="class_quant_lib_1_1_event.html#aca737dd96c9485ce9613e5fb187c46eb">hasOccurred</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td>
<td class="paramname"><em>refDate</em> = <code><a class="el" href="class_quant_lib_1_1_date.html">Date</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::optional< bool > </td>
<td class="paramname"><em>includeRefDate</em> = <code>boost::none</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns true if an event has already occurred before a date </p>
<p>If includeRefDate is true, then an event has not occurred if its date is the same as the refDate, i.e. this method returns false if the event date is the same as the refDate. </p>
<p>Reimplemented in <a class="el" href="class_quant_lib_1_1_cash_flow.html#a124a26b60637ae9384e543ed3f483064">CashFlow</a>.</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>
|
