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
gh-pages
rippled/classripple_1_1BookTip.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

571 lines
33 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::BookTip 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_1BookTip.html">BookTip</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_1BookTip-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::BookTip Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Iterates and consumes raw offers in an order book.
<a href="classripple_1_1BookTip.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="BookTip_8h_source.html">BookTip.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::BookTip:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1BookTip__coll__graph.png" border="0" usemap="#aripple_1_1BookTip_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1BookTip_coll__map" id="aripple_1_1BookTip_coll__map">
<area shape="rect" title="Iterates and consumes raw offers in an order book." alt="" coords="2450,317,2570,342"/>
<area shape="rect" href="classripple_1_1ApplyView.html" title="Writeable view to a ledger, for applying a transaction." alt="" coords="2141,259,2277,285"/>
<area shape="poly" title=" " alt="" coords="2290,285,2450,315,2449,321,2289,290"/>
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="1864,134,1996,159"/>
<area shape="poly" title=" " alt="" coords="1965,165,2033,204,2117,244,2155,257,2153,262,2115,249,2031,209,1962,169"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="2116,5,2303,45"/>
<area shape="poly" title=" " alt="" coords="1952,122,1988,91,2033,63,2074,47,2115,36,2117,41,2075,52,2036,68,1992,95,1956,126"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="2121,195,2298,235"/>
<area shape="poly" title=" " alt="" coords="1981,161,2035,177,2121,197,2120,202,2034,183,1980,166"/>
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="2409,49,2611,74"/>
<area shape="poly" title=" " alt="" coords="2410,79,1997,140,1996,134,2409,73"/>
<area shape="poly" title=" " alt="" coords="2317,35,2409,47,2409,52,2316,41"/>
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="2413,159,2607,185"/>
<area shape="poly" title=" " alt="" coords="2399,170,1996,152,1997,147,2399,165"/>
<area shape="poly" title=" " alt="" coords="2311,198,2419,182,2420,187,2312,203"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="1615,380,1756,420"/>
<area shape="poly" title=" " alt="" coords="1770,397,1920,393,2092,384,2197,373,2302,359,2449,336,2450,342,2303,364,2198,379,2092,389,1920,398,1770,402"/>
<area shape="rect" href="classripple_1_1STLedgerEntry.html" title=" " alt="" coords="1849,301,2011,326"/>
<area shape="poly" title=" " alt="" coords="1755,373,1892,324,1894,329,1757,378"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="833,251,921,277"/>
<area shape="poly" title=" " alt="" coords="934,278,956,285,1012,309,1070,328,1221,357,1372,377,1508,389,1615,395,1614,400,1508,394,1371,382,1220,363,1069,333,1011,314,954,291,932,283"/>
<area shape="rect" href="classripple_1_1detail_1_1STVar.html" title=" " alt="" coords="1069,189,1219,214"/>
<area shape="poly" title=" " alt="" coords="934,249,1045,224,1095,211,1096,217,1046,229,935,255"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="1340,433,1508,473"/>
<area shape="poly" title=" " alt="" coords="1521,431,1614,412,1615,417,1522,436"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="1093,469,1195,494"/>
<area shape="poly" title=" " alt="" coords="1209,472,1339,459,1340,464,1210,478"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="2124,309,2295,349"/>
<area shape="poly" title=" " alt="" coords="2308,327,2450,327,2450,332,2308,332"/>
<area shape="poly" title=" " alt="" coords="2025,316,2124,322,2123,327,2024,321"/>
<area shape="rect" href="classripple_1_1STObject.html" title=" " alt="" coords="1623,245,1748,270"/>
<area shape="poly" title=" " alt="" coords="1756,271,1874,298,1873,303,1754,276"/>
<area shape="rect" href="classripple_1_1STBase.html" title="A type which can be exported to a well known binary format." alt="" coords="820,137,935,162"/>
<area shape="poly" title=" " alt="" coords="948,138,1058,128,1198,124,1275,126,1354,132,1433,143,1509,160,1556,177,1601,199,1668,242,1665,247,1598,204,1554,182,1507,165,1432,149,1354,138,1275,132,1198,129,1058,133,949,143"/>
<area shape="poly" title=" " alt="" coords="949,160,1079,186,1078,191,948,166"/>
<area shape="rect" href="classripple_1_1SField.html" title="Identifies fields." alt="" coords="479,330,586,355"/>
<area shape="poly" title=" " alt="" coords="561,320,663,249,729,209,799,172,831,160,833,165,801,177,732,213,666,254,564,324"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="801,301,953,355"/>
<area shape="poly" title=" " alt="" coords="584,323,644,311,725,307,801,313,801,319,725,313,644,316,586,329"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="801,385,953,439"/>
<area shape="poly" title=" " alt="" coords="600,353,801,394,800,399,599,359"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="216,411,303,437"/>
<area shape="poly" title=" " alt="" coords="315,405,488,353,490,358,317,410"/>
<area shape="poly" title=" " alt="" coords="317,425,519,432,647,432,776,425,801,423,801,428,776,431,647,437,519,437,316,430"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="5,404,144,444"/>
<area shape="poly" title=" " alt="" coords="158,421,216,421,216,427,158,427"/>
<area shape="rect" href="classJson_1_1StaticString.html" title="Lightweight wrapper to tag static string." alt="" coords="193,330,325,355"/>
<area shape="poly" title=" " alt="" coords="339,340,479,340,479,345,339,345"/>
<area shape="poly" title=" " alt="" coords="787,334,586,343,586,338,787,329"/>
<area shape="poly" title=" " alt="" coords="788,425,716,425,679,421,643,413,615,402,588,387,547,358,550,353,591,383,617,397,645,408,680,416,717,420,788,420"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1343,239,1505,279"/>
<area shape="poly" title=" " alt="" coords="1519,256,1622,255,1622,260,1519,261"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1353,175,1495,215"/>
<area shape="poly" title=" " alt="" coords="1510,212,1632,242,1631,247,1508,218"/>
<area shape="poly" title=" " alt="" coords="1232,197,1352,194,1353,199,1232,202"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/aligned_storage.html" title=" " alt="" coords="800,187,955,227"/>
<area shape="poly" title=" " alt="" coords="969,204,1045,203,1069,202,1069,207,1045,208,969,209"/>
<area shape="rect" href="classripple_1_1SOTemplate.html" title="Defines the fields and their attributes within a STObject." alt="" coords="1351,303,1497,329"/>
<area shape="poly" title=" " alt="" coords="1494,298,1627,267,1629,273,1495,303"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1073,404,1215,444"/>
<area shape="poly" title=" " alt="" coords="1228,425,1272,421,1315,408,1345,391,1372,369,1411,327,1415,331,1376,373,1348,395,1317,413,1273,426,1229,431"/>
<area shape="rect" href="classripple_1_1SOElement.html" title="An element in a SOTemplate." alt="" coords="808,487,947,513"/>
<area shape="poly" title=" " alt="" coords="935,481,1072,441,1074,447,937,486"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/functional/reference_wrapper.html" title=" " alt="" coords="445,504,620,544"/>
<area shape="poly" title=" " alt="" coords="634,514,807,502,808,507,634,520"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1075,294,1213,319"/>
<area shape="poly" title=" " alt="" coords="1227,307,1351,311,1351,316,1227,312"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1604,295,1767,335"/>
<area shape="poly" title=" " alt="" coords="1781,311,1849,311,1849,316,1781,317"/>
</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:a270b078cbf4551c2ec499c7d8d8a9ac3" id="r_a270b078cbf4551c2ec499c7d8d8a9ac3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#a270b078cbf4551c2ec499c7d8d8a9ac3">BookTip</a> (<a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &amp;view, <a class="el" href="classripple_1_1Book.html">Book</a> const &amp;book)</td></tr>
<tr class="memdesc:a270b078cbf4551c2ec499c7d8d8a9ac3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the iterator. <br /></td></tr>
<tr class="separator:a270b078cbf4551c2ec499c7d8d8a9ac3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cff2eb0d57d7fd848ef50ff1a5b70fb" id="r_a5cff2eb0d57d7fd848ef50ff1a5b70fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#a5cff2eb0d57d7fd848ef50ff1a5b70fb">dir</a> () const noexcept</td></tr>
<tr class="separator:a5cff2eb0d57d7fd848ef50ff1a5b70fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4efde5ca26fe39512ed73ae9c8023c0" id="r_ae4efde5ca26fe39512ed73ae9c8023c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#ae4efde5ca26fe39512ed73ae9c8023c0">index</a> () const noexcept</td></tr>
<tr class="separator:ae4efde5ca26fe39512ed73ae9c8023c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2497a327f1ff60a6c9cb43f1f55afa4" id="r_aa2497a327f1ff60a6c9cb43f1f55afa4"><td class="memItemLeft" align="right" valign="top">Quality const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#aa2497a327f1ff60a6c9cb43f1f55afa4">quality</a> () const noexcept</td></tr>
<tr class="separator:aa2497a327f1ff60a6c9cb43f1f55afa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac47f5b9987edcf08e254acc89b119bd4" id="r_ac47f5b9987edcf08e254acc89b119bd4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1STLedgerEntry.html#ad360ad8483226127ef6b132ac93c1598">SLE::pointer</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#ac47f5b9987edcf08e254acc89b119bd4">entry</a> () const noexcept</td></tr>
<tr class="separator:ac47f5b9987edcf08e254acc89b119bd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a397775ff95cf391a6cdc71bf0bfd1082" id="r_a397775ff95cf391a6cdc71bf0bfd1082"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#a397775ff95cf391a6cdc71bf0bfd1082">step</a> (<a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j)</td></tr>
<tr class="memdesc:a397775ff95cf391a6cdc71bf0bfd1082"><td class="mdescLeft">&#160;</td><td class="mdescRight">Erases the current offer and advance to the next offer. <br /></td></tr>
<tr class="separator:a397775ff95cf391a6cdc71bf0bfd1082"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a16a19065aeac8e13a44e9487f4a82661" id="r_a16a19065aeac8e13a44e9487f4a82661"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#a16a19065aeac8e13a44e9487f4a82661">view_</a></td></tr>
<tr class="separator:a16a19065aeac8e13a44e9487f4a82661"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac15cdda52ef8015f6721a2bfcb937484" id="r_ac15cdda52ef8015f6721a2bfcb937484"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#ac15cdda52ef8015f6721a2bfcb937484">m_valid</a></td></tr>
<tr class="separator:ac15cdda52ef8015f6721a2bfcb937484"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a001120a15b8578a1bd23866c2b95aa7d" id="r_a001120a15b8578a1bd23866c2b95aa7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#a001120a15b8578a1bd23866c2b95aa7d">m_book</a></td></tr>
<tr class="separator:a001120a15b8578a1bd23866c2b95aa7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5173c64dad3fc11b19fd7ea5df3e1aec" id="r_a5173c64dad3fc11b19fd7ea5df3e1aec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#a5173c64dad3fc11b19fd7ea5df3e1aec">m_end</a></td></tr>
<tr class="separator:a5173c64dad3fc11b19fd7ea5df3e1aec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa677f2196ee5ab024554f9c7523df7d6" id="r_aa677f2196ee5ab024554f9c7523df7d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#aa677f2196ee5ab024554f9c7523df7d6">m_dir</a></td></tr>
<tr class="separator:aa677f2196ee5ab024554f9c7523df7d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35db02c211264c557b3d58d4d7996c6b" id="r_a35db02c211264c557b3d58d4d7996c6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#a35db02c211264c557b3d58d4d7996c6b">m_index</a></td></tr>
<tr class="separator:a35db02c211264c557b3d58d4d7996c6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7233be38f20d487d5196282a092c3321" id="r_a7233be38f20d487d5196282a092c3321"><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="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#a7233be38f20d487d5196282a092c3321">m_entry</a></td></tr>
<tr class="separator:a7233be38f20d487d5196282a092c3321"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9260904a5d30263326ee1dff39ece201" id="r_a9260904a5d30263326ee1dff39ece201"><td class="memItemLeft" align="right" valign="top">Quality&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookTip.html#a9260904a5d30263326ee1dff39ece201">m_quality</a></td></tr>
<tr class="separator:a9260904a5d30263326ee1dff39ece201"><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>Iterates and consumes raw offers in an order book. </p>
<p>Offers are presented from highest quality to lowest quality. This will return all offers present including missing, invalid, unfunded, etc. </p>
<p class="definition">Definition at line <a class="el" href="BookTip_8h_source.html#l00016">16</a> of file <a class="el" href="BookTip_8h_source.html">BookTip.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a270b078cbf4551c2ec499c7d8d8a9ac3" name="a270b078cbf4551c2ec499c7d8d8a9ac3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a270b078cbf4551c2ec499c7d8d8a9ac3">&#9670;&#160;</a></span>BookTip()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::BookTip::BookTip </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &amp;&#160;</td>
<td class="paramname"><em>view</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1Book.html">Book</a> const &amp;&#160;</td>
<td class="paramname"><em>book</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create the iterator. </p>
<p class="definition">Definition at line <a class="el" href="BookTip_8cpp_source.html#l00005">5</a> of file <a class="el" href="BookTip_8cpp_source.html">BookTip.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5cff2eb0d57d7fd848ef50ff1a5b70fb" name="a5cff2eb0d57d7fd848ef50ff1a5b70fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cff2eb0d57d7fd848ef50ff1a5b70fb">&#9670;&#160;</a></span>dir()</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#a356c68147333a9a48a344718038576d9">uint256</a> const &amp; ripple::BookTip::dir </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BookTip_8h_source.html#l00033">33</a> of file <a class="el" href="BookTip_8h_source.html">BookTip.h</a>.</p>
</div>
</div>
<a id="ae4efde5ca26fe39512ed73ae9c8023c0" name="ae4efde5ca26fe39512ed73ae9c8023c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4efde5ca26fe39512ed73ae9c8023c0">&#9670;&#160;</a></span>index()</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#a356c68147333a9a48a344718038576d9">uint256</a> const &amp; ripple::BookTip::index </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BookTip_8h_source.html#l00039">39</a> of file <a class="el" href="BookTip_8h_source.html">BookTip.h</a>.</p>
</div>
</div>
<a id="aa2497a327f1ff60a6c9cb43f1f55afa4" name="aa2497a327f1ff60a6c9cb43f1f55afa4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2497a327f1ff60a6c9cb43f1f55afa4">&#9670;&#160;</a></span>quality()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Quality const &amp; ripple::BookTip::quality </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BookTip_8h_source.html#l00045">45</a> of file <a class="el" href="BookTip_8h_source.html">BookTip.h</a>.</p>
</div>
</div>
<a id="ac47f5b9987edcf08e254acc89b119bd4" name="ac47f5b9987edcf08e254acc89b119bd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac47f5b9987edcf08e254acc89b119bd4">&#9670;&#160;</a></span>entry()</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_1STLedgerEntry.html#ad360ad8483226127ef6b132ac93c1598">SLE::pointer</a> const &amp; ripple::BookTip::entry </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BookTip_8h_source.html#l00051">51</a> of file <a class="el" href="BookTip_8h_source.html">BookTip.h</a>.</p>
</div>
</div>
<a id="a397775ff95cf391a6cdc71bf0bfd1082" name="a397775ff95cf391a6cdc71bf0bfd1082"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a397775ff95cf391a6cdc71bf0bfd1082">&#9670;&#160;</a></span>step()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::BookTip::step </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td>
<td class="paramname"><em>j</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Erases the current offer and advance to the next offer. </p>
<p>Complexity: Constant </p><dl class="section return"><dt>Returns</dt><dd><code>true</code> if there is a next offer </dd></dl>
<p class="definition">Definition at line <a class="el" href="BookTip_8cpp_source.html#l00014">14</a> of file <a class="el" href="BookTip_8cpp_source.html">BookTip.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a16a19065aeac8e13a44e9487f4a82661" name="a16a19065aeac8e13a44e9487f4a82661"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16a19065aeac8e13a44e9487f4a82661">&#9670;&#160;</a></span>view_</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_1ApplyView.html">ApplyView</a>&amp; ripple::BookTip::view_</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="BookTip_8h_source.html#l00019">19</a> of file <a class="el" href="BookTip_8h_source.html">BookTip.h</a>.</p>
</div>
</div>
<a id="ac15cdda52ef8015f6721a2bfcb937484" name="ac15cdda52ef8015f6721a2bfcb937484"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac15cdda52ef8015f6721a2bfcb937484">&#9670;&#160;</a></span>m_valid</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::BookTip::m_valid</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="BookTip_8h_source.html#l00020">20</a> of file <a class="el" href="BookTip_8h_source.html">BookTip.h</a>.</p>
</div>
</div>
<a id="a001120a15b8578a1bd23866c2b95aa7d" name="a001120a15b8578a1bd23866c2b95aa7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a001120a15b8578a1bd23866c2b95aa7d">&#9670;&#160;</a></span>m_book</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#a356c68147333a9a48a344718038576d9">uint256</a> ripple::BookTip::m_book</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="BookTip_8h_source.html#l00021">21</a> of file <a class="el" href="BookTip_8h_source.html">BookTip.h</a>.</p>
</div>
</div>
<a id="a5173c64dad3fc11b19fd7ea5df3e1aec" name="a5173c64dad3fc11b19fd7ea5df3e1aec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5173c64dad3fc11b19fd7ea5df3e1aec">&#9670;&#160;</a></span>m_end</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#a356c68147333a9a48a344718038576d9">uint256</a> ripple::BookTip::m_end</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="BookTip_8h_source.html#l00022">22</a> of file <a class="el" href="BookTip_8h_source.html">BookTip.h</a>.</p>
</div>
</div>
<a id="aa677f2196ee5ab024554f9c7523df7d6" name="aa677f2196ee5ab024554f9c7523df7d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa677f2196ee5ab024554f9c7523df7d6">&#9670;&#160;</a></span>m_dir</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#a356c68147333a9a48a344718038576d9">uint256</a> ripple::BookTip::m_dir</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="BookTip_8h_source.html#l00023">23</a> of file <a class="el" href="BookTip_8h_source.html">BookTip.h</a>.</p>
</div>
</div>
<a id="a35db02c211264c557b3d58d4d7996c6b" name="a35db02c211264c557b3d58d4d7996c6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35db02c211264c557b3d58d4d7996c6b">&#9670;&#160;</a></span>m_index</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#a356c68147333a9a48a344718038576d9">uint256</a> ripple::BookTip::m_index</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="BookTip_8h_source.html#l00024">24</a> of file <a class="el" href="BookTip_8h_source.html">BookTip.h</a>.</p>
</div>
</div>
<a id="a7233be38f20d487d5196282a092c3321" name="a7233be38f20d487d5196282a092c3321"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7233be38f20d487d5196282a092c3321">&#9670;&#160;</a></span>m_entry</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a>&gt; ripple::BookTip::m_entry</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="BookTip_8h_source.html#l00025">25</a> of file <a class="el" href="BookTip_8h_source.html">BookTip.h</a>.</p>
</div>
</div>
<a id="a9260904a5d30263326ee1dff39ece201" name="a9260904a5d30263326ee1dff39ece201"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9260904a5d30263326ee1dff39ece201">&#9670;&#160;</a></span>m_quality</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Quality ripple::BookTip::m_quality</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="BookTip_8h_source.html#l00026">26</a> of file <a class="el" href="BookTip_8h_source.html">BookTip.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