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

276 lines
18 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::test::csf::LedgerHistoryHelper 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="namespaceripple_1_1test.html">test</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1test_1_1csf.html">csf</a></li><li class="navelem"><a class="el" href="structripple_1_1test_1_1csf_1_1LedgerHistoryHelper.html">LedgerHistoryHelper</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_1test_1_1csf_1_1LedgerHistoryHelper-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::test::csf::LedgerHistoryHelper Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Helper for writing unit tests with controlled ledger histories.
<a href="structripple_1_1test_1_1csf_1_1LedgerHistoryHelper.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ledgers_8h_source.html">ledgers.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::test::csf::LedgerHistoryHelper:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1test_1_1csf_1_1LedgerHistoryHelper__coll__graph.png" border="0" usemap="#aripple_1_1test_1_1csf_1_1LedgerHistoryHelper_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1test_1_1csf_1_1LedgerHistoryHelper_coll__map" id="aripple_1_1test_1_1csf_1_1LedgerHistoryHelper_coll__map">
<area shape="rect" title="Helper for writing unit tests with controlled ledger histories." alt="" coords="1948,81,2104,121"/>
<area shape="rect" href="classripple_1_1test_1_1csf_1_1LedgerOracle.html" title="Oracle maintaining unique ledgers for a simulation." alt="" coords="1707,5,1834,45"/>
<area shape="poly" title=" " alt="" coords="1848,40,1925,61,1975,79,1973,84,1923,67,1846,45"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="477,78,580,103"/>
<area shape="poly" title=" " alt="" coords="594,86,921,80,1772,80,1864,83,1948,90,1948,95,1863,89,1772,85,921,85,594,91"/>
<area shape="rect" href="classripple_1_1tagged__integer.html" title=" " alt="" coords="829,125,1016,165"/>
<area shape="poly" title=" " alt="" coords="594,97,716,113,829,129,828,135,716,119,593,102"/>
<area shape="rect" href="classripple_1_1tagged__integer.html" title=" " alt="" coords="835,332,1010,372"/>
<area shape="poly" title=" " alt="" coords="594,83,656,90,688,99,718,114,742,147,776,208,809,269,831,303,871,330,868,334,827,307,805,272,771,211,738,150,714,118,686,104,655,95,594,89"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="1695,121,1847,175"/>
<area shape="poly" title=" " alt="" coords="1860,129,1947,113,1948,118,1861,134"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="1475,135,1561,161"/>
<area shape="poly" title=" " alt="" coords="1575,145,1694,145,1694,151,1575,151"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="1205,128,1344,168"/>
<area shape="poly" title=" " alt="" coords="1358,145,1475,145,1475,151,1358,151"/>
<area shape="rect" href="classripple_1_1test_1_1csf_1_1Ledger.html" title="A ledger is a set of observed transactions and a sequence number identifying the ledger." alt="" coords="1455,251,1581,291"/>
<area shape="poly" title=" " alt="" coords="1572,242,1712,173,1715,178,1574,247"/>
<area shape="rect" href="structripple_1_1test_1_1csf_1_1Ledger_1_1Instance.html" title=" " alt="" coords="1210,251,1339,291"/>
<area shape="poly" title=" " alt="" coords="1354,268,1455,268,1455,273,1354,273"/>
<area shape="poly" title=" " alt="" coords="1030,152,1106,167,1182,194,1224,220,1256,249,1253,253,1220,224,1180,198,1105,172,1029,157"/>
<area shape="rect" title=" " alt="" coords="341,128,716,285"/>
<area shape="poly" title=" " alt="" coords="729,199,805,185,828,175,860,163,862,168,830,180,806,191,730,204"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/duration.html" title=" " alt="" coords="845,189,1001,229"/>
<area shape="poly" title=" " alt="" coords="1015,212,1096,221,1182,236,1223,248,1221,253,1181,241,1096,226,1014,217"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/time_point.html" title=" " alt="" coords="837,253,1009,293"/>
<area shape="poly" title=" " alt="" coords="1022,270,1210,268,1210,274,1022,275"/>
<area shape="poly" title=" " alt="" coords="1023,346,1175,336,1344,315,1454,288,1455,293,1344,320,1175,341,1024,352"/>
<area shape="poly" title=" " alt="" coords="1023,326,1209,283,1210,288,1024,331"/>
<area shape="rect" title=" " alt="" coords="347,309,710,467"/>
<area shape="poly" title=" " alt="" coords="723,368,835,357,835,363,724,373"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="851,397,994,437"/>
<area shape="poly" title=" " alt="" coords="1007,399,1093,376,1137,360,1180,340,1219,315,1251,289,1254,293,1222,320,1183,345,1139,364,1094,381,1009,404"/>
<area shape="rect" href="classripple_1_1tagged__integer.html" title="A type&#45;safe wrap around standard integral types." alt="" coords="446,491,611,531"/>
<area shape="poly" title=" " alt="" coords="624,494,715,476,860,435,862,440,717,481,625,499"/>
<area shape="rect" title=" " alt="" coords="5,439,292,582"/>
<area shape="poly" title=" " alt="" coords="306,508,446,508,446,513,306,513"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/set.html" title=" " alt="" coords="1707,199,1835,225"/>
<area shape="poly" title=" " alt="" coords="1827,192,1846,186,1921,152,1986,119,1989,124,1924,157,1848,190,1829,197"/>
</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:a7ef5b418cae8c2cc2938aae361a04733" id="r_a7ef5b418cae8c2cc2938aae361a04733"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1LedgerHistoryHelper.html#a7ef5b418cae8c2cc2938aae361a04733">LedgerHistoryHelper</a> ()</td></tr>
<tr class="separator:a7ef5b418cae8c2cc2938aae361a04733"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1273c816f2a0f172257f23fcfa0f0a2d" id="r_a1273c816f2a0f172257f23fcfa0f0a2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1test_1_1csf_1_1Ledger.html">Ledger</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1LedgerHistoryHelper.html#a1273c816f2a0f172257f23fcfa0f0a2d">operator[]</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;s)</td></tr>
<tr class="memdesc:a1273c816f2a0f172257f23fcfa0f0a2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get or create the ledger with the given string history. <br /></td></tr>
<tr class="separator:a1273c816f2a0f172257f23fcfa0f0a2d"><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:a19232cf258e58cf9103a5304572f8763" id="r_a19232cf258e58cf9103a5304572f8763"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1test_1_1csf_1_1LedgerOracle.html">LedgerOracle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1LedgerHistoryHelper.html#a19232cf258e58cf9103a5304572f8763">oracle</a></td></tr>
<tr class="separator:a19232cf258e58cf9103a5304572f8763"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a663259269bf0ff6fa4873fded850e4bd" id="r_a663259269bf0ff6fa4873fded850e4bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1test_1_1csf_1_1Tx.html#a59367f75f7072c9766aad91307f6dfed">Tx::ID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1LedgerHistoryHelper.html#a663259269bf0ff6fa4873fded850e4bd">nextTx</a> {0}</td></tr>
<tr class="separator:a663259269bf0ff6fa4873fded850e4bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa555f5bc1be372437144be4fa7f7b3b2" id="r_aa555f5bc1be372437144be4fa7f7b3b2"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/unordered_map.html">std::unordered_map</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>, <a class="el" href="classripple_1_1test_1_1csf_1_1Ledger.html">Ledger</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1LedgerHistoryHelper.html#aa555f5bc1be372437144be4fa7f7b3b2">ledgers</a></td></tr>
<tr class="separator:aa555f5bc1be372437144be4fa7f7b3b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dd272179e7a1612364a5928f8018af3" id="r_a0dd272179e7a1612364a5928f8018af3"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/set.html">std::set</a>&lt; char &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1LedgerHistoryHelper.html#a0dd272179e7a1612364a5928f8018af3">seen</a></td></tr>
<tr class="separator:a0dd272179e7a1612364a5928f8018af3"><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>Helper for writing unit tests with controlled ledger histories. </p>
<p>This class allows clients to refer to distinct ledgers as strings, where each character in the string indicates a unique ledger. It enforces the uniqueness at runtime, but this simplifies creation of alternate ledger histories, e.g.</p>
<p>HistoryHelper hh; hh["a"] hh["ab"] hh["ac"] hh["abd"]</p>
<p>Creates a history like b - d / a - c </p>
<p class="definition">Definition at line <a class="el" href="ledgers_8h_source.html#l00309">309</a> of file <a class="el" href="ledgers_8h_source.html">ledgers.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7ef5b418cae8c2cc2938aae361a04733" name="a7ef5b418cae8c2cc2938aae361a04733"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ef5b418cae8c2cc2938aae361a04733">&#9670;&#160;</a></span>LedgerHistoryHelper()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::test::csf::LedgerHistoryHelper::LedgerHistoryHelper </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ledgers_8h_source.html#l00316">316</a> of file <a class="el" href="ledgers_8h_source.html">ledgers.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1273c816f2a0f172257f23fcfa0f0a2d" name="a1273c816f2a0f172257f23fcfa0f0a2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1273c816f2a0f172257f23fcfa0f0a2d">&#9670;&#160;</a></span>operator[]()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1test_1_1csf_1_1Ledger.html">Ledger</a> const &amp; ripple::test::csf::LedgerHistoryHelper::operator[] </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get or create the ledger with the given string history. </p>
<p>Creates any necessary intermediate ledgers, but asserts if a letter is re-used (e.g. "abc" then "adc" would assert) </p>
<p class="definition">Definition at line <a class="el" href="ledgers_8h_source.html#l00327">327</a> of file <a class="el" href="ledgers_8h_source.html">ledgers.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a19232cf258e58cf9103a5304572f8763" name="a19232cf258e58cf9103a5304572f8763"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19232cf258e58cf9103a5304572f8763">&#9670;&#160;</a></span>oracle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1test_1_1csf_1_1LedgerOracle.html">LedgerOracle</a> ripple::test::csf::LedgerHistoryHelper::oracle</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ledgers_8h_source.html#l00311">311</a> of file <a class="el" href="ledgers_8h_source.html">ledgers.h</a>.</p>
</div>
</div>
<a id="a663259269bf0ff6fa4873fded850e4bd" name="a663259269bf0ff6fa4873fded850e4bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a663259269bf0ff6fa4873fded850e4bd">&#9670;&#160;</a></span>nextTx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1test_1_1csf_1_1Tx.html#a59367f75f7072c9766aad91307f6dfed">Tx::ID</a> ripple::test::csf::LedgerHistoryHelper::nextTx {0}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ledgers_8h_source.html#l00312">312</a> of file <a class="el" href="ledgers_8h_source.html">ledgers.h</a>.</p>
</div>
</div>
<a id="aa555f5bc1be372437144be4fa7f7b3b2" name="aa555f5bc1be372437144be4fa7f7b3b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa555f5bc1be372437144be4fa7f7b3b2">&#9670;&#160;</a></span>ledgers</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/unordered_map.html">std::unordered_map</a>&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>, <a class="el" href="classripple_1_1test_1_1csf_1_1Ledger.html">Ledger</a>&gt; ripple::test::csf::LedgerHistoryHelper::ledgers</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ledgers_8h_source.html#l00313">313</a> of file <a class="el" href="ledgers_8h_source.html">ledgers.h</a>.</p>
</div>
</div>
<a id="a0dd272179e7a1612364a5928f8018af3" name="a0dd272179e7a1612364a5928f8018af3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dd272179e7a1612364a5928f8018af3">&#9670;&#160;</a></span>seen</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/set.html">std::set</a>&lt;char&gt; ripple::test::csf::LedgerHistoryHelper::seen</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ledgers_8h_source.html#l00314">314</a> of file <a class="el" href="ledgers_8h_source.html">ledgers.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>
Reference in New Issue View Git Blame Copy Permalink