Files
rippled/classripple_1_1FeeVote.html
2023-03-28 16:07:03 +00:00

245 lines
12 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: ripple::FeeVote Class 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 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1FeeVote.html">FeeVote</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classripple_1_1FeeVote-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::FeeVote Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Manager to process fee votes.
<a href="classripple_1_1FeeVote.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for ripple::FeeVote:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1FeeVote__inherit__graph.png" border="0" usemap="#ripple_1_1FeeVote_inherit__map" alt="Inheritance graph"/></div>
<map name="ripple_1_1FeeVote_inherit__map" id="ripple_1_1FeeVote_inherit__map">
<area shape="rect" title="Manager to process fee votes." alt="" coords="19,5,138,32"/>
<area shape="rect" href="classripple_1_1FeeVoteImpl.html" title=" " alt="" coords="5,80,152,107"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5261d52f9ef186c07a98cdfc2c73a590"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1FeeVote.html#a5261d52f9ef186c07a98cdfc2c73a590">~FeeVote</a> ()=default</td></tr>
<tr class="separator:a5261d52f9ef186c07a98cdfc2c73a590"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fc2834bb93eb35138b36f9b7a29f954"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1FeeVote.html#a8fc2834bb93eb35138b36f9b7a29f954">doValidation</a> (<a class="el" href="structripple_1_1Fees.html">Fees</a> const &amp;lastFees, <a class="el" href="classripple_1_1Rules.html">Rules</a> const &amp;rules, <a class="el" href="classripple_1_1STValidation.html">STValidation</a> &amp;val)=0</td></tr>
<tr class="memdesc:a8fc2834bb93eb35138b36f9b7a29f954"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add local fee preference to validation. <a href="classripple_1_1FeeVote.html#a8fc2834bb93eb35138b36f9b7a29f954">More...</a><br /></td></tr>
<tr class="separator:a8fc2834bb93eb35138b36f9b7a29f954"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0891027717d974092b4a708b3cb03acc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1FeeVote.html#a0891027717d974092b4a708b3cb03acc">doVoting</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &gt; const &amp;lastClosedLedger, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1STValidation.html">STValidation</a> &gt;&gt; const &amp;parentValidations, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1SHAMap.html">SHAMap</a> &gt; const &amp;initialPosition)=0</td></tr>
<tr class="memdesc:a0891027717d974092b4a708b3cb03acc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cast our local vote on the fee. <a href="classripple_1_1FeeVote.html#a0891027717d974092b4a708b3cb03acc">More...</a><br /></td></tr>
<tr class="separator:a0891027717d974092b4a708b3cb03acc"><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>Manager to process fee votes. </p>
<p class="definition">Definition at line <a class="el" href="FeeVote_8h_source.html#l00032">32</a> of file <a class="el" href="FeeVote_8h_source.html">FeeVote.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5261d52f9ef186c07a98cdfc2c73a590"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5261d52f9ef186c07a98cdfc2c73a590">&#9670;&nbsp;</a></span>~FeeVote()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::FeeVote::~FeeVote </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8fc2834bb93eb35138b36f9b7a29f954"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fc2834bb93eb35138b36f9b7a29f954">&#9670;&nbsp;</a></span>doValidation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::FeeVote::doValidation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1Fees.html">Fees</a> const &amp;&#160;</td>
<td class="paramname"><em>lastFees</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1Rules.html">Rules</a> const &amp;&#160;</td>
<td class="paramname"><em>rules</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1STValidation.html">STValidation</a> &amp;&#160;</td>
<td class="paramname"><em>val</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add local fee preference to validation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lastClosedLedger</td><td></td></tr>
<tr><td class="paramname">baseValidation</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classripple_1_1FeeVoteImpl.html#a095335a98bfd73cd42e017accbc700fa">ripple::FeeVoteImpl</a>.</p>
</div>
</div>
<a id="a0891027717d974092b4a708b3cb03acc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0891027717d974092b4a708b3cb03acc">&#9670;&nbsp;</a></span>doVoting()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::FeeVote::doVoting </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &gt; const &amp;&#160;</td>
<td class="paramname"><em>lastClosedLedger</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1STValidation.html">STValidation</a> &gt;&gt; const &amp;&#160;</td>
<td class="paramname"><em>parentValidations</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1SHAMap.html">SHAMap</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>initialPosition</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Cast our local vote on the fee. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lastClosedLedger</td><td></td></tr>
<tr><td class="paramname">initialPosition</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classripple_1_1FeeVoteImpl.html#ad264dda6949150323ec3360ef094ecc5">ripple::FeeVoteImpl</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- 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>