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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantLib: UnitOfMeasure Class Reference</title>
<link href='https://fonts.googleapis.com/css?family=Merriweather+Sans:800' rel='stylesheet' type='text/css'>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="quantlibextra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="http://quantlib.org">
<img alt="QuantLib" src="QL-title.jpg"></a>
<div id="projectbrief">A free/open-source library for quantitative finance</div>
<div id="projectnumber">Reference manual - version 1.20</div>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_quant_lib.html">QuantLib</a></li><li class="navelem"><a class="el" href="class_quant_lib_1_1_unit_of_measure.html">UnitOfMeasure</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#related">Related Functions</a> |
<a href="class_quant_lib_1_1_unit_of_measure-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">UnitOfMeasure Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Unit of measure specification
<a href="class_quant_lib_1_1_unit_of_measure.html#details">More...</a></p>
<p><code>#include <ql/experimental/commodities/unitofmeasure.hpp></code></p>
<p>Inherited by BarrelUnitOfMeasure, GallonUnitOfMeasure, KilolitreUnitOfMeasure, LitreUnitOfMeasure, LotUnitOfMeasure, MBUnitOfMeasure, MTUnitOfMeasure, and TokyoKilolitreUnitOfMeasure.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a1d1cfd8ffb84e947f82999c682b666a7"><td class="memItemLeft" align="right" valign="top"><a id="a1d1cfd8ffb84e947f82999c682b666a7"></a>enum  </td><td class="memItemRight" valign="bottom"><b>Type</b> { <b>Mass</b>,
<b>Volume</b>,
<b>Energy</b>,
<b>Quantity</b>
}</td></tr>
<tr class="separator:a1d1cfd8ffb84e947f82999c682b666a7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0d331fdab7998ace4c8dd0db6e6bd2df"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_unit_of_measure.html#a0d331fdab7998ace4c8dd0db6e6bd2df">UnitOfMeasure</a> ()</td></tr>
<tr class="memdesc:a0d331fdab7998ace4c8dd0db6e6bd2df"><td class="mdescLeft"> </td><td class="mdescRight">default constructor <a href="class_quant_lib_1_1_unit_of_measure.html#a0d331fdab7998ace4c8dd0db6e6bd2df">More...</a><br /></td></tr>
<tr class="separator:a0d331fdab7998ace4c8dd0db6e6bd2df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8298d7a2df5c748273a284404203a49"><td class="memItemLeft" align="right" valign="top"><a id="ab8298d7a2df5c748273a284404203a49"></a>
 </td><td class="memItemRight" valign="bottom"><b>UnitOfMeasure</b> (const std::string &<a class="el" href="class_quant_lib_1_1_unit_of_measure.html#a24dcbf29c0d6cd766009a182a6484e3b">name</a>, const std::string &<a class="el" href="class_quant_lib_1_1_unit_of_measure.html#a19a22c307846d12f190e071667a2498e">code</a>, Type <a class="el" href="class_quant_lib_1_1_unit_of_measure.html#ab2e591b61b7204d648b40ce3cf5550eb">unitType</a>)</td></tr>
