Files
rippled/structripple_1_1Fees.html
2025-01-21 19:58:08 +00:00

287 lines
14 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::Fees Struct Reference</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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="structripple_1_1Fees.html">Fees</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1Fees-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::Fees Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Reflects the fee settings for a particular ledger.
<a href="structripple_1_1Fees.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="protocol_2Fees_8h_source.html">Fees.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::Fees:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1Fees__coll__graph.png" border="0" usemap="#aripple_1_1Fees_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1Fees_coll__map" id="aripple_1_1Fees_coll__map">
<area shape="rect" title="Reflects the fee settings for a particular ledger." alt="" coords="584,127,681,153"/>
<area shape="rect" href="classripple_1_1XRPAmount.html" title=" " alt="" coords="327,127,469,153"/>
<area shape="rect" title=" " alt="" coords="35,5,201,45"/>
<area shape="rect" title=" " alt="" coords="5,70,231,95"/>
<area shape="rect" title=" " alt="" coords="13,120,223,160"/>
<area shape="rect" title=" " alt="" coords="11,184,225,224"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="71,249,165,274"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab08271e72339f96f52b80be7a3511e43"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Fees.html#ab08271e72339f96f52b80be7a3511e43">Fees</a> ()=default</td></tr>
<tr class="separator:ab08271e72339f96f52b80be7a3511e43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3743caf59342d540e78e232e5cb741b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Fees.html#a3743caf59342d540e78e232e5cb741b7">Fees</a> (<a class="el" href="structripple_1_1Fees.html">Fees</a> const &amp;)=default</td></tr>
<tr class="separator:a3743caf59342d540e78e232e5cb741b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23eafcd95a1204222e3e48a77822a942"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1Fees.html">Fees</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Fees.html#a23eafcd95a1204222e3e48a77822a942">operator=</a> (<a class="el" href="structripple_1_1Fees.html">Fees</a> const &amp;)=default</td></tr>
<tr class="separator:a23eafcd95a1204222e3e48a77822a942"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb07843d0d0e3ccacd7cf51d5296fe40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Fees.html#acb07843d0d0e3ccacd7cf51d5296fe40">accountReserve</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ownerCount) const</td></tr>
<tr class="memdesc:acb07843d0d0e3ccacd7cf51d5296fe40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the account reserve given the owner count, in drops. <a href="structripple_1_1Fees.html#acb07843d0d0e3ccacd7cf51d5296fe40">More...</a><br /></td></tr>
<tr class="separator:acb07843d0d0e3ccacd7cf51d5296fe40"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a64c9587f977c872e926a58401d7d8224"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Fees.html#a64c9587f977c872e926a58401d7d8224">base</a> {0}</td></tr>
<tr class="separator:a64c9587f977c872e926a58401d7d8224"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75648591a2d5bc9e670f1f4081bfdfe0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Fees.html#a75648591a2d5bc9e670f1f4081bfdfe0">reserve</a> {0}</td></tr>
<tr class="separator:a75648591a2d5bc9e670f1f4081bfdfe0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d48ec23cfbe4eacac46fbfaa8ce67f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Fees.html#a6d48ec23cfbe4eacac46fbfaa8ce67f9">increment</a> {0}</td></tr>
<tr class="separator:a6d48ec23cfbe4eacac46fbfaa8ce67f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Reflects the fee settings for a particular ledger. </p>
<p >The fees are always the same for any transactions applied to a ledger. Changes to fees occur in between ledgers. </p>
<p class="definition">Definition at line <a class="el" href="protocol_2Fees_8h_source.html#l00032">32</a> of file <a class="el" href="protocol_2Fees_8h_source.html">protocol/Fees.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab08271e72339f96f52b80be7a3511e43" name="ab08271e72339f96f52b80be7a3511e43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab08271e72339f96f52b80be7a3511e43">&#9670;&#160;</a></span>Fees() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::Fees::Fees </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3743caf59342d540e78e232e5cb741b7" name="a3743caf59342d540e78e232e5cb741b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3743caf59342d540e78e232e5cb741b7">&#9670;&#160;</a></span>Fees() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::Fees::Fees </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1Fees.html">Fees</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a23eafcd95a1204222e3e48a77822a942" name="a23eafcd95a1204222e3e48a77822a942"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23eafcd95a1204222e3e48a77822a942">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structripple_1_1Fees.html">Fees</a> &amp; ripple::Fees::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1Fees.html">Fees</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acb07843d0d0e3ccacd7cf51d5296fe40" name="acb07843d0d0e3ccacd7cf51d5296fe40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb07843d0d0e3ccacd7cf51d5296fe40">&#9670;&#160;</a></span>accountReserve()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> ripple::Fees::accountReserve </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>ownerCount</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the account reserve given the owner count, in drops. </p>
<p >The reserve is calculated as the reserve base plus the reserve increment times the number of increments. </p>
<p class="definition">Definition at line <a class="el" href="protocol_2Fees_8h_source.html#l00049">49</a> of file <a class="el" href="protocol_2Fees_8h_source.html">protocol/Fees.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a64c9587f977c872e926a58401d7d8224" name="a64c9587f977c872e926a58401d7d8224"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64c9587f977c872e926a58401d7d8224">&#9670;&#160;</a></span>base</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> ripple::Fees::base {0}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="protocol_2Fees_8h_source.html#l00034">34</a> of file <a class="el" href="protocol_2Fees_8h_source.html">protocol/Fees.h</a>.</p>
</div>
</div>
<a id="a75648591a2d5bc9e670f1f4081bfdfe0" name="a75648591a2d5bc9e670f1f4081bfdfe0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75648591a2d5bc9e670f1f4081bfdfe0">&#9670;&#160;</a></span>reserve</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> ripple::Fees::reserve {0}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="protocol_2Fees_8h_source.html#l00035">35</a> of file <a class="el" href="protocol_2Fees_8h_source.html">protocol/Fees.h</a>.</p>
</div>
</div>
<a id="a6d48ec23cfbe4eacac46fbfaa8ce67f9" name="a6d48ec23cfbe4eacac46fbfaa8ce67f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d48ec23cfbe4eacac46fbfaa8ce67f9">&#9670;&#160;</a></span>increment</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> ripple::Fees::increment {0}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="protocol_2Fees_8h_source.html#l00036">36</a> of file <a class="el" href="protocol_2Fees_8h_source.html">protocol/Fees.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>