<!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"/>
<title>ucommon: Number Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ucommon</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00090.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>Number Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Number" -->
<p>A number manipulation class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00190_source.html">numbers.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Number:</div>
<div class="dyncontent">
<div class="center"><img src="a00388.png" border="0" usemap="#_number_inherit__map" alt="Inheritance graph"/></div>
<map name="_number_inherit__map" id="_number_inherit__map">
<area shape="rect" id="node3" href="a00040.html" title="A number class that manipulates a string buffer that is also a date." alt="" coords="5,80,128,107"/><area shape="rect" id="node5" href="a00175.html" title="A number manipulation class that maintains a zero lead filled string." alt="" coords="152,80,243,107"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a9e50c8d4101c0cd07cba9ed9fa22740b">c_str</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get string buffer representing the number. <a href="#a9e50c8d4101c0cd07cba9ed9fa22740b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a8777517192283a0ba4fa9f196c7504d5">get</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get value of string buffer as a long integer. <a href="#a8777517192283a0ba4fa9f196c7504d5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a9a89bef31e5d8ffa1a23ebb0ae24986d">Number</a> (char *buffer, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of a number. <a href="#a9a89bef31e5d8ffa1a23ebb0ae24986d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#aa1e774ca1e43afd15af8faa94d87e826">operator char *</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cast object as a string to retrieve buffer. <a href="#aa1e774ca1e43afd15af8faa94d87e826"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a547b51f02d5571b886154989697cfb70">operator long</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cast string as long integer and get value of buffer. <a href="#a547b51f02d5571b886154989697cfb70"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a315ace487b2ca63fc380417ea857aef6">operator()</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get value of string buffer as expression of object. <a href="#a315ace487b2ca63fc380417ea857aef6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a06645ac4f8c1ee4f7bca35d12ca3603a">operator++</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increment the number object. <a href="#a06645ac4f8c1ee4f7bca35d12ca3603a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#af9b0418813283ecf46785ea0c491bff3">operator+=</a> (const long value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a value to the number. <a href="#af9b0418813283ecf46785ea0c491bff3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a54d614a0e5fe4fafe94a487dc83631e1">operator--</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrement the number object. <a href="#a54d614a0e5fe4fafe94a487dc83631e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#adf1b40b7137f6fe59a31ac81f1d861b1">operator-=</a> (const long value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subtract a value from the number. <a href="#adf1b40b7137f6fe59a31ac81f1d861b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a82ff3455b84d7ce800e572aa6f75cfbd">operator=</a> (long value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign a value to the number. <a href="#a82ff3455b84d7ce800e572aa6f75cfbd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a59e85c16e5346ecde875215ae79d6a86">operator=</a> (const <a class="el" href="a00090.html">Number</a> &number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign another number to this number. <a href="#a59e85c16e5346ecde875215ae79d6a86"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a76a2bc4ddeee5ee50787d83de4356d59">set</a> (long value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set string based on a new value. <a href="#a76a2bc4ddeee5ee50787d83de4356d59"></a><br/></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="aaeaa8030c2839bb3d229a01999568f2f"></a><!-- doxytag: member="Number::buffer" ref="aaeaa8030c2839bb3d229a01999568f2f" args="" -->
char * </td><td class="memItemRight" valign="bottom"><b>buffer</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb1f4fa36ffa15d46e38e5a9ec052b91"></a><!-- doxytag: member="Number::size" ref="aeb1f4fa36ffa15d46e38e5a9ec052b91" args="" -->
unsigned </td><td class="memItemRight" valign="bottom"><b>size</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A number manipulation class. </p>
<p>This is used to extract, convert, and manage simple numbers that are represented in C ascii strings in a very quick and optimal way. This class modifies the string representation each time the value is changed. No math expressions or explicit comparison operators are supported for the Numbers class because these are best done by casting to long first.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> number manipulation. </dd></dl>
<p>Definition at line <a class="el" href="a00190_source.html#l00046">46</a> of file <a class="el" href="a00190_source.html">numbers.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9a89bef31e5d8ffa1a23ebb0ae24986d"></a><!-- doxytag: member="Number::Number" ref="a9a89bef31e5d8ffa1a23ebb0ae24986d" args="(char *buffer, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Number::Number </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an instance of a number. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>or NULL if created internally. </td></tr>
<tr><td class="paramname">size</td><td>of field if not null terminated. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9e50c8d4101c0cd07cba9ed9fa22740b"></a><!-- doxytag: member="Number::c_str" ref="a9e50c8d4101c0cd07cba9ed9fa22740b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* Number::c_str </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get string buffer representing the number. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>string buffer. </dd></dl>
<p>Definition at line <a class="el" href="a00190_source.html#l00070">70</a> of file <a class="el" href="a00190_source.html">numbers.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8777517192283a0ba4fa9f196c7504d5"></a><!-- doxytag: member="Number::get" ref="a8777517192283a0ba4fa9f196c7504d5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Number::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get value of string buffer as a long integer. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>long integer value of string buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="aa1e774ca1e43afd15af8faa94d87e826"></a><!-- doxytag: member="Number::operator char *" ref="aa1e774ca1e43afd15af8faa94d87e826" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Number::operator char * </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cast object as a string to retrieve buffer. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>string buffer of value. </dd></dl>
<p>Definition at line <a class="el" href="a00190_source.html#l00097">97</a> of file <a class="el" href="a00190_source.html">numbers.h</a>.</p>
</div>
</div>
<a class="anchor" id="a547b51f02d5571b886154989697cfb70"></a><!-- doxytag: member="Number::operator long" ref="a547b51f02d5571b886154989697cfb70" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Number::operator long </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cast string as long integer and get value of buffer. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>long integer value of string buffer. </dd></dl>
<p>Definition at line <a class="el" href="a00190_source.html#l00090">90</a> of file <a class="el" href="a00190_source.html">numbers.h</a>.</p>
</div>
</div>
<a class="anchor" id="a315ace487b2ca63fc380417ea857aef6"></a><!-- doxytag: member="Number::operator()" ref="a315ace487b2ca63fc380417ea857aef6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Number::operator() </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get value of string buffer as expression of object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>long integer value of string buffer. </dd></dl>
<p>Definition at line <a class="el" href="a00190_source.html#l00083">83</a> of file <a class="el" href="a00190_source.html">numbers.h</a>.</p>
</div>
</div>
<a class="anchor" id="a06645ac4f8c1ee4f7bca35d12ca3603a"></a><!-- doxytag: member="Number::operator++" ref="a06645ac4f8c1ee4f7bca35d12ca3603a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Number::operator++ </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Increment the number object. </p>
<p>This rewrites the string buffer. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>new value of number object. </dd></dl>
</div>
</div>
<a class="anchor" id="af9b0418813283ecf46785ea0c491bff3"></a><!-- doxytag: member="Number::operator+=" ref="af9b0418813283ecf46785ea0c491bff3" args="(const long value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Number::operator+= </td>
<td>(</td>
<td class="paramtype">const long </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a value to the number. </p>
<p>This rewrites the string buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>to add. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>new value of number object. </dd></dl>
</div>
</div>
<a class="anchor" id="a54d614a0e5fe4fafe94a487dc83631e1"></a><!-- doxytag: member="Number::operator--" ref="a54d614a0e5fe4fafe94a487dc83631e1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Number::operator-- </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decrement the number object. </p>
<p>This rewrites the string buffer. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>new value of number object. </dd></dl>
</div>
</div>
<a class="anchor" id="adf1b40b7137f6fe59a31ac81f1d861b1"></a><!-- doxytag: member="Number::operator-=" ref="adf1b40b7137f6fe59a31ac81f1d861b1" args="(const long value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Number::operator-= </td>
<td>(</td>
<td class="paramtype">const long </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subtract a value from the number. </p>
<p>This rewrites the string buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>to subtract. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>new value of number object. </dd></dl>
</div>
</div>
<a class="anchor" id="a59e85c16e5346ecde875215ae79d6a86"></a><!-- doxytag: member="Number::operator=" ref="a59e85c16e5346ecde875215ae79d6a86" args="(const Number &number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Number::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00090.html">Number</a> & </td>
<td class="paramname"><em>number</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign another number to this number. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">number</td><td>to assign to assign. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>new value of number object assigned. </dd></dl>
</div>
</div>
<a class="anchor" id="a82ff3455b84d7ce800e572aa6f75cfbd"></a><!-- doxytag: member="Number::operator=" ref="a82ff3455b84d7ce800e572aa6f75cfbd" args="(long value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Number::operator= </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign a value to the number. </p>
<p>This rewrites the string buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>to assign. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>new value of number object assigned. </dd></dl>
<p>Reimplemented in <a class="el" href="a00175.html#ab4e4946ac1890db7e213f114202626ec">ZNumber</a>.</p>
</div>
</div>
<a class="anchor" id="a76a2bc4ddeee5ee50787d83de4356d59"></a><!-- doxytag: member="Number::set" ref="a76a2bc4ddeee5ee50787d83de4356d59" args="(long value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Number::set </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set string based on a new value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>to set. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="a00175.html#ae0ffafc6e881d643436942779c2d4450">ZNumber</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00190_source.html">numbers.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00090.html">Number</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:48 for ucommon by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
