Files
rippled/balance_8h_source.html
2022-03-31 17:56:44 +00:00

157 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: balance.h Source File</title>
<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>
<link href="doxygen.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">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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="dir_120ed4da3e3217b1e7fc0b4f48568e79.html">test</a></li><li class="navelem"><a class="el" href="dir_ffd09a46879067226d7ad9ce2abbf5ef.html">jtx</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">balance.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//==============================================================================</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef RIPPLE_TEST_JTX_BALANCE_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define RIPPLE_TEST_JTX_BALANCE_H_INCLUDED</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;test/jtx/Env.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;test/jtx/tags.h&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span>test {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">namespace </span>jtx {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1balance.html"> 38</a></span>&#160;<span class="keyword">class </span><a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html">balance</a></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;{</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1balance.html#a655f58f411f03d221dcb98243136130c"> 41</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#a655f58f411f03d221dcb98243136130c">none_</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1balance.html#a906bec3dc1f5a8ad4ede891a7512faad"> 42</a></span>&#160; <a class="code" href="classripple_1_1test_1_1jtx_1_1Account.html">Account</a> <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#a906bec3dc1f5a8ad4ede891a7512faad">account_</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1balance.html#aca742df7463cb4415cad2cd094320997"> 43</a></span>&#160; <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#aca742df7463cb4415cad2cd094320997">value_</a>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1balance.html#adef276d8325b753d728065c10b51558f"> 46</a></span>&#160; <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#adef276d8325b753d728065c10b51558f">balance</a>(<a class="code" href="classripple_1_1test_1_1jtx_1_1Account.html">Account</a> <span class="keyword">const</span>&amp; account, <a class="code" href="structripple_1_1test_1_1jtx_1_1none__t.html">none_t</a>)</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; : <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#a655f58f411f03d221dcb98243136130c">none_</a>(true), <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#a906bec3dc1f5a8ad4ede891a7512faad">account_</a>(account), <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#aca742df7463cb4415cad2cd094320997">value_</a>(<a class="code" href="namespaceripple_1_1test_1_1jtx.html#a37cf35ddf6bc8f4c6cbfa3fba57d6815">XRP</a>)</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1balance.html#adff78aafda96dbf83948cc5367260058"> 51</a></span>&#160; <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#adff78aafda96dbf83948cc5367260058">balance</a>(<a class="code" href="classripple_1_1test_1_1jtx_1_1Account.html">Account</a> <span class="keyword">const</span>&amp; account, <a class="code" href="structripple_1_1test_1_1jtx_1_1None.html">None</a> <span class="keyword">const</span>&amp; value)</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; : <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#a655f58f411f03d221dcb98243136130c">none_</a>(true), <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#a906bec3dc1f5a8ad4ede891a7512faad">account_</a>(account), <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#aca742df7463cb4415cad2cd094320997">value_</a>(value.issue)</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1balance.html#a0fe1598e3422047ca538105b063e524d"> 56</a></span>&#160; <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#a0fe1598e3422047ca538105b063e524d">balance</a>(<a class="code" href="classripple_1_1test_1_1jtx_1_1Account.html">Account</a> <span class="keyword">const</span>&amp; account, <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; value)</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; : <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#a655f58f411f03d221dcb98243136130c">none_</a>(false), <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#a906bec3dc1f5a8ad4ede891a7512faad">account_</a>(account), <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#aca742df7463cb4415cad2cd094320997">value_</a>(value)</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; {</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; }</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <a class="code" href="classripple_1_1test_1_1jtx_1_1balance.html#a82098d4596ab559c24736b9b6f976f03">operator()</a>(<a class="code" href="classripple_1_1test_1_1jtx_1_1Env.html">Env</a>&amp;) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;};</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;} <span class="comment">// namespace jtx</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;} <span class="comment">// namespace test</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_html_a37cf35ddf6bc8f4c6cbfa3fba57d6815"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx.html#a37cf35ddf6bc8f4c6cbfa3fba57d6815">ripple::test::jtx::XRP</a></div><div class="ttdeci">const XRP_t XRP</div><div class="ttdoc">Converts to XRP Issue or STAmount.</div><div class="ttdef"><b>Definition:</b> <a href="amount_8cpp_source.html#l00105">amount.cpp:105</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1balance_html_a0fe1598e3422047ca538105b063e524d"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1balance.html#a0fe1598e3422047ca538105b063e524d">ripple::test::jtx::balance::balance</a></div><div class="ttdeci">balance(Account const &amp;account, STAmount const &amp;value)</div><div class="ttdef"><b>Definition:</b> <a href="balance_8h_source.html#l00056">balance.h:56</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1balance_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1balance.html">ripple::test::jtx::balance</a></div><div class="ttdoc">A balance matches.</div><div class="ttdef"><b>Definition:</b> <a href="balance_8h_source.html#l00038">balance.h:38</a></div></div>
<div class="ttc" id="astructripple_1_1test_1_1jtx_1_1none__t_html"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1none__t.html">ripple::test::jtx::none_t</a></div><div class="ttdef"><b>Definition:</b> <a href="tags_8h_source.html#l00028">tags.h:28</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1balance_html_a655f58f411f03d221dcb98243136130c"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1balance.html#a655f58f411f03d221dcb98243136130c">ripple::test::jtx::balance::none_</a></div><div class="ttdeci">bool none_</div><div class="ttdef"><b>Definition:</b> <a href="balance_8h_source.html#l00041">balance.h:41</a></div></div>
<div class="ttc" id="aclassripple_1_1STAmount_html"><div class="ttname"><a href="classripple_1_1STAmount.html">ripple::STAmount</a></div><div class="ttdef"><b>Definition:</b> <a href="STAmount_8h_source.html#l00044">STAmount.h:44</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1balance_html_adff78aafda96dbf83948cc5367260058"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1balance.html#adff78aafda96dbf83948cc5367260058">ripple::test::jtx::balance::balance</a></div><div class="ttdeci">balance(Account const &amp;account, None const &amp;value)</div><div class="ttdef"><b>Definition:</b> <a href="balance_8h_source.html#l00051">balance.h:51</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1balance_html_a82098d4596ab559c24736b9b6f976f03"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1balance.html#a82098d4596ab559c24736b9b6f976f03">ripple::test::jtx::balance::operator()</a></div><div class="ttdeci">void operator()(Env &amp;) const</div><div class="ttdef"><b>Definition:</b> <a href="balance_8cpp_source.html#l00027">balance.cpp:27</a></div></div>
<div class="ttc" id="astructripple_1_1test_1_1jtx_1_1None_html"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1None.html">ripple::test::jtx::None</a></div><div class="ttdef"><b>Definition:</b> <a href="amount_8h_source.html#l00057">amount.h:57</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1balance_html_aca742df7463cb4415cad2cd094320997"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1balance.html#aca742df7463cb4415cad2cd094320997">ripple::test::jtx::balance::value_</a></div><div class="ttdeci">STAmount value_</div><div class="ttdef"><b>Definition:</b> <a href="balance_8h_source.html#l00043">balance.h:43</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1Account_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1Account.html">ripple::test::jtx::Account</a></div><div class="ttdoc">Immutable cryptographic account descriptor.</div><div class="ttdef"><b>Definition:</b> <a href="Account_8h_source.html#l00037">Account.h:37</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1balance_html_a906bec3dc1f5a8ad4ede891a7512faad"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1balance.html#a906bec3dc1f5a8ad4ede891a7512faad">ripple::test::jtx::balance::account_</a></div><div class="ttdeci">Account account_</div><div class="ttdef"><b>Definition:</b> <a href="balance_8h_source.html#l00042">balance.h:42</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1balance_html_adef276d8325b753d728065c10b51558f"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1balance.html#adef276d8325b753d728065c10b51558f">ripple::test::jtx::balance::balance</a></div><div class="ttdeci">balance(Account const &amp;account, none_t)</div><div class="ttdef"><b>Definition:</b> <a href="balance_8h_source.html#l00046">balance.h:46</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1Env_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1Env.html">ripple::test::jtx::Env</a></div><div class="ttdoc">A transaction testing environment.</div><div class="ttdef"><b>Definition:</b> <a href="Env_8h_source.html#l00116">Env.h:116</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>