Files
rippled/classripple_1_1AmendmentSet.html
2021-03-12 22:34:28 +00:00

343 lines
18 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::AmendmentSet 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_1AmendmentSet.html">AmendmentSet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1AmendmentSet-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::AmendmentSet Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The status of all amendments requested in a given window.
<a href="classripple_1_1AmendmentSet.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::AmendmentSet:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1AmendmentSet__coll__graph.png" border="0" usemap="#ripple_1_1AmendmentSet_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1AmendmentSet_coll__map" id="ripple_1_1AmendmentSet_coll__map">
<area shape="rect" title="The status of all amendments requested in a given window." alt="" coords="1783,49,1951,76"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="943,5,1095,61"/>
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32&#45;bits." alt="" coords="487,139,628,181"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/unordered_set.html" title=" " alt="" coords="712,212,919,268"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/unordered_set.html" title=" " alt="" coords="741,132,890,188"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,109,389,150"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,116,108,143"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,176,349,203"/>
<area shape="rect" href="classripple_1_1Rules.html" title="Rules controlling protocol behavior." alt="" coords="1588,79,1691,105"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1328,93,1499,134"/>
<area shape="rect" href="classripple_1_1Rules_1_1Impl.html" title=" " alt="" coords="1119,140,1257,167"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="738,66,893,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:a7331b983280faf8428744b1b566f6008"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AmendmentSet.html#a7331b983280faf8428744b1b566f6008">AmendmentSet</a> (<a class="el" href="classripple_1_1Rules.html">Rules</a> const &amp;rules, <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;valSet)</td></tr>
<tr class="separator:a7331b983280faf8428744b1b566f6008"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a784480b9d6fe68e8945fb9378728f534"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AmendmentSet.html#a784480b9d6fe68e8945fb9378728f534">passes</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;amendment) const</td></tr>
<tr class="separator:a784480b9d6fe68e8945fb9378728f534"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0013b2363b5bb424e124cf0af9997380"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AmendmentSet.html#a0013b2363b5bb424e124cf0af9997380">votes</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;amendment) const</td></tr>
<tr class="separator:a0013b2363b5bb424e124cf0af9997380"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d6b63ea4b09a0b012667c79aff07528"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AmendmentSet.html#a6d6b63ea4b09a0b012667c79aff07528">trustedValidations</a> () const</td></tr>
<tr class="separator:a6d6b63ea4b09a0b012667c79aff07528"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0d9edcc31c8b0fe5a90da0e35e09dc5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AmendmentSet.html#ac0d9edcc31c8b0fe5a90da0e35e09dc5">threshold</a> () const</td></tr>
<tr class="separator:ac0d9edcc31c8b0fe5a90da0e35e09dc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a79279c956c686b8ae4f497eaa8511839"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a46c521271235f4e2715d7fa8b68940ca">hash_map</a>&lt; <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a>, int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AmendmentSet.html#a79279c956c686b8ae4f497eaa8511839">votes_</a></td></tr>
<tr class="separator:a79279c956c686b8ae4f497eaa8511839"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f1040cb22455e44304a0ec2d0b8d8ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Rules.html">Rules</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AmendmentSet.html#a8f1040cb22455e44304a0ec2d0b8d8ed">rules_</a></td></tr>
<tr class="separator:a8f1040cb22455e44304a0ec2d0b8d8ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08f7a2888e1f8767713d045a114975c9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AmendmentSet.html#a08f7a2888e1f8767713d045a114975c9">trustedValidations_</a> = 0</td></tr>
<tr class="separator:a08f7a2888e1f8767713d045a114975c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8918c8eb31f69d5298b0ea8af6cb0982"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AmendmentSet.html#a8918c8eb31f69d5298b0ea8af6cb0982">threshold_</a> = 0</td></tr>
<tr class="separator:a8918c8eb31f69d5298b0ea8af6cb0982"><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>The status of all amendments requested in a given window. </p>
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00096">96</a> of file <a class="el" href="AmendmentTable_8cpp_source.html">AmendmentTable.cpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7331b983280faf8428744b1b566f6008"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7331b983280faf8428744b1b566f6008">&#9670;&nbsp;</a></span>AmendmentSet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::AmendmentSet::AmendmentSet </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="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>valSet</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00108">108</a> of file <a class="el" href="AmendmentTable_8cpp_source.html">AmendmentTable.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a784480b9d6fe68e8945fb9378728f534"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a784480b9d6fe68e8945fb9378728f534">&#9670;&nbsp;</a></span>passes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::AmendmentSet::passes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;&#160;</td>
<td class="paramname"><em>amendment</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00147">147</a> of file <a class="el" href="AmendmentTable_8cpp_source.html">AmendmentTable.cpp</a>.</p>
</div>
</div>
<a id="a0013b2363b5bb424e124cf0af9997380"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0013b2363b5bb424e124cf0af9997380">&#9670;&nbsp;</a></span>votes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ripple::AmendmentSet::votes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;&#160;</td>
<td class="paramname"><em>amendment</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00167">167</a> of file <a class="el" href="AmendmentTable_8cpp_source.html">AmendmentTable.cpp</a>.</p>
</div>
</div>
<a id="a6d6b63ea4b09a0b012667c79aff07528"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d6b63ea4b09a0b012667c79aff07528">&#9670;&nbsp;</a></span>trustedValidations()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ripple::AmendmentSet::trustedValidations </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00178">178</a> of file <a class="el" href="AmendmentTable_8cpp_source.html">AmendmentTable.cpp</a>.</p>
</div>
</div>
<a id="ac0d9edcc31c8b0fe5a90da0e35e09dc5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0d9edcc31c8b0fe5a90da0e35e09dc5">&#9670;&nbsp;</a></span>threshold()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ripple::AmendmentSet::threshold </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00184">184</a> of file <a class="el" href="AmendmentTable_8cpp_source.html">AmendmentTable.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a79279c956c686b8ae4f497eaa8511839"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79279c956c686b8ae4f497eaa8511839">&#9670;&nbsp;</a></span>votes_</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="namespaceripple.html#a46c521271235f4e2715d7fa8b68940ca">hash_map</a>&lt;<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a>, int&gt; ripple::AmendmentSet::votes_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00100">100</a> of file <a class="el" href="AmendmentTable_8cpp_source.html">AmendmentTable.cpp</a>.</p>
</div>
</div>
<a id="a8f1040cb22455e44304a0ec2d0b8d8ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f1040cb22455e44304a0ec2d0b8d8ed">&#9670;&nbsp;</a></span>rules_</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="classripple_1_1Rules.html">Rules</a> const&amp; ripple::AmendmentSet::rules_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00101">101</a> of file <a class="el" href="AmendmentTable_8cpp_source.html">AmendmentTable.cpp</a>.</p>
</div>
</div>
<a id="a08f7a2888e1f8767713d045a114975c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08f7a2888e1f8767713d045a114975c9">&#9670;&nbsp;</a></span>trustedValidations_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ripple::AmendmentSet::trustedValidations_ = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00103">103</a> of file <a class="el" href="AmendmentTable_8cpp_source.html">AmendmentTable.cpp</a>.</p>
</div>
</div>
<a id="a8918c8eb31f69d5298b0ea8af6cb0982"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8918c8eb31f69d5298b0ea8af6cb0982">&#9670;&nbsp;</a></span>threshold_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ripple::AmendmentSet::threshold_ = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00105">105</a> of file <a class="el" href="AmendmentTable_8cpp_source.html">AmendmentTable.cpp</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>