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
|
<!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: Settings 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_settings.html">Settings</a></div>
<h1>Settings Class Reference</h1><!-- doxytag: class="QuantLib::Settings" --><!-- doxytag: inherits="QuantLib::Singleton" --><code>#include <ql/settings.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for Settings:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_settings__inherit__graph.png" border="0" usemap="#_settings__inherit__map" alt="Inheritance graph"></center>
<map name="_settings__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_singleton.html" title="Basic support for the singleton pattern." alt="" coords="5,7,235,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_settings-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
global repository for run-time library settings <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">DateProxy & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_settings.html#6576f80bf110cce38cfe75615acbf519">evaluationDate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the date at which pricing is to be performed. <a href="#6576f80bf110cce38cfe75615acbf519"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f9acfcd51b37771848c87dfc1c166d1"></a><!-- doxytag: member="QuantLib::Settings::evaluationDate" ref="4f9acfcd51b37771848c87dfc1c166d1" args="() const " -->
const DateProxy & </td><td class="memItemRight" valign="bottom"><b>evaluationDate</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9e40d6c4af762612fa8848f9d48c0572"></a><!-- doxytag: member="QuantLib::Settings::enforcesTodaysHistoricFixings" ref="9e40d6c4af762612fa8848f9d48c0572" args="()" -->
bool & </td><td class="memItemRight" valign="bottom"><b>enforcesTodaysHistoricFixings</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dda3a6a81339120e1ff517e66fc08420"></a><!-- doxytag: member="QuantLib::Settings::enforcesTodaysHistoricFixings" ref="dda3a6a81339120e1ff517e66fc08420" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>enforcesTodaysHistoricFixings</b> () const </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="91c99b41b2e91d182b86ccc958e3248e"></a><!-- doxytag: member="QuantLib::Settings::Singleton< Settings >" ref="91c99b41b2e91d182b86ccc958e3248e" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>Singleton< Settings ></b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7372fd0b783fb5d23e60a661934d1203"></a><!-- doxytag: member="QuantLib::Settings::operator<<" ref="7372fd0b783fb5d23e60a661934d1203" args="(std::ostream &, const DateProxy &)" -->
std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &, const DateProxy &)</td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6576f80bf110cce38cfe75615acbf519"></a><!-- doxytag: member="QuantLib::Settings::evaluationDate" ref="6576f80bf110cce38cfe75615acbf519" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DateProxy& evaluationDate </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
the date at which pricing is to be performed.
<p>
Client code can inspect the evaluation date, as in: <div class="fragment"><pre class="fragment"> Date d = <a class="code" href="class_quant_lib_1_1_singleton.html#b7455b7e1235d292c444095842349291" title="access to the unique instance">Settings::instance</a>().evaluationDate();
</pre></div> where today's date is returned if the evaluation date is set to the null date (its default value;) can set it to a new value, as in: <div class="fragment"><pre class="fragment"> <a class="code" href="class_quant_lib_1_1_singleton.html#b7455b7e1235d292c444095842349291" title="access to the unique instance">Settings::instance</a>().evaluationDate() = d;
</pre></div> and can register with it, as in: <div class="fragment"><pre class="fragment"> registerWith(<a class="code" href="class_quant_lib_1_1_singleton.html#b7455b7e1235d292c444095842349291" title="access to the unique instance">Settings::instance</a>().<a class="code" href="class_quant_lib_1_1_settings.html#6576f80bf110cce38cfe75615acbf519" title="the date at which pricing is to be performed.">evaluationDate</a>());
</pre></div> to be notified when it is set to a new value. <dl compact><dt><b><a class="el" href="caveats.html#_caveats000089">Warning:</a></b></dt><dd>a notification is not sent when the evaluation date changes for natural causes---i.e., a date was not explicitly set (which results in today's date being used for pricing) and the current date changes as the clock strikes midnight. </dd></dl>
</div>
</div><p>
</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>
|
