File: class_quant_lib_1_1_commodity.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 (131 lines) | stat: -rw-r--r-- 7,871 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
<!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>Commodity 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_commodity.html">Commodity</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">Commodity Class Reference<div class="ingroups"><a class="el" href="group__instruments.html">Financial instruments</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::Commodity" --><!-- doxytag: inherits="QuantLib::Instrument" -->
<p><a class="el" href="class_quant_lib_1_1_commodity.html" title="Commodity base class.">Commodity</a> base class.  
 <a href="class_quant_lib_1_1_commodity.html#details">More...</a></p>

<p><code>#include &lt;ql/experimental/commodities/commodity.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Commodity:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_commodity__inherit__graph.png" border="0" usemap="#_commodity_inherit__map" alt="Inheritance graph"/></div>
<map name="_commodity_inherit__map" id="_commodity_inherit__map">
<area shape="rect" id="node5" href="class_quant_lib_1_1_energy_commodity.html" title="Energy commodity class." alt="" coords="5,166,133,197"/><area shape="rect" id="node2" href="class_quant_lib_1_1_instrument.html" title="Abstract instrument class." alt="" coords="28,6,111,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_commodity-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="a158b39795cddba2f2b2c3e04843dcf0c"></a><!-- doxytag: member="QuantLib::Commodity::Commodity" ref="a158b39795cddba2f2b2c3e04843dcf0c" args="(const boost::shared_ptr&lt; SecondaryCosts &gt; &amp;secondaryCosts)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>Commodity</b> (const boost::shared_ptr&lt; SecondaryCosts &gt; &amp;secondaryCosts)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3794650bbfcd5cdc7cfce815dcda82e"></a><!-- doxytag: member="QuantLib::Commodity::secondaryCosts" ref="ae3794650bbfcd5cdc7cfce815dcda82e" args="() const " -->
const boost::shared_ptr<br class="typebreak"/>
&lt; SecondaryCosts &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>secondaryCosts</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34142b1dd8c4ea5624f6f48757d70340"></a><!-- doxytag: member="QuantLib::Commodity::secondaryCostAmounts" ref="a34142b1dd8c4ea5624f6f48757d70340" args="() const " -->
const SecondaryCostAmounts &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>secondaryCostAmounts</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23f2960fa1d326be0357be9c9fdd1ac1"></a><!-- doxytag: member="QuantLib::Commodity::pricingErrors" ref="a23f2960fa1d326be0357be9c9fdd1ac1" args="() const " -->
const PricingErrors &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>pricingErrors</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adcf5b5285c0e8f1aa49d6e93ee8a27be"></a><!-- doxytag: member="QuantLib::Commodity::addPricingError" ref="adcf5b5285c0e8f1aa49d6e93ee8a27be" args="(PricingError::Level errorLevel, const std::string &amp;error, const std::string &amp;detail=&quot;&quot;) const " -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>addPricingError</b> (PricingError::Level errorLevel, const std::string &amp;error, const std::string &amp;detail=&quot;&quot;) const </td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5fbbba7aa834bddd8b002c0af0568ecd"></a><!-- doxytag: member="QuantLib::Commodity::secondaryCosts_" ref="a5fbbba7aa834bddd8b002c0af0568ecd" args="" -->
boost::shared_ptr&lt; SecondaryCosts &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>secondaryCosts_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af35ac89c7076d35e237e0fcc414cd4c9"></a><!-- doxytag: member="QuantLib::Commodity::pricingErrors_" ref="af35ac89c7076d35e237e0fcc414cd4c9" args="" -->
PricingErrors&#160;</td><td class="memItemRight" valign="bottom"><b>pricingErrors_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0c4cfec6bf26d5ea22a7e29395c764c"></a><!-- doxytag: member="QuantLib::Commodity::secondaryCostAmounts_" ref="af0c4cfec6bf26d5ea22a7e29395c764c" args="" -->
SecondaryCostAmounts&#160;</td><td class="memItemRight" valign="bottom"><b>secondaryCostAmounts_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="class_quant_lib_1_1_commodity.html" title="Commodity base class.">Commodity</a> base class. </p>
</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>