<!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: BinaryPrefix 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 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 List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>BinaryPrefix Class Reference</h1><!-- doxytag: class="BinaryPrefix" --><!-- doxytag: inherits="Prefix" -->A binary prefix.
<a href="#_details">More...</a>
<p>
<code>#include <Prefix.h></code>
<p>
<div class="dynheader">
Inheritance diagram for BinaryPrefix:</div>
<div class="dynsection">
<p><center><img src="classBinaryPrefix.png" usemap="#BinaryPrefix_map" border="0" alt=""></center>
<map name="BinaryPrefix_map">
<area href="classPrefix.html" alt="Prefix" shape="rect" coords="0,0,82,24">
</map>
</div>
<p>
<a href="classBinaryPrefix-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryPrefix.html#f012e17c60734b318c15b1220d861cae">BinaryPrefix</a> (int exp2, string long_name, string short_name="", string unicode_name="")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryPrefix.html#5929d1866651be5cef9568239600feac">exponent</a> (int iexp=1) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classNumber.html">Number</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryPrefix.html#3270b6ea733a364bf9cb68e41769d70c">exponent</a> (const <a class="el" href="classNumber.html">Number</a> &nexp) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryPrefix.html#f21052800b646823be301a321df7b2a4">setExponent</a> (int iexp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classNumber.html">Number</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryPrefix.html#793e040ded8004a840829df7ce43ffba">value</a> (const <a class="el" href="classNumber.html">Number</a> &nexp) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classNumber.html">Number</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryPrefix.html#6266650763a476d9d4f467e994f9acf1">value</a> (int iexp) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classNumber.html">Number</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryPrefix.html#3ab4790b8d1b5b9452e9a5ff6f2078a1">value</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinaryPrefix.html#b4bff478fa4c2cc6322dceb56595b643">type</a> () 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="c64452c9fe3acdeb5fb5eac7c1b14263"></a><!-- doxytag: member="BinaryPrefix::exp" ref="c64452c9fe3acdeb5fb5eac7c1b14263" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>exp</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A binary prefix.
<p>
A Binary prefix has an integer exponent which with a base of two constitutes the value of the prefix (value=2^exponent). <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f012e17c60734b318c15b1220d861cae"></a><!-- doxytag: member="BinaryPrefix::BinaryPrefix" ref="f012e17c60734b318c15b1220d861cae" args="(int exp2, string long_name, string short_name="", string unicode_name="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BinaryPrefix::BinaryPrefix </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>exp2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string </td>
<td class="paramname"> <em>long_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string </td>
<td class="paramname"> <em>short_name</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string </td>
<td class="paramname"> <em>unicode_name</em> = <code>""</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a binary prefix.<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>exp2</em> </td><td>Exponent for the value. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>long_name</em> </td><td>Long name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>short_name</em> </td><td>Short name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>unicode_name</em> </td><td>Unicode name. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5929d1866651be5cef9568239600feac"></a><!-- doxytag: member="BinaryPrefix::exponent" ref="5929d1866651be5cef9568239600feac" args="(int iexp=1) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BinaryPrefix::exponent </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>iexp</em> = <code>1</code> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the exponent.<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>iexp</em> </td><td>Exponent of the unit. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The exponent of the prefix. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3270b6ea733a364bf9cb68e41769d70c"></a><!-- doxytag: member="BinaryPrefix::exponent" ref="3270b6ea733a364bf9cb68e41769d70c" args="(const Number &nexp) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classNumber.html">Number</a> BinaryPrefix::exponent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classNumber.html">Number</a> & </td>
<td class="paramname"> <em>nexp</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the exponent.<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>nexp</em> </td><td>Exponent of the unit. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The exponent of the prefix. </dd></dl>
</div>
</div><p>
<a class="anchor" name="f21052800b646823be301a321df7b2a4"></a><!-- doxytag: member="BinaryPrefix::setExponent" ref="f21052800b646823be301a321df7b2a4" args="(int iexp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BinaryPrefix::setExponent </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>iexp</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the exponent of the prefix.<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>iexp</em> </td><td>New exponent for the prefix. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="793e040ded8004a840829df7ce43ffba"></a><!-- doxytag: member="BinaryPrefix::value" ref="793e040ded8004a840829df7ce43ffba" args="(const Number &nexp) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classNumber.html">Number</a> BinaryPrefix::value </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classNumber.html">Number</a> & </td>
<td class="paramname"> <em>nexp</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the value of the prefix.<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>nexp</em> </td><td>The power of the prefixed unit. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The value of the prefix. </dd></dl>
<p>Implements <a class="el" href="classPrefix.html#e828e66c2fc5b58cc6cc6df5db15d2b2">Prefix</a>.</p>
</div>
</div><p>
<a class="anchor" name="6266650763a476d9d4f467e994f9acf1"></a><!-- doxytag: member="BinaryPrefix::value" ref="6266650763a476d9d4f467e994f9acf1" args="(int iexp) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classNumber.html">Number</a> BinaryPrefix::value </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>iexp</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the value of the prefix.<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>iexp</em> </td><td>The power of the prefixed unit. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The value of the prefix. </dd></dl>
<p>Implements <a class="el" href="classPrefix.html#a1eec8b3ac6266f3865d169c07d9e26d">Prefix</a>.</p>
</div>
</div><p>
<a class="anchor" name="3ab4790b8d1b5b9452e9a5ff6f2078a1"></a><!-- doxytag: member="BinaryPrefix::value" ref="3ab4790b8d1b5b9452e9a5ff6f2078a1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classNumber.html">Number</a> BinaryPrefix::value </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the value of the prefix.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The value of the prefix. </dd></dl>
<p>Implements <a class="el" href="classPrefix.html#e304214d9254a1e9e06d8ee2c6df09ab">Prefix</a>.</p>
</div>
</div><p>
<a class="anchor" name="b4bff478fa4c2cc6322dceb56595b643"></a><!-- doxytag: member="BinaryPrefix::type" ref="b4bff478fa4c2cc6322dceb56595b643" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BinaryPrefix::type </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns type, subclass, of the prefix. This can be PREFIX_DECIMAL for prefixes of the class <a class="el" href="classDecimalPrefix.html" title="A decimal (metric) prefix.">DecimalPrefix</a>, PREFIX_BINARY for <a class="el" href="classBinaryPrefix.html" title="A binary prefix.">BinaryPrefix</a>, or PREFIX_NUMBER for <a class="el" href="classNumberPrefix.html" title="A prefix with a free numerical value.">NumberPrefix</a>.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The type of the prefix. </dd></dl>
<p>Implements <a class="el" href="classPrefix.html#2e3d9095de33a874a898b7218636be3a">Prefix</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>libqalculate/<a class="el" href="Prefix_8h.html">Prefix.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
<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>