<tr class="separator:ab8298d7a2df5c748273a284404203a49"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Inspectors</div></td></tr>
<tr class="memitem:a24dcbf29c0d6cd766009a182a6484e3b"><td class="memItemLeft" align="right" valign="top"><a id="a24dcbf29c0d6cd766009a182a6484e3b"></a>
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_unit_of_measure.html#a24dcbf29c0d6cd766009a182a6484e3b">name</a> () const</td></tr>
<tr class="memdesc:a24dcbf29c0d6cd766009a182a6484e3b"><td class="mdescLeft"> </td><td class="mdescRight">name, e.g, "Barrels" <br /></td></tr>
<tr class="separator:a24dcbf29c0d6cd766009a182a6484e3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19a22c307846d12f190e071667a2498e"><td class="memItemLeft" align="right" valign="top"><a id="a19a22c307846d12f190e071667a2498e"></a>
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_unit_of_measure.html#a19a22c307846d12f190e071667a2498e">code</a> () const</td></tr>
<tr class="memdesc:a19a22c307846d12f190e071667a2498e"><td class="mdescLeft"> </td><td class="mdescRight">code, e.g, "BBL", "MT" <br /></td></tr>
<tr class="separator:a19a22c307846d12f190e071667a2498e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2e591b61b7204d648b40ce3cf5550eb"><td class="memItemLeft" align="right" valign="top"><a id="ab2e591b61b7204d648b40ce3cf5550eb"></a>
Type </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_unit_of_measure.html#ab2e591b61b7204d648b40ce3cf5550eb">unitType</a> () const</td></tr>
<tr class="memdesc:ab2e591b61b7204d648b40ce3cf5550eb"><td class="mdescLeft"> </td><td class="mdescRight">unit type (mass, volume...) <br /></td></tr>
<tr class="separator:ab2e591b61b7204d648b40ce3cf5550eb"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a93b0e3b06bb3eff2e7f80864d32101b2"><td class="memItemLeft" align="right" valign="top"><a id="a93b0e3b06bb3eff2e7f80864d32101b2"></a>
bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="class_quant_lib_1_1_unit_of_measure.html">UnitOfMeasure</a> &, const <a class="el" href="class_quant_lib_1_1_unit_of_measure.html">UnitOfMeasure</a> &)</td></tr>
<tr class="separator:a93b0e3b06bb3eff2e7f80864d32101b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b072a8434094fec0d21f53346581ee4"><td class="memItemLeft" align="right" valign="top"><a id="a7b072a8434094fec0d21f53346581ee4"></a>
bool </td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="class_quant_lib_1_1_unit_of_measure.html">UnitOfMeasure</a> &, const <a class="el" href="class_quant_lib_1_1_unit_of_measure.html">UnitOfMeasure</a> &)</td></tr>
<tr class="separator:a7b072a8434094fec0d21f53346581ee4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5dc130ad7da6f32ebcc08e2018fe9f22"><td class="memItemLeft" align="right" valign="top"><a id="a5dc130ad7da6f32ebcc08e2018fe9f22"></a>
std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &, const <a class="el" href="class_quant_lib_1_1_unit_of_measure.html">UnitOfMeasure</a> &)</td></tr>
<tr class="separator:a5dc130ad7da6f32ebcc08e2018fe9f22"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Other information</h2></td></tr>
<tr class="memitem:ae5bf3e19b58a51ff5183190c53999eae"><td class="memItemLeft" align="right" valign="top"><a id="ae5bf3e19b58a51ff5183190c53999eae"></a>
ext::shared_ptr< Data > </td><td class="memItemRight" valign="bottom"><b>data_</b></td></tr>
<tr class="separator:ae5bf3e19b58a51ff5183190c53999eae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="memItemLeft" align="right" valign="top"><a id="a644718bb2fb240de962dc3c9a1fdf0dc"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_unit_of_measure.html#a644718bb2fb240de962dc3c9a1fdf0dc">empty</a> () const</td></tr>
<tr class="memdesc:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="mdescLeft"> </td><td class="mdescRight">is this a usable instance? <br /></td></tr>
<tr class="separator:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05ff42e05ba8b766b39679235c8d8215"><td class="memItemLeft" align="right" valign="top"><a id="a05ff42e05ba8b766b39679235c8d8215"></a>
const <a class="el" href="class_quant_lib_1_1_rounding.html">Rounding</a> & </td><td class="memItemRight" valign="bottom"><b>rounding</b> () const</td></tr>
<tr class="separator:a05ff42e05ba8b766b39679235c8d8215"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a036aad1482702ddac1ac496480b12bf2"><td class="memItemLeft" align="right" valign="top"><a id="a036aad1482702ddac1ac496480b12bf2"></a>
const <a class="el" href="class_quant_lib_1_1_unit_of_measure.html">UnitOfMeasure</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_unit_of_measure.html#a036aad1482702ddac1ac496480b12bf2">triangulationUnitOfMeasure</a> () const</td></tr>
<tr class="memdesc:a036aad1482702ddac1ac496480b12bf2"><td class="mdescLeft"> </td><td class="mdescRight">unit used for triangulation when required <br /></td></tr>
<tr class="separator:a036aad1482702ddac1ac496480b12bf2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Unit of measure specification </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a0d331fdab7998ace4c8dd0db6e6bd2df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d331fdab7998ace4c8dd0db6e6bd2df">◆ </a></span>UnitOfMeasure()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_unit_of_measure.html">UnitOfMeasure</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>default constructor </p>
<p>Instances built via this constructor have undefined behavior. Such instances can only act as placeholders and must be reassigned to a valid currency before being used. </p>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.9.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="http://www.doxygen.org/index.html">Doxygen</a>
1.8.20
</small></address>
</body>
</html>
|
