Files
rippled/classripple_1_1RCLCxLedger.html
2025-11-04 00:36:48 -08:00

540 lines
39 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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::RCLCxLedger 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 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="classripple_1_1RCLCxLedger.html">RCLCxLedger</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classripple_1_1RCLCxLedger-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::RCLCxLedger Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Represents a ledger in <a class="el" href="classripple_1_1RCLConsensus.html" title="Manages the generic consensus algorithm for use by the RCL.">RCLConsensus</a>.
<a href="classripple_1_1RCLCxLedger.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::RCLCxLedger:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1RCLCxLedger__coll__graph.png" border="0" usemap="#aripple_1_1RCLCxLedger_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1RCLCxLedger_coll__map" id="aripple_1_1RCLCxLedger_coll__map">
<area shape="rect" title="Represents a ledger in RCLConsensus." alt="" coords="2776,501,2929,526"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="2504,493,2675,533"/>
<area shape="poly" title=" " alt="" coords="2688,511,2776,511,2776,516,2688,516"/>
<area shape="rect" href="classripple_1_1Ledger.html" title="Holds a ledger." alt="" coords="2277,501,2388,526"/>
<area shape="poly" title=" " alt="" coords="2402,511,2504,511,2504,516,2402,516"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="1921,464,2086,504"/>
<area shape="poly" title=" " alt="" coords="2100,490,2277,506,2277,511,2100,495"/>
<area shape="rect" href="classripple_1_1DigestAwareReadView.html" title="ReadView that associates keys with digests." alt="" coords="1896,246,2111,271"/>
<area shape="poly" title=" " alt="" coords="2079,273,2112,286,2150,308,2186,335,2249,396,2296,455,2325,499,2321,502,2292,459,2245,400,2183,339,2147,312,2110,290,2077,278"/>
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="1618,119,1750,145"/>
<area shape="poly" title=" " alt="" coords="1722,149,1801,189,1897,229,1943,243,1942,248,1895,235,1799,194,1719,154"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1910,180,2097,220"/>
<area shape="poly" title=" " alt="" coords="1746,146,1815,163,1910,182,1909,187,1814,168,1744,151"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1915,53,2092,93"/>
<area shape="poly" title=" " alt="" coords="1763,115,1914,87,1915,92,1764,120"/>
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="2232,145,2433,170"/>
<area shape="poly" title=" " alt="" coords="2218,156,1750,137,1750,132,2218,150"/>
<area shape="poly" title=" " alt="" coords="2110,184,2234,167,2234,173,2111,189"/>
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="2235,18,2430,43"/>
<area shape="poly" title=" " alt="" coords="2221,24,2148,22,2066,23,1981,30,1897,44,1842,60,1789,81,1708,122,1706,117,1787,76,1840,55,1895,39,1980,25,2066,18,2148,17,2222,19"/>
<area shape="poly" title=" " alt="" coords="2106,57,2235,41,2235,46,2106,63"/>
<area shape="rect" href="classripple_1_1TxsRawView.html" title="Interface for changing ledger entries with transactions." alt="" coords="1928,365,2079,390"/>
<area shape="poly" title=" " alt="" coords="2093,387,2151,401,2209,422,2242,439,2273,460,2319,499,2316,503,2270,465,2239,444,2207,426,2150,406,2092,392"/>
<area shape="rect" href="classripple_1_1RawView.html" title="Interface for ledger entry changes." alt="" coords="1621,225,1747,250"/>
<area shape="poly" title=" " alt="" coords="1761,229,1790,231,1820,237,1849,248,1874,265,1883,275,1887,287,1887,309,1887,330,1890,340,1898,350,1912,361,1929,368,1927,373,1909,365,1894,354,1886,343,1882,331,1882,309,1882,288,1878,278,1870,269,1846,252,1819,242,1790,236,1761,234"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1922,300,2085,340"/>
<area shape="poly" title=" " alt="" coords="2089,342,2112,349,2162,366,2209,391,2245,418,2277,448,2323,499,2319,502,2273,452,2241,422,2207,396,2160,371,2110,355,2087,347"/>
<area shape="rect" href="classripple_1_1SHAMap.html" title="A SHAMap is both a radix tree with a fan&#45;out of 16 and a Merkle tree." alt="" coords="1942,414,2065,439"/>
<area shape="poly" title=" " alt="" coords="2074,440,2111,449,2288,498,2287,503,2110,455,2072,445"/>
<area shape="rect" href="classripple_1_1Family.html" title=" " alt="" coords="1629,274,1739,299"/>
<area shape="poly" title=" " alt="" coords="1753,279,1784,281,1816,287,1847,299,1874,317,1882,327,1887,338,1887,360,1887,380,1891,390,1898,399,1918,413,1942,421,1941,426,1916,418,1894,403,1886,393,1882,381,1882,360,1881,339,1878,330,1870,321,1844,303,1815,292,1783,286,1753,284"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1629,414,1739,439"/>
<area shape="poly" title=" " alt="" coords="1754,436,1792,450,1816,466,1845,490,1873,514,1897,528,1948,541,2002,549,2056,551,2109,550,2206,539,2282,524,2283,529,2207,544,2109,555,2056,557,2001,554,1947,547,1895,533,1870,518,1841,495,1813,470,1789,454,1752,441"/>
<area shape="poly" title=" " alt="" coords="1753,424,1942,424,1942,429,1753,429"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="1313,414,1459,439"/>
<area shape="poly" title=" " alt="" coords="1473,424,1628,424,1628,429,1473,429"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,507,108,533"/>
<area shape="poly" title=" " alt="" coords="64,493,84,444,116,383,137,353,161,324,189,298,220,278,288,251,373,234,472,224,583,221,704,224,832,232,1099,261,1364,300,1607,342,1946,411,1945,417,1606,348,1363,305,1098,266,832,238,704,229,583,226,472,229,374,239,289,256,223,282,192,302,165,327,141,356,120,386,89,446,69,495"/>
<area shape="rect" href="classripple_1_1SHAMapTreeNode.html" title=" " alt="" coords="1295,471,1477,497"/>
<area shape="poly" title=" " alt="" coords="122,518,447,516,924,501,1294,486,1294,491,924,507,447,521,122,523"/>
<area shape="rect" href="structripple_1_1IntrusiveRefCounts.html" title="Implement the strong count, weak count, and bit flags for an intrusive pointer." alt="" coords="563,421,753,446"/>
<area shape="poly" title=" " alt="" coords="95,499,131,485,176,474,221,467,402,446,562,435,563,440,403,452,222,472,177,479,133,491,97,504"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="231,482,437,507"/>
<area shape="poly" title=" " alt="" coords="121,511,230,501,231,507,122,517"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="250,583,418,623"/>
<area shape="poly" title=" " alt="" coords="81,540,105,560,133,576,191,593,250,600,249,606,190,598,131,581,102,564,78,544"/>
<area shape="rect" href="structripple_1_1LedgerHeader.html" title="Information about the notional ledger backing the view." alt="" coords="967,797,1125,822"/>
<area shape="poly" title=" " alt="" coords="74,543,98,580,132,625,174,670,223,707,269,732,317,754,418,788,522,810,626,823,726,828,818,827,966,817,967,823,819,833,726,833,625,828,521,815,416,793,315,759,266,737,220,712,170,674,128,628,94,583,70,546"/>
<area shape="rect" href="classripple_1_1SharedIntrusive.html" title=" " alt="" coords="1577,464,1791,504"/>
<area shape="poly" title=" " alt="" coords="1804,460,1941,435,1942,440,1805,465"/>
<area shape="poly" title=" " alt="" coords="1491,481,1577,481,1577,487,1491,487"/>
<area shape="poly" title=" " alt="" coords="767,433,999,442,1135,450,1271,463,1315,469,1315,474,1270,468,1135,456,999,447,767,438"/>
<area shape="poly" title=" " alt="" coords="451,479,538,464,616,444,617,449,539,469,452,484"/>
<area shape="rect" href="classripple_1_1SHAMapHash.html" title=" " alt="" coords="969,679,1123,705"/>
<area shape="poly" title=" " alt="" coords="1136,690,1205,677,1239,664,1269,646,1278,636,1282,626,1292,600,1335,541,1371,495,1375,499,1339,544,1297,603,1287,628,1283,639,1272,650,1241,669,1207,682,1137,695"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="587,637,729,677"/>
<area shape="poly" title=" " alt="" coords="743,653,828,656,919,663,995,677,994,682,918,668,828,661,743,659"/>
<area shape="poly" title=" " alt="" coords="698,683,736,707,778,727,817,736,850,736,882,738,920,752,933,766,944,779,978,794,976,799,941,783,929,770,917,757,881,743,849,742,816,741,776,732,733,711,696,688"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="290,673,378,698"/>
<area shape="poly" title=" " alt="" coords="384,700,457,715,498,717,538,712,584,696,624,675,626,680,586,701,539,717,498,722,457,720,383,705"/>
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32&#45;bits." alt="" coords="587,568,729,608"/>
<area shape="poly" title=" " alt="" coords="384,666,470,637,586,604,588,609,471,643,386,671"/>
<area shape="poly" title=" " alt="" coords="389,626,429,641,471,652,530,659,587,659,587,665,530,664,470,657,427,646,388,631"/>
<area shape="poly" title=" " alt="" coords="431,582,471,577,539,577,587,580,587,585,539,583,471,583,432,587"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title=" " alt="" coords="1957,821,2049,846"/>
<area shape="poly" title=" " alt="" coords="2064,841,2099,843,2136,840,2173,831,2206,814,2240,783,2266,745,2287,704,2303,661,2321,581,2328,526,2333,527,2327,582,2308,663,2292,706,2271,748,2244,786,2210,818,2175,836,2137,845,2099,848,2063,846"/>
<area shape="rect" href="structripple_1_1Fees.html" title="Reflects the fee settings for a particular ledger." alt="" coords="1173,937,1271,962"/>
<area shape="poly" title=" " alt="" coords="1283,933,1396,914,1461,907,1526,904,2005,904,2066,904,2115,899,2159,883,2206,847,2240,809,2267,765,2287,719,2303,671,2321,584,2328,526,2333,527,2327,585,2308,672,2292,720,2271,768,2244,812,2210,851,2162,888,2116,905,2066,909,2005,909,1526,909,1461,912,1396,919,1284,938"/>
<area shape="rect" href="classripple_1_1XRPAmount.html" title=" " alt="" coords="587,973,729,998"/>
<area shape="poly" title=" " alt="" coords="743,986,777,987,848,989,918,987,1057,972,1173,955,1174,960,1058,978,919,992,848,994,777,992,743,991"/>
<area shape="poly" title=" " alt="" coords="703,965,777,937,848,919,880,911,917,895,981,857,1028,820,1031,824,984,861,920,900,881,916,850,924,778,943,705,970"/>
<area shape="rect" title=" " alt="" coords="251,967,417,1007"/>
<area shape="poly" title=" " alt="" coords="431,984,586,983,586,988,431,989"/>
<area shape="rect" title=" " alt="" coords="221,1031,447,1057"/>
<area shape="poly" title=" " alt="" coords="418,1026,587,995,588,1001,419,1031"/>
<area shape="rect" title=" " alt="" coords="229,1081,439,1121"/>
<area shape="poly" title=" " alt="" coords="421,1075,446,1067,546,1029,626,996,628,1001,548,1034,448,1072,423,1080"/>
<area shape="rect" title=" " alt="" coords="227,852,441,892"/>
<area shape="poly" title=" " alt="" coords="416,893,447,903,540,931,631,970,629,975,538,936,446,908,414,898"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="287,917,381,942"/>
<area shape="poly" title=" " alt="" coords="395,937,587,970,586,976,394,942"/>
<area shape="rect" href="classripple_1_1Rules.html" title="Rules controlling protocol behavior." alt="" coords="1952,593,2055,618"/>
<area shape="poly" title=" " alt="" coords="2068,599,2136,590,2207,573,2264,550,2310,524,2313,528,2266,554,2209,579,2137,595,2069,604"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1599,592,1769,632"/>
<area shape="poly" title=" " alt="" coords="1783,607,1952,604,1952,609,1783,613"/>
<area shape="rect" href="classripple_1_1Rules_1_1Impl.html" title=" " alt="" coords="1316,614,1456,639"/>
<area shape="poly" title=" " alt="" coords="1470,620,1598,614,1599,619,1470,625"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_set.html" title=" " alt="" coords="943,522,1149,577"/>
<area shape="poly" title=" " alt="" coords="1163,573,1330,611,1328,616,1162,578"/>
<area shape="poly" title=" " alt="" coords="742,576,777,572,942,556,943,561,778,577,743,581"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_set.html" title=" " alt="" coords="971,601,1121,655"/>
<area shape="poly" title=" " alt="" coords="743,594,972,618,971,623,742,599"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="969,729,1123,769"/>
<area shape="poly" title=" " alt="" coords="1137,750,1204,743,1237,736,1270,724,1302,706,1331,682,1373,638,1377,641,1335,686,1305,710,1272,729,1239,741,1204,748,1137,755"/>
<area shape="poly" title=" " alt="" coords="1135,625,1316,624,1316,630,1135,630"/>
<area shape="poly" title=" " alt="" coords="1139,795,1256,785,1385,780,2005,780,2034,778,2063,771,2118,748,2168,714,2212,673,2251,629,2282,588,2322,525,2326,528,2287,591,2255,633,2216,677,2171,718,2120,753,2065,776,2035,783,2005,785,1385,785,1256,790,1139,801"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/time_point.html" title=" " alt="" coords="572,852,744,892"/>
<area shape="poly" title=" " alt="" coords="758,874,837,872,918,860,974,842,1021,820,1023,824,976,847,919,865,837,877,758,879"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/duration.html" title=" " alt="" coords="580,737,736,777"/>
<area shape="poly" title=" " alt="" coords="750,767,967,796,966,801,749,772"/>
</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-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a7bb654d6e2d8f3df2cf4bf5091a7d0eb" id="r_a7bb654d6e2d8f3df2cf4bf5091a7d0eb"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">ID</a> = <a class="el" href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">LedgerHash</a></td></tr>
<tr class="memdesc:a7bb654d6e2d8f3df2cf4bf5091a7d0eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique identifier of a ledger. <br /></td></tr>
<tr class="separator:a7bb654d6e2d8f3df2cf4bf5091a7d0eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaad5276a8dd4c15270ed5b847cf511cd" id="r_aaad5276a8dd4c15270ed5b847cf511cd"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#aaad5276a8dd4c15270ed5b847cf511cd">Seq</a> = <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a></td></tr>
<tr class="memdesc:aaad5276a8dd4c15270ed5b847cf511cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sequence number of a ledger. <br /></td></tr>
<tr class="separator:aaad5276a8dd4c15270ed5b847cf511cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a82a3ffad24861fae7168a5890e691ac3" id="r_a82a3ffad24861fae7168a5890e691ac3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a82a3ffad24861fae7168a5890e691ac3">RCLCxLedger</a> ()=default</td></tr>
<tr class="memdesc:a82a3ffad24861fae7168a5890e691ac3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a82a3ffad24861fae7168a5890e691ac3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a612799ae2590556cfacbf081a7a1b01d" id="r_a612799ae2590556cfacbf081a7a1b01d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a612799ae2590556cfacbf081a7a1b01d">RCLCxLedger</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_1Ledger.html">Ledger</a> const &gt; const &amp;l)</td></tr>
<tr class="memdesc:a612799ae2590556cfacbf081a7a1b01d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a612799ae2590556cfacbf081a7a1b01d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a318d581c9dc0d0ba14d3877ab93b7547" id="r_a318d581c9dc0d0ba14d3877ab93b7547"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1RCLCxLedger.html#aaad5276a8dd4c15270ed5b847cf511cd">Seq</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a318d581c9dc0d0ba14d3877ab93b7547">seq</a> () const</td></tr>
<tr class="memdesc:a318d581c9dc0d0ba14d3877ab93b7547"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sequence number of the ledger. <br /></td></tr>
<tr class="separator:a318d581c9dc0d0ba14d3877ab93b7547"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68fde18f10664613068897f012fb1314" id="r_a68fde18f10664613068897f012fb1314"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1RCLCxLedger.html#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">ID</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a68fde18f10664613068897f012fb1314">id</a> () const</td></tr>
<tr class="memdesc:a68fde18f10664613068897f012fb1314"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique identifier (hash) of this ledger. <br /></td></tr>
<tr class="separator:a68fde18f10664613068897f012fb1314"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2949aac07fe37e7cb3b056698077d40" id="r_ab2949aac07fe37e7cb3b056698077d40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1RCLCxLedger.html#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">ID</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#ab2949aac07fe37e7cb3b056698077d40">parentID</a> () const</td></tr>
<tr class="memdesc:ab2949aac07fe37e7cb3b056698077d40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique identifier (hash) of this ledger's parent. <br /></td></tr>
<tr class="separator:ab2949aac07fe37e7cb3b056698077d40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19f2fa230d7885111a6ef321a72558ac" id="r_a19f2fa230d7885111a6ef321a72558ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1NetClock.html#afe3767203cd971a00067671641bc7e16">NetClock::duration</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a19f2fa230d7885111a6ef321a72558ac">closeTimeResolution</a> () const</td></tr>
<tr class="memdesc:a19f2fa230d7885111a6ef321a72558ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolution used when calculating this ledger's close time. <br /></td></tr>
<tr class="separator:a19f2fa230d7885111a6ef321a72558ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae41ed9f6c557c46d64fbd398b2f35652" id="r_ae41ed9f6c557c46d64fbd398b2f35652"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#ae41ed9f6c557c46d64fbd398b2f35652">closeAgree</a> () const</td></tr>
<tr class="memdesc:ae41ed9f6c557c46d64fbd398b2f35652"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether consensus process agreed on close time of the ledger. <br /></td></tr>
<tr class="separator:ae41ed9f6c557c46d64fbd398b2f35652"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c31440ae6e0832e39f4acb30c3734dd" id="r_a8c31440ae6e0832e39f4acb30c3734dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a8c31440ae6e0832e39f4acb30c3734dd">closeTime</a> () const</td></tr>
<tr class="memdesc:a8c31440ae6e0832e39f4acb30c3734dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The close time of this ledger. <br /></td></tr>
<tr class="separator:a8c31440ae6e0832e39f4acb30c3734dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a563a6ec2d0c01b8ade4a47dc9b7c8b73" id="r_a563a6ec2d0c01b8ade4a47dc9b7c8b73"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a563a6ec2d0c01b8ade4a47dc9b7c8b73">parentCloseTime</a> () const</td></tr>
<tr class="memdesc:a563a6ec2d0c01b8ade4a47dc9b7c8b73"><td class="mdescLeft">&#160;</td><td class="mdescRight">The close time of this ledger's parent. <br /></td></tr>
<tr class="separator:a563a6ec2d0c01b8ade4a47dc9b7c8b73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad38a2e710238aef4c8c3ba64c229aee" id="r_aad38a2e710238aef4c8c3ba64c229aee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classJson_1_1Value.html">Json::Value</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#aad38a2e710238aef4c8c3ba64c229aee">getJson</a> () const</td></tr>
<tr class="memdesc:aad38a2e710238aef4c8c3ba64c229aee"><td class="mdescLeft">&#160;</td><td class="mdescRight">JSON representation of this ledger. <br /></td></tr>
<tr class="separator:aad38a2e710238aef4c8c3ba64c229aee"><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:a790fedb2406a5d248f2188da3c421dbc" id="r_a790fedb2406a5d248f2188da3c421dbc"><td class="memItemLeft" align="right" valign="top"><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_1Ledger.html">Ledger</a> const &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a790fedb2406a5d248f2188da3c421dbc">ledger_</a></td></tr>
<tr class="memdesc:a790fedb2406a5d248f2188da3c421dbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The ledger instance. <br /></td></tr>
<tr class="separator:a790fedb2406a5d248f2188da3c421dbc"><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>Represents a ledger in <a class="el" href="classripple_1_1RCLConsensus.html" title="Manages the generic consensus algorithm for use by the RCL.">RCLConsensus</a>. </p>
<p><a class="el" href="classripple_1_1RCLCxLedger.html" title="Represents a ledger in RCLConsensus.">RCLCxLedger</a> is a thin wrapper over <code><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_1Ledger.html" title="Holds a ledger.">Ledger</a> const&gt;</code>. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00016">16</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a7bb654d6e2d8f3df2cf4bf5091a7d0eb" name="a7bb654d6e2d8f3df2cf4bf5091a7d0eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">&#9670;&#160;</a></span>ID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1RCLCxLedger.html#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">ripple::RCLCxLedger::ID</a> = <a class="el" href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">LedgerHash</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unique identifier of a ledger. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00020">20</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
</div>
</div>
<a id="aaad5276a8dd4c15270ed5b847cf511cd" name="aaad5276a8dd4c15270ed5b847cf511cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaad5276a8dd4c15270ed5b847cf511cd">&#9670;&#160;</a></span>Seq</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1RCLCxLedger.html#aaad5276a8dd4c15270ed5b847cf511cd">ripple::RCLCxLedger::Seq</a> = <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sequence number of a ledger. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00022">22</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a82a3ffad24861fae7168a5890e691ac3" name="a82a3ffad24861fae7168a5890e691ac3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82a3ffad24861fae7168a5890e691ac3">&#9670;&#160;</a></span>RCLCxLedger() <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::RCLCxLedger::RCLCxLedger </td>
<td>(</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">
<p>Default constructor. </p>
<p>TODO: This may not be needed if we ensure <a class="el" href="classripple_1_1RCLConsensus.html" title="Manages the generic consensus algorithm for use by the RCL.">RCLConsensus</a> is handed a valid ledger in its constructor. Its bad now because other members are not checking whether the ledger is valid. </p>
</div>
</div>
<a id="a612799ae2590556cfacbf081a7a1b01d" name="a612799ae2590556cfacbf081a7a1b01d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a612799ae2590556cfacbf081a7a1b01d">&#9670;&#160;</a></span>RCLCxLedger() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::RCLCxLedger::RCLCxLedger </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_1Ledger.html">Ledger</a> const &gt; const &amp;&#160;</td>
<td class="paramname"><em>l</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">l</td><td>The ledger to wrap. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00036">36</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a318d581c9dc0d0ba14d3877ab93b7547" name="a318d581c9dc0d0ba14d3877ab93b7547"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a318d581c9dc0d0ba14d3877ab93b7547">&#9670;&#160;</a></span>seq()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1RCLCxLedger.html#aaad5276a8dd4c15270ed5b847cf511cd">Seq</a> const &amp; ripple::RCLCxLedger::seq </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sequence number of the ledger. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00042">42</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
</div>
</div>
<a id="a68fde18f10664613068897f012fb1314" name="a68fde18f10664613068897f012fb1314"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68fde18f10664613068897f012fb1314">&#9670;&#160;</a></span>id()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1RCLCxLedger.html#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">ID</a> const &amp; ripple::RCLCxLedger::id </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unique identifier (hash) of this ledger. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00049">49</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
</div>
</div>
<a id="ab2949aac07fe37e7cb3b056698077d40" name="ab2949aac07fe37e7cb3b056698077d40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2949aac07fe37e7cb3b056698077d40">&#9670;&#160;</a></span>parentID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1RCLCxLedger.html#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">ID</a> const &amp; ripple::RCLCxLedger::parentID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unique identifier (hash) of this ledger's parent. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00056">56</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
</div>
</div>
<a id="a19f2fa230d7885111a6ef321a72558ac" name="a19f2fa230d7885111a6ef321a72558ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19f2fa230d7885111a6ef321a72558ac">&#9670;&#160;</a></span>closeTimeResolution()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1NetClock.html#afe3767203cd971a00067671641bc7e16">NetClock::duration</a> ripple::RCLCxLedger::closeTimeResolution </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Resolution used when calculating this ledger's close time. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00063">63</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
</div>
</div>
<a id="ae41ed9f6c557c46d64fbd398b2f35652" name="ae41ed9f6c557c46d64fbd398b2f35652"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae41ed9f6c557c46d64fbd398b2f35652">&#9670;&#160;</a></span>closeAgree()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::RCLCxLedger::closeAgree </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether consensus process agreed on close time of the ledger. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00070">70</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
</div>
</div>
<a id="a8c31440ae6e0832e39f4acb30c3734dd" name="a8c31440ae6e0832e39f4acb30c3734dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c31440ae6e0832e39f4acb30c3734dd">&#9670;&#160;</a></span>closeTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a> ripple::RCLCxLedger::closeTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>The close time of this ledger. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00077">77</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
</div>
</div>
<a id="a563a6ec2d0c01b8ade4a47dc9b7c8b73" name="a563a6ec2d0c01b8ade4a47dc9b7c8b73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a563a6ec2d0c01b8ade4a47dc9b7c8b73">&#9670;&#160;</a></span>parentCloseTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a> ripple::RCLCxLedger::parentCloseTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>The close time of this ledger's parent. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00084">84</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
</div>
</div>
<a id="aad38a2e710238aef4c8c3ba64c229aee" name="aad38a2e710238aef4c8c3ba64c229aee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad38a2e710238aef4c8c3ba64c229aee">&#9670;&#160;</a></span>getJson()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classJson_1_1Value.html">Json::Value</a> ripple::RCLCxLedger::getJson </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>JSON representation of this ledger. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00091">91</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a790fedb2406a5d248f2188da3c421dbc" name="a790fedb2406a5d248f2188da3c421dbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a790fedb2406a5d248f2188da3c421dbc">&#9670;&#160;</a></span>ledger_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><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_1Ledger.html">Ledger</a> const&gt; ripple::RCLCxLedger::ledger_</td>
</tr>
</table>
</div><div class="memdoc">
<p>The ledger instance. </p>
<p>TODO: Make this shared_ptr&lt;ReadView const&gt; .. requires ability to create a new ledger from a readView? </p>
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00101">101</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.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.8
</small></address>
</body>
</html>