ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/structripple_1_1AmendmentState.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

231 lines
12 KiB
HTML
Raw Permalink Blame History

<!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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::AmendmentState 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.8 -->
<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_1AmendmentState.html">AmendmentState</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_1AmendmentState-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::AmendmentState Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Current state of an amendment.
<a href="structripple_1_1AmendmentState.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::AmendmentState:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1AmendmentState__coll__graph.png" border="0" usemap="#aripple_1_1AmendmentState_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1AmendmentState_coll__map" id="aripple_1_1AmendmentState_coll__map">
<area shape="rect" title="Current state of an amendment." alt="" coords="5,183,187,208"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="53,95,139,120"/>
<area shape="poly" title=" " alt="" coords="99,134,99,182,93,182,93,134"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="27,5,165,45"/>
<area shape="poly" title=" " alt="" coords="99,59,99,94,93,94,93,59"/>
</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:ae51fd7660d8d88e63430777f10cae97e" id="r_ae51fd7660d8d88e63430777f10cae97e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1AmendmentState.html#ae51fd7660d8d88e63430777f10cae97e">AmendmentState</a> ()=default</td></tr>
<tr class="separator:ae51fd7660d8d88e63430777f10cae97e"><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:aded5fcee7705f5497086749ea0aea289" id="r_aded5fcee7705f5497086749ea0aea289"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a1dcb4cf27e683bd94d11f5322836c689">AmendmentVote</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1AmendmentState.html#aded5fcee7705f5497086749ea0aea289">vote</a> = <a class="el" href="namespaceripple.html#a1dcb4cf27e683bd94d11f5322836c689a74e8333ad11685ff3bdae589c8f6e34d">AmendmentVote::down</a></td></tr>
<tr class="memdesc:aded5fcee7705f5497086749ea0aea289"><td class="mdescLeft">&#160;</td><td class="mdescRight">If an amendment is down-voted, a server will not vote to enable it. <br /></td></tr>
<tr class="separator:aded5fcee7705f5497086749ea0aea289"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39806570502aef287f7d682ed8292521" id="r_a39806570502aef287f7d682ed8292521"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1AmendmentState.html#a39806570502aef287f7d682ed8292521">enabled</a> = false</td></tr>
<tr class="memdesc:a39806570502aef287f7d682ed8292521"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates that the amendment has been enabled. <br /></td></tr>
<tr class="separator:a39806570502aef287f7d682ed8292521"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d39d31177436771b94c8fa48f5d67f4" id="r_a2d39d31177436771b94c8fa48f5d67f4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1AmendmentState.html#a2d39d31177436771b94c8fa48f5d67f4">supported</a> = false</td></tr>
<tr class="memdesc:a2d39d31177436771b94c8fa48f5d67f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates an amendment that this server has code support for. <br /></td></tr>
<tr class="separator:a2d39d31177436771b94c8fa48f5d67f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa277e358200e0a43605b34f901d6f6d7" id="r_aa277e358200e0a43605b34f901d6f6d7"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1AmendmentState.html#aa277e358200e0a43605b34f901d6f6d7">name</a></td></tr>
<tr class="memdesc:aa277e358200e0a43605b34f901d6f6d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of this amendment, possibly empty. <br /></td></tr>
<tr class="separator:aa277e358200e0a43605b34f901d6f6d7"><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>Current state of an amendment. </p>
<p>Tells if a amendment is supported, enabled or vetoed. A vetoed amendment means the node will never announce its support. </p>
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00273">273</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="ae51fd7660d8d88e63430777f10cae97e" name="ae51fd7660d8d88e63430777f10cae97e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae51fd7660d8d88e63430777f10cae97e">&#9670;&#160;</a></span>AmendmentState()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::AmendmentState::AmendmentState </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>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aded5fcee7705f5497086749ea0aea289" name="aded5fcee7705f5497086749ea0aea289"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aded5fcee7705f5497086749ea0aea289">&#9670;&#160;</a></span>vote</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a1dcb4cf27e683bd94d11f5322836c689">AmendmentVote</a> ripple::AmendmentState::vote = <a class="el" href="namespaceripple.html#a1dcb4cf27e683bd94d11f5322836c689a74e8333ad11685ff3bdae589c8f6e34d">AmendmentVote::down</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>If an amendment is down-voted, a server will not vote to enable it. </p>
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00276">276</a> of file <a class="el" href="AmendmentTable_8cpp_source.html">AmendmentTable.cpp</a>.</p>
</div>
</div>
<a id="a39806570502aef287f7d682ed8292521" name="a39806570502aef287f7d682ed8292521"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39806570502aef287f7d682ed8292521">&#9670;&#160;</a></span>enabled</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::AmendmentState::enabled = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates that the amendment has been enabled. </p>
<p>This is a one-way switch: once an amendment is enabled it can never be disabled, but it can be superseded by a subsequent amendment. </p>
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00283">283</a> of file <a class="el" href="AmendmentTable_8cpp_source.html">AmendmentTable.cpp</a>.</p>
</div>
</div>
<a id="a2d39d31177436771b94c8fa48f5d67f4" name="a2d39d31177436771b94c8fa48f5d67f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d39d31177436771b94c8fa48f5d67f4">&#9670;&#160;</a></span>supported</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::AmendmentState::supported = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates an amendment that this server has code support for. </p>
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00286">286</a> of file <a class="el" href="AmendmentTable_8cpp_source.html">AmendmentTable.cpp</a>.</p>
</div>
</div>
<a id="aa277e358200e0a43605b34f901d6f6d7" name="aa277e358200e0a43605b34f901d6f6d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa277e358200e0a43605b34f901d6f6d7">&#9670;&#160;</a></span>name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::AmendmentState::name</td>
</tr>
</table>
</div><div class="memdoc">
<p>The name of this amendment, possibly empty. </p>
<p class="definition">Definition at line <a class="el" href="AmendmentTable_8cpp_source.html#l00289">289</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="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink