ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-27 22:45:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a84d06b17d69754eb8af364182d5865ac35a05bc
rippled/structripple_1_1test_1_1csf_1_1LedgerHistoryHelper.html
manojsdoshi 375f650549 deploy: 2913847925
2021-04-01 23:02:15 +00:00

248 lines
16 KiB
HTML
Raw 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">
<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::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 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="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>
<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="#ripple_1_1test_1_1csf_1_1LedgerHistoryHelper_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1test_1_1csf_1_1LedgerHistoryHelper_coll__map" id="ripple_1_1test_1_1csf_1_1LedgerHistoryHelper_coll__map">
<area shape="rect" title="Helper for writing unit tests with controlled ledger histories." alt="" coords="1937,513,2093,554"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="1684,415,1836,471"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="1464,429,1551,456"/>
<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="1444,363,1571,405"/>
<area shape="rect" href="classripple_1_1tagged__integer.html" title=" " alt="" coords="835,363,1010,405"/>
<area shape="rect" href="structripple_1_1test_1_1csf_1_1Ledger_1_1Instance.html" title=" " alt="" coords="1204,243,1333,285"/>
<area shape="rect" title=" " alt="" coords="347,305,710,463"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="477,488,580,515"/>
<area shape="rect" href="classripple_1_1tagged__integer.html" title=" " alt="" coords="829,210,1016,251"/>
<area shape="rect" title=" " alt="" coords="341,122,716,281"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="851,66,994,107"/>
<area shape="rect" href="classripple_1_1tagged__integer.html" title="A type&#45;safe wrap around standard integral types." alt="" coords="446,57,611,98"/>
<area shape="rect" title=" " alt="" coords="5,5,292,149"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/chrono/duration.html" title=" " alt="" coords="845,145,1001,186"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/chrono/time_point.html" title=" " alt="" coords="837,275,1009,317"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/set.html" title=" " alt="" coords="1696,545,1824,572"/>
<area shape="rect" href="classripple_1_1test_1_1csf_1_1LedgerOracle.html" title="Oracle maintaining unique ledgers for a simulation." alt="" coords="1697,597,1823,638"/>
</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: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:a5f899180abc8230a78d4a23fdcaa6770"><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#a5f899180abc8230a78d4a23fdcaa6770">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:a5f899180abc8230a78d4a23fdcaa6770"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get or create the ledger with the given string history. <a href="structripple_1_1test_1_1csf_1_1LedgerHistoryHelper.html#a5f899180abc8230a78d4a23fdcaa6770">More...</a><br /></td></tr>
<tr class="separator:a5f899180abc8230a78d4a23fdcaa6770"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem: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"><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"><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"><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#l00323">323</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ef5b418cae8c2cc2938aae361a04733">&#9670;&nbsp;</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#l00330">330</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="a5f899180abc8230a78d4a23fdcaa6770"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f899180abc8230a78d4a23fdcaa6770">&#9670;&nbsp;</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#l00341">341</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19232cf258e58cf9103a5304572f8763">&#9670;&nbsp;</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#l00325">325</a> of file <a class="el" href="ledgers_8h_source.html">ledgers.h</a>.</p>
</div>
</div>
<a id="a663259269bf0ff6fa4873fded850e4bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a663259269bf0ff6fa4873fded850e4bd">&#9670;&nbsp;</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#l00326">326</a> of file <a class="el" href="ledgers_8h_source.html">ledgers.h</a>.</p>
</div>
</div>
<a id="aa555f5bc1be372437144be4fa7f7b3b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa555f5bc1be372437144be4fa7f7b3b2">&#9670;&nbsp;</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#l00327">327</a> of file <a class="el" href="ledgers_8h_source.html">ledgers.h</a>.</p>
</div>
</div>
<a id="a0dd272179e7a1612364a5928f8018af3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dd272179e7a1612364a5928f8018af3">&#9670;&nbsp;</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#l00328">328</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="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink