libqalculate-doc 0.9.7-9 / usr / share / doc / libqalculate-doc / html / classUnit.html

This file is indexed.

/usr/share/doc/libqalculate-doc/html/classUnit.html is in libqalculate-doc 0.9.7-9.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libqalculate-0.9.7: Unit Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Unit Class Reference</h1><!-- doxytag: class="Unit" --><!-- doxytag: inherits="ExpressionItem" -->A unit for measurement.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;Unit.h&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for Unit:</div>
<div class="dynsection">

<p><center><img src="classUnit.png" usemap="#Unit_map" border="0" alt=""></center>
<map name="Unit_map">
<area href="classExpressionItem.html" alt="ExpressionItem" shape="rect" coords="68,0,194,24">
<area href="classAliasUnit.html" alt="AliasUnit" shape="rect" coords="0,112,126,136">
<area href="classCompositeUnit.html" alt="CompositeUnit" shape="rect" coords="136,112,262,136">
<area href="classAliasUnit__Composite.html" alt="AliasUnit_Composite" shape="rect" coords="0,168,126,192">
</map>
</div>

<p>
<a href="classUnit-members.html">List of all members.</a><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"><a class="anchor" name="da94552cd58cd0ec7bea0178df3444d6"></a><!-- doxytag: member="Unit::Unit" ref="da94552cd58cd0ec7bea0178df3444d6" args="(string cat_, string name_, string plural_=&quot;&quot;, string singular_=&quot;&quot;, string title_=&quot;&quot;, bool is_local=true, bool is_builtin=false, bool is_active=true)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Unit</b> (string cat_, string name_, string plural_=&quot;&quot;, string singular_=&quot;&quot;, string title_=&quot;&quot;, bool is_local=true, bool is_builtin=false, bool is_active=true)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8464828c1a37c9b9fa21aabace35945b"></a><!-- doxytag: member="Unit::Unit" ref="8464828c1a37c9b9fa21aabace35945b" args="(const Unit *unit)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Unit</b> (const <a class="el" href="classUnit.html">Unit</a> *unit)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1882203fc0c95777eb17e9ae5a66c9bd"></a><!-- doxytag: member="Unit::copy" ref="1882203fc0c95777eb17e9ae5a66c9bd" args="() const " -->
virtual <a class="el" href="classExpressionItem.html">ExpressionItem</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>copy</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bde4f41f98e92f170074c3d72de3cc59"></a><!-- doxytag: member="Unit::set" ref="bde4f41f98e92f170074c3d72de3cc59" args="(const ExpressionItem *item)" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set</b> (const <a class="el" href="classExpressionItem.html">ExpressionItem</a> *item)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnit.html#9a078a47cda1c835d0c325456ccac58f">isSIUnit</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnit.html#9d8a5e2e6fba279af61018338b6d2e93">setAsSIUnit</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnit.html#a86cd31a1c0344fa61bedc6b3e60f474">setSystem</a> (string s_system)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnit.html#61fef1f2e25883fc170c0a9482db844f">system</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnit.html#2de36d5c8a7a2f96de67ad3053922013">isCurrency</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnit.html#4ad80de27c26cbe1963f584b38e00e61">print</a> (bool plural_, bool short_, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f94e42599c51db169821426d843f9c4f"></a><!-- doxytag: member="Unit::plural" ref="f94e42599c51db169821426d843f9c4f" args="(bool return_singular_if_no_plural=true, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const " -->
virtual const string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>plural</b> (bool return_singular_if_no_plural=true, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6c84ce448f6545f0e55ede738246e5c"></a><!-- doxytag: member="Unit::singular" ref="e6c84ce448f6545f0e55ede738246e5c" args="(bool return_abbreviation_if_no_singular=true, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const " -->
virtual const string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>singular</b> (bool return_abbreviation_if_no_singular=true, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="814f7cf1973f5eeb30e2bac2dd14df68"></a><!-- doxytag: member="Unit::abbreviation" ref="814f7cf1973f5eeb30e2bac2dd14df68" args="(bool return_singular_if_no_abbreviation=true, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const " -->
virtual const string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>abbreviation</b> (bool return_singular_if_no_abbreviation=true, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af7225c56f1155be6c816af02bc4ef7a"></a><!-- doxytag: member="Unit::isUsedByOtherUnits" ref="af7225c56f1155be6c816af02bc4ef7a" args="() const " -->
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isUsedByOtherUnits</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="243982e879a52c38fcc95db10e2ede29"></a><!-- doxytag: member="Unit::baseUnit" ref="243982e879a52c38fcc95db10e2ede29" args="() const " -->
virtual <a class="el" href="classUnit.html">Unit</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>baseUnit</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="606afc85e182b8f83fdb3196d4b55e60"></a><!-- doxytag: member="Unit::convertToBaseUnit" ref="606afc85e182b8f83fdb3196d4b55e60" args="(MathStructure &amp;mvalue, MathStructure &amp;mexp) const " -->
virtual <a class="el" href="classMathStructure.html">MathStructure</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>convertToBaseUnit</b> (<a class="el" href="classMathStructure.html">MathStructure</a> &amp;mvalue, <a class="el" href="classMathStructure.html">MathStructure</a> &amp;mexp) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="517051dfc30b78fc813dcd224139e5b4"></a><!-- doxytag: member="Unit::convertFromBaseUnit" ref="517051dfc30b78fc813dcd224139e5b4" args="(MathStructure &amp;mvalue, MathStructure &amp;mexp) const " -->
virtual <a class="el" href="classMathStructure.html">MathStructure</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>convertFromBaseUnit</b> (<a class="el" href="classMathStructure.html">MathStructure</a> &amp;mvalue, <a class="el" href="classMathStructure.html">MathStructure</a> &amp;mexp) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="289e30bb7926856359418d6fa1a5f019"></a><!-- doxytag: member="Unit::convertToBaseUnit" ref="289e30bb7926856359418d6fa1a5f019" args="(MathStructure &amp;mvalue) const " -->
virtual <a class="el" href="classMathStructure.html">MathStructure</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>convertToBaseUnit</b> (<a class="el" href="classMathStructure.html">MathStructure</a> &amp;mvalue) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83caa18406c82fe5b1badd4f3f886bdd"></a><!-- doxytag: member="Unit::convertFromBaseUnit" ref="83caa18406c82fe5b1badd4f3f886bdd" args="(MathStructure &amp;mvalue) const " -->
virtual <a class="el" href="classMathStructure.html">MathStructure</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>convertFromBaseUnit</b> (<a class="el" href="classMathStructure.html">MathStructure</a> &amp;mvalue) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35013c72fa7af17655e3696ddb3da8ff"></a><!-- doxytag: member="Unit::convertToBaseUnit" ref="35013c72fa7af17655e3696ddb3da8ff" args="() const " -->
virtual <a class="el" href="classMathStructure.html">MathStructure</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>convertToBaseUnit</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="80f59e5bb10c595d1c56689dfe033028"></a><!-- doxytag: member="Unit::convertFromBaseUnit" ref="80f59e5bb10c595d1c56689dfe033028" args="() const " -->
virtual <a class="el" href="classMathStructure.html">MathStructure</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>convertFromBaseUnit</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7cdf278e3869c09a74d9e134fe010e56"></a><!-- doxytag: member="Unit::baseExponent" ref="7cdf278e3869c09a74d9e134fe010e56" args="(int exp=1) const " -->
virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><b>baseExponent</b> (int exp=1) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnit.html#b4e6ad8f83717457393724621a52a11e">type</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnit.html#d9f4f05c29ed947195274abc7d9a39a3">subtype</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnit.html#d1cd1f10c7fbee65e05513115144de00">isChildOf</a> (<a class="el" href="classUnit.html">Unit</a> *u) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnit.html#6598f3532f5b7d046faae41ff6506698">isParentOf</a> (<a class="el" href="classUnit.html">Unit</a> *u) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="17de9cca61eeeb48501f6be2acd848bf"></a><!-- doxytag: member="Unit::hasComplexRelationTo" ref="17de9cca61eeeb48501f6be2acd848bf" args="(Unit *u) const " -->
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>hasComplexRelationTo</b> (<a class="el" href="classUnit.html">Unit</a> *u) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnit.html#9efdaa0832334d20c7d3e2965aac067d">convert</a> (<a class="el" href="classUnit.html">Unit</a> *u, <a class="el" href="classMathStructure.html">MathStructure</a> &amp;mvalue, <a class="el" href="classMathStructure.html">MathStructure</a> &amp;exp) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnit.html#4170e571b8ceb93d197b780f5b881ab7">convert</a> (<a class="el" href="classUnit.html">Unit</a> *u, <a class="el" href="classMathStructure.html">MathStructure</a> &amp;mvalue) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23def5b9e3c6df03e6cd23b2f7c313fa"></a><!-- doxytag: member="Unit::convert" ref="23def5b9e3c6df03e6cd23b2f7c313fa" args="(Unit *u, bool *converted=NULL) const " -->
<a class="el" href="classMathStructure.html">MathStructure</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>convert</b> (<a class="el" href="classUnit.html">Unit</a> *u, bool *converted=NULL) const </td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6f18ed5e29c2fd82e57e2173f1223d66"></a><!-- doxytag: member="Unit::ssystem" ref="6f18ed5e29c2fd82e57e2173f1223d66" args="" -->
string&nbsp;</td><td class="memItemRight" valign="bottom"><b>ssystem</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc16342df7a34d217a706b234e0fe249"></a><!-- doxytag: member="Unit::b_si" ref="fc16342df7a34d217a706b234e0fe249" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>b_si</b></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A unit for measurement. 
<p>
The <a class="el" href="classUnit.html" title="A unit for measurement.">Unit</a> class both represents a base unit and is the base class for other unit types. Base units are units defined as basis for other units. Meters and seconds are typical base units.<p>
For base units, a name is all that is needed. Base units do however normally have three different names defined for use in expressions - abbreviation (ex. "m"), singular ("meter") and plural ("meters"). <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9a078a47cda1c835d0c325456ccac58f"></a><!-- doxytag: member="Unit::isSIUnit" ref="9a078a47cda1c835d0c325456ccac58f" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Unit::isSIUnit           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns if the unit is part of the SI standard.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the unit is part of the SI standard. </dd></dl>

</div>
</div><p>
<a class="anchor" name="9d8a5e2e6fba279af61018338b6d2e93"></a><!-- doxytag: member="Unit::setAsSIUnit" ref="9d8a5e2e6fba279af61018338b6d2e93" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Unit::setAsSIUnit           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
State that the unit is part of the SI standard. Sets system to "SI". 
</div>
</div><p>
<a class="anchor" name="a86cd31a1c0344fa61bedc6b3e60f474"></a><!-- doxytag: member="Unit::setSystem" ref="a86cd31a1c0344fa61bedc6b3e60f474" args="(string s_system)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Unit::setSystem           </td>
          <td>(</td>
          <td class="paramtype">string&nbsp;</td>
          <td class="paramname"> <em>s_system</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets which system/standard ("SI", "SGC", etc.) the unit is part of. Setting system to "SI" (case-insensitive), is equivalent to <a class="el" href="classUnit.html#9d8a5e2e6fba279af61018338b6d2e93">setAsSIUnit()</a>. 
</div>
</div><p>
<a class="anchor" name="61fef1f2e25883fc170c0a9482db844f"></a><!-- doxytag: member="Unit::system" ref="61fef1f2e25883fc170c0a9482db844f" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const string&amp; Unit::system           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the system/standard that the unit is part of.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>System string. </dd></dl>

</div>
</div><p>
<a class="anchor" name="2de36d5c8a7a2f96de67ad3053922013"></a><!-- doxytag: member="Unit::isCurrency" ref="2de36d5c8a7a2f96de67ad3053922013" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Unit::isCurrency           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns if the unit is a currency (Euro is base unit).<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the unit is a currency. </dd></dl>

</div>
</div><p>
<a class="anchor" name="4ad80de27c26cbe1963f584b38e00e61"></a><!-- doxytag: member="Unit::print" ref="4ad80de27c26cbe1963f584b38e00e61" args="(bool plural_, bool short_, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual string Unit::print           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>plural_</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>short_</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>use_unicode</em> = <code>false</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool(*)(const char *, void *)&nbsp;</td>
          <td class="paramname"> <em>can_display_unicode_string_function</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&nbsp;</td>
          <td class="paramname"> <em>can_display_unicode_string_arg</em> = <code>NULL</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns a display string representing the unit in an expression.<p>
Equivalent to <a class="el" href="classExpressionItem.html#0d1072302daaedec9deddea6713c0593">preferredName()</a> for <a class="el" href="classUnit.html" title="A unit for measurement.">Unit</a> and <a class="el" href="classAliasUnit.html" title="An unit with relation to another unit.">AliasUnit</a>, but closer to MathStructure::print() for <a class="el" href="classCompositeUnit.html" title="A unit consisting of a number of other units.">CompositeUnit</a> (prints out base expression). 
<p>Reimplemented in <a class="el" href="classAliasUnit__Composite.html#07ff9eb31b7b6514ba255fd7523632fa">AliasUnit_Composite</a>, and <a class="el" href="classCompositeUnit.html#d559c0605c9801cd78fd4bf841658a2f">CompositeUnit</a>.</p>

</div>
</div><p>
<a class="anchor" name="b4e6ad8f83717457393724621a52a11e"></a><!-- doxytag: member="Unit::type" ref="b4e6ad8f83717457393724621a52a11e" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int Unit::type           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the type of the expression item, corresponding to which subclass the object belongs to.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="includes_8h.html#05f1c0afe6f10792534dbd98fbb7541f" title="Type of ExpressionItem.">ExpressionItemType</a>. </dd></dl>

<p>Implements <a class="el" href="classExpressionItem.html#53cbb21250c1c8cc66c6f18a22aa69cf">ExpressionItem</a>.</p>

</div>
</div><p>
<a class="anchor" name="d9f4f05c29ed947195274abc7d9a39a3"></a><!-- doxytag: member="Unit::subtype" ref="d9f4f05c29ed947195274abc7d9a39a3" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int Unit::subtype           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the subtype of the unit, corresponding to which subsubclass the object belongs to.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="Unit_8h.html#187e4d06747a26a2325145b16ff73915" title="Type of unit.">UnitSubtype</a>. </dd></dl>

<p>Implements <a class="el" href="classExpressionItem.html#b502d8d46b75f60b45e8bcf7dcbf655a">ExpressionItem</a>.</p>

<p>Reimplemented in <a class="el" href="classAliasUnit.html#05402283a80a32786c2ef9d999ef4285">AliasUnit</a>, and <a class="el" href="classCompositeUnit.html#12eb9a85f6e2994afa64ef037037f4f9">CompositeUnit</a>.</p>

</div>
</div><p>
<a class="anchor" name="d1cd1f10c7fbee65e05513115144de00"></a><!-- doxytag: member="Unit::isChildOf" ref="d1cd1f10c7fbee65e05513115144de00" args="(Unit *u) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Unit::isChildOf           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classUnit.html">Unit</a> *&nbsp;</td>
          <td class="paramname"> <em>u</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
If specified unit is a base unit for this unit, directly or with other units in between. Equivalent to u-&gt;isParentOf(this). 
<p>Reimplemented in <a class="el" href="classAliasUnit.html#2ff243e55c77a947eade51ee93fc5c79">AliasUnit</a>.</p>

</div>
</div><p>
<a class="anchor" name="6598f3532f5b7d046faae41ff6506698"></a><!-- doxytag: member="Unit::isParentOf" ref="6598f3532f5b7d046faae41ff6506698" args="(Unit *u) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Unit::isParentOf           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classUnit.html">Unit</a> *&nbsp;</td>
          <td class="paramname"> <em>u</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
If this unit is a base unit for specified unit, directly or with other units in between. Equivalent to u-&gt;isChildOf(this). 
<p>Reimplemented in <a class="el" href="classAliasUnit.html#075edcb570d3cc980283213e7d423834">AliasUnit</a>.</p>

</div>
</div><p>
<a class="anchor" name="9efdaa0832334d20c7d3e2965aac067d"></a><!-- doxytag: member="Unit::convert" ref="9efdaa0832334d20c7d3e2965aac067d" args="(Unit *u, MathStructure &amp;mvalue, MathStructure &amp;exp) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Unit::convert           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classUnit.html">Unit</a> *&nbsp;</td>
          <td class="paramname"> <em>u</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classMathStructure.html">MathStructure</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>mvalue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classMathStructure.html">MathStructure</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>exp</em></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>
Converts a value from specified unit and exponent to this unit. value * (unit^exponent) = new value * (this^new exponent) This function cannot convert to or from <a class="el" href="classCompositeUnit.html" title="A unit consisting of a number of other units.">CompositeUnit</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>u</em>&nbsp;</td><td><a class="el" href="classUnit.html" title="A unit for measurement.">Unit</a> to convert from. </td></tr>
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>mvalue</em>&nbsp;</td><td>Quantity value. </td></tr>
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>exp</em>&nbsp;</td><td>Exponent. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the value was successfully converted. </dd></dl>

</div>
</div><p>
<a class="anchor" name="4170e571b8ceb93d197b780f5b881ab7"></a><!-- doxytag: member="Unit::convert" ref="4170e571b8ceb93d197b780f5b881ab7" args="(Unit *u, MathStructure &amp;mvalue) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Unit::convert           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classUnit.html">Unit</a> *&nbsp;</td>
          <td class="paramname"> <em>u</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classMathStructure.html">MathStructure</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>mvalue</em></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>
Converts a value from specified unit and exponent to this unit. value * unit = new value * this This function cannot convert to or from <a class="el" href="classCompositeUnit.html" title="A unit consisting of a number of other units.">CompositeUnit</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>u</em>&nbsp;</td><td><a class="el" href="classUnit.html" title="A unit for measurement.">Unit</a> to convert from. </td></tr>
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>mvalue</em>&nbsp;</td><td>Quantity value. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the value was successfully converted. </dd></dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>libqalculate/<a class="el" href="Unit_8h.html">Unit.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jan 5 08:26:29 2010 for libqalculate-0.9.7 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.