<!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>Wt: Wt::Payment::Money Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Wt  <span id="projectnumber">3.2.3</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.5.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li> <li class="navelem"><a class="el" href="namespaceWt_1_1Payment.html">Payment</a> </li> <li class="navelem"><a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">Wt::Payment::Money Class Reference<div class="ingroups"><a class="el" href="group__payment.html">Payment module (Wt::Payment)</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="Wt::Payment::Money" --> <p>A value class which describes a monetary value. <a href="classWt_1_1Payment_1_1Money.html#details">More...</a></p> <p><code>#include <Wt/Payment/Money></code></p> <p><a href="classWt_1_1Payment_1_1Money-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#aa4fbef6a960bad5daa2e74c9d9627b88">Money</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#aa4fbef6a960bad5daa2e74c9d9627b88"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#a719ceadd8261cc1af06d34491ac4cedc">Money</a> (long long value, int cents, const std::string &currency)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a monetary value. <a href="#a719ceadd8261cc1af06d34491ac4cedc"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">long long </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#a98f400adb8a38c296a0c79c0c91ff3fe">value</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the int part of money. <a href="#a98f400adb8a38c296a0c79c0c91ff3fe"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#a5ba128e2a9f680a5e9cac11859f696e5">cents</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the cents. <a href="#a5ba128e2a9f680a5e9cac11859f696e5"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0f4f1fa6730fc63e874a5ad491013d9"></a><!-- doxytag: member="Wt::Payment::Money::setCurrency" ref="ab0f4f1fa6730fc63e874a5ad491013d9" args="(std::string currency)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#ab0f4f1fa6730fc63e874a5ad491013d9">setCurrency</a> (std::string currency)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the currency. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#a5b1e1204c2b19e16b7e346c92268b401">currency</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the currency. <a href="#a5b1e1204c2b19e16b7e346c92268b401"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#ab3652d03f8821168eca815f9ecdc8d25">toString</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a text representation. <a href="#ab3652d03f8821168eca815f9ecdc8d25"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17132712c06787f44b7439df6bfa8079"></a><!-- doxytag: member="Wt::Payment::Money::operator=" ref="a17132712c06787f44b7439df6bfa8079" args="(const Money &money)" --> <a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#a17132712c06787f44b7439df6bfa8079">operator=</a> (const <a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> &money)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#a81736f5d841b2647ec88de4f036bf223">operator+=</a> (const <a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> &money)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Addition operator. <a href="#a81736f5d841b2647ec88de4f036bf223"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#a0b50491a7de5f7075b323932170fb4f8">operator-=</a> (const <a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> &money)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Substraction operator. <a href="#a0b50491a7de5f7075b323932170fb4f8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3fd27a3260454ebbd87db6530640b1a"></a><!-- doxytag: member="Wt::Payment::Money::operator*=" ref="ab3fd27a3260454ebbd87db6530640b1a" args="(double value)" --> <a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#ab3fd27a3260454ebbd87db6530640b1a">operator*=</a> (double value)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Multiplication operator. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afaae5f4a55a0fa2d042d4ae84bc2b75c"></a><!-- doxytag: member="Wt::Payment::Money::operator/=" ref="afaae5f4a55a0fa2d042d4ae84bc2b75c" args="(double value)" --> <a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#afaae5f4a55a0fa2d042d4ae84bc2b75c">operator/=</a> (double value)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Division operator. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4427baae930b2f45c2a34dd150e2cf77"></a><!-- doxytag: member="Wt::Payment::Money::operator*=" ref="a4427baae930b2f45c2a34dd150e2cf77" args="(unsigned value)" --> <a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#a4427baae930b2f45c2a34dd150e2cf77">operator*=</a> (unsigned value)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Multiplication operator. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2e24a7f63633ec52619a6ccc096834e"></a><!-- doxytag: member="Wt::Payment::Money::operator/=" ref="af2e24a7f63633ec52619a6ccc096834e" args="(unsigned value)" --> <a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Money.html#af2e24a7f63633ec52619a6ccc096834e">operator/=</a> (unsigned value)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Division operator. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>A value class which describes a monetary value. </p> <p>The money is stored in cents as a 64-bit number, which allows for accurate representation for values up to 2^61 - 1, but has as consequence that division will round to the nearest cent.</p> <p>Math operations on monetary values of different currencies are not allowed and will result in exception. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aa4fbef6a960bad5daa2e74c9d9627b88"></a><!-- doxytag: member="Wt::Payment::Money::Money" ref="aa4fbef6a960bad5daa2e74c9d9627b88" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Wt::Payment::Money::Money </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Default constructor. </p> <p>Creates money represent 0 value. This value can be added or substracted safely from any other monetary value (unlike <a class="el" href="classWt_1_1Payment_1_1Money.html" title="A value class which describes a monetary value.">Money</a>(0, 0, "EUR") which would only be safely used in operations involving other money expressed in the Euro currency. </p> </div> </div> <a class="anchor" id="a719ceadd8261cc1af06d34491ac4cedc"></a><!-- doxytag: member="Wt::Payment::Money::Money" ref="a719ceadd8261cc1af06d34491ac4cedc" args="(long long value, int cents, const std::string &currency)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Wt::Payment::Money::Money </td> <td>(</td> <td class="paramtype">long long </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>cents</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>currency</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Creates a monetary value. </p> <p>The <code>value</code> is the integer value, <code>cents</code> is the fractional value (up to 2 digits) expressed in cents (0 - 100) and the <code>currency</code> is a string which indicates the currency. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a5ba128e2a9f680a5e9cac11859f696e5"></a><!-- doxytag: member="Wt::Payment::Money::cents" ref="a5ba128e2a9f680a5e9cac11859f696e5" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int Wt::Payment::Money::cents </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the cents. </p> <p>Returns the cents - the last 2 digits of value in cents. </p> </div> </div> <a class="anchor" id="a5b1e1204c2b19e16b7e346c92268b401"></a><!-- doxytag: member="Wt::Payment::Money::currency" ref="a5b1e1204c2b19e16b7e346c92268b401" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string Wt::Payment::Money::currency </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the currency. </p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1Money.html#ab0f4f1fa6730fc63e874a5ad491013d9" title="Sets the currency.">setCurrency()</a> </dd></dl> </div> </div> <a class="anchor" id="a81736f5d841b2647ec88de4f036bf223"></a><!-- doxytag: member="Wt::Payment::Money::operator+=" ref="a81736f5d841b2647ec88de4f036bf223" args="(const Money &money)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> & Wt::Payment::Money::operator+= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> & </td> <td class="paramname"><em>money</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Addition operator. </p> <p>Adding money of different currencies is not allowed. </p> </div> </div> <a class="anchor" id="a0b50491a7de5f7075b323932170fb4f8"></a><!-- doxytag: member="Wt::Payment::Money::operator-=" ref="a0b50491a7de5f7075b323932170fb4f8" args="(const Money &money)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> & Wt::Payment::Money::operator-= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> & </td> <td class="paramname"><em>money</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Substraction operator. </p> <p>Subtracting money of different currencies is not allowed. </p> </div> </div> <a class="anchor" id="ab3652d03f8821168eca815f9ecdc8d25"></a><!-- doxytag: member="Wt::Payment::Money::toString" ref="ab3652d03f8821168eca815f9ecdc8d25" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const std::string Wt::Payment::Money::toString </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns a text representation. </p> <p>The format is "value.cents". </p> </div> </div> <a class="anchor" id="a98f400adb8a38c296a0c79c0c91ff3fe"></a><!-- doxytag: member="Wt::Payment::Money::value" ref="a98f400adb8a38c296a0c79c0c91ff3fe" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">long long Wt::Payment::Money::value </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the int part of money. </p> <p>Returns the int part of money (money with no cents). </p> </div> </div> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></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> <hr size="1"><address style="text-align: right; margin: 3px"><small> Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the C++ Web Toolkit (Wt)</a> by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" border="0" style="vertical-align: middle; display: inline-block; height: 2em"></a> 1.7.5.1</small></address> </body> </html>